@aws-sdk/client-customer-profiles 3.939.0 → 3.942.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 +120 -0
- package/dist-cjs/index.js +1058 -84
- package/dist-es/CustomerProfiles.js +30 -0
- package/dist-es/commands/CreateRecommenderCommand.js +16 -0
- package/dist-es/commands/DeleteDomainObjectTypeCommand.js +16 -0
- package/dist-es/commands/DeleteRecommenderCommand.js +16 -0
- package/dist-es/commands/GetDomainObjectTypeCommand.js +16 -0
- package/dist-es/commands/GetObjectTypeAttributeStatisticsCommand.js +16 -0
- package/dist-es/commands/GetProfileRecommendationsCommand.js +16 -0
- package/dist-es/commands/GetRecommenderCommand.js +16 -0
- package/dist-es/commands/ListDomainObjectTypesCommand.js +16 -0
- package/dist-es/commands/ListObjectTypeAttributeValuesCommand.js +16 -0
- package/dist-es/commands/ListRecommenderRecipesCommand.js +16 -0
- package/dist-es/commands/ListRecommendersCommand.js +16 -0
- package/dist-es/commands/PutDomainObjectTypeCommand.js +16 -0
- package/dist-es/commands/StartRecommenderCommand.js +16 -0
- package/dist-es/commands/StopRecommenderCommand.js +16 -0
- package/dist-es/commands/UpdateRecommenderCommand.js +16 -0
- package/dist-es/commands/index.js +15 -0
- package/dist-es/models/enums.js +41 -0
- package/dist-es/models/models_1.js +1 -0
- package/dist-es/pagination/ListDomainObjectTypesPaginator.js +4 -0
- package/dist-es/pagination/ListRecommenderRecipesPaginator.js +4 -0
- package/dist-es/pagination/ListRecommendersPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +792 -84
- package/dist-types/CustomerProfiles.d.ts +106 -0
- package/dist-types/CustomerProfilesClient.d.ts +17 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +10 -0
- package/dist-types/commands/CreateRecommenderCommand.d.ts +109 -0
- package/dist-types/commands/CreateSegmentDefinitionCommand.d.ts +1 -0
- package/dist-types/commands/CreateSegmentEstimateCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDomainObjectTypeCommand.d.ts +88 -0
- package/dist-types/commands/DeleteRecommenderCommand.d.ts +88 -0
- package/dist-types/commands/GetDomainCommand.d.ts +7 -0
- package/dist-types/commands/GetDomainObjectTypeCommand.d.ts +105 -0
- package/dist-types/commands/GetIntegrationCommand.d.ts +1 -0
- package/dist-types/commands/GetObjectTypeAttributeStatisticsCommand.d.ts +110 -0
- package/dist-types/commands/GetProfileRecommendationsCommand.d.ts +116 -0
- package/dist-types/commands/GetRecommenderCommand.d.ts +136 -0
- package/dist-types/commands/GetSegmentDefinitionCommand.d.ts +2 -0
- package/dist-types/commands/GetSegmentMembershipCommand.d.ts +1 -0
- package/dist-types/commands/ListAccountIntegrationsCommand.d.ts +1 -0
- package/dist-types/commands/ListDomainObjectTypesCommand.d.ts +102 -0
- package/dist-types/commands/ListIntegrationsCommand.d.ts +1 -0
- package/dist-types/commands/ListObjectTypeAttributeValuesCommand.d.ts +99 -0
- package/dist-types/commands/ListRecommenderRecipesCommand.d.ts +93 -0
- package/dist-types/commands/ListRecommendersCommand.d.ts +133 -0
- package/dist-types/commands/ListSegmentDefinitionsCommand.d.ts +1 -0
- package/dist-types/commands/PutDomainObjectTypeCommand.d.ts +118 -0
- package/dist-types/commands/PutIntegrationCommand.d.ts +5 -3
- package/dist-types/commands/StartRecommenderCommand.d.ts +88 -0
- package/dist-types/commands/StopRecommenderCommand.d.ts +89 -0
- package/dist-types/commands/StopUploadJobCommand.d.ts +1 -1
- 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 +11 -1
- package/dist-types/commands/UpdateDomainLayoutCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEventTriggerCommand.d.ts +1 -1
- package/dist-types/commands/UpdateProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRecommenderCommand.d.ts +102 -0
- package/dist-types/commands/index.d.ts +15 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +97 -0
- package/dist-types/models/models_0.d.ts +1084 -738
- package/dist-types/models/models_1.d.ts +744 -0
- package/dist-types/pagination/ListDomainObjectTypesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRecommenderRecipesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRecommendersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/schemas/schemas_0.d.ts +74 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +256 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +92 -2
- package/dist-types/ts3.4/commands/CreateRecommenderCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteDomainObjectTypeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRecommenderCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetDomainObjectTypeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetObjectTypeAttributeStatisticsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetProfileRecommendationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRecommenderCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListDomainObjectTypesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListObjectTypeAttributeValuesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommenderRecipesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommendersCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PutDomainObjectTypeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartRecommenderCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StopRecommenderCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/StopUploadJobCommand.d.ts +1 -1
- 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/UpdateProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRecommenderCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +15 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +51 -0
- package/dist-types/ts3.4/models/models_0.d.ts +251 -142
- package/dist-types/ts3.4/models/models_1.d.ts +176 -0
- package/dist-types/ts3.4/pagination/ListDomainObjectTypesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRecommenderRecipesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRecommendersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +74 -0
- package/package.json +5 -5
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ActionType, AttributeDimensionType, AttributeMatchingModel, ComparisonOperator, ConflictResolvingModel, ContactType, DataFormat, DataPullMode, DateDimensionType, EstimateStatus, EventStreamDestinationStatus, EventStreamState, EventTriggerLogicalOperator, FieldContentType, FilterDimensionType, Gender, IdentityResolutionJobStatus, Include, IncludeOptions, JobScheduleDayOfTheWeek, LayoutType, LogicalOperator, MarketoConnectorOperator, MatchType, Operator, OperatorPropertiesKeys, PartyType, PeriodUnit, ProfileType, ProfileTypeDimensionType, QueryResult, RangeUnit, ReadinessStatus, RuleBasedMatchingStatus, S3ConnectorOperator, SalesforceConnectorOperator, SegmentSnapshotStatus, ServiceNowConnectorOperator, SourceConnectorType, StandardIdentifier, Statistic, Status, StatusReason, StringDimensionType, TaskType, TriggerType, Type, Unit, UploadJobStatus, WorkflowType, ZendeskConnectorOperator } from "./enums";
|
|
1
|
+
import { ActionType, AttributeDimensionType, AttributeMatchingModel, ComparisonOperator, ConflictResolvingModel, ContactType, ContentType, DataFormat, DataPullMode, DateDimensionType, EstimateStatus, EventStreamDestinationStatus, EventStreamState, EventTriggerLogicalOperator, FeatureType, FieldContentType, FilterDimensionType, Gender, IdentityResolutionJobStatus, Include, IncludeOptions, JobScheduleDayOfTheWeek, LayoutType, LogicalOperator, MarketoConnectorOperator, MatchType, Operator, OperatorPropertiesKeys, PartyType, PeriodUnit, ProfileType, ProfileTypeDimensionType, QueryResult, RangeUnit, ReadinessStatus, 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";
|
|
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>
|
|
@@ -1398,6 +1398,77 @@ export interface ListCalculatedAttributeForProfileItem {
|
|
|
1398
1398
|
*/
|
|
1399
1399
|
LastObjectTimestamp?: Date | undefined;
|
|
1400
1400
|
}
|
|
1401
|
+
/**
|
|
1402
|
+
* <p>Represents an item in the catalog with its complete set of attributes and metadata.</p>
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1405
|
+
export interface CatalogItem {
|
|
1406
|
+
/**
|
|
1407
|
+
* <p>The unique identifier for the catalog item.</p>
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1410
|
+
Id?: string | undefined;
|
|
1411
|
+
/**
|
|
1412
|
+
* <p>The display name of the catalog item.</p>
|
|
1413
|
+
* @public
|
|
1414
|
+
*/
|
|
1415
|
+
Name?: string | undefined;
|
|
1416
|
+
/**
|
|
1417
|
+
* <p>The product code or SKU of the catalog item.</p>
|
|
1418
|
+
* @public
|
|
1419
|
+
*/
|
|
1420
|
+
Code?: string | undefined;
|
|
1421
|
+
/**
|
|
1422
|
+
* <p>The type classification of the catalog item.</p>
|
|
1423
|
+
* @public
|
|
1424
|
+
*/
|
|
1425
|
+
Type?: string | undefined;
|
|
1426
|
+
/**
|
|
1427
|
+
* <p>The category to which the catalog item belongs.</p>
|
|
1428
|
+
* @public
|
|
1429
|
+
*/
|
|
1430
|
+
Category?: string | undefined;
|
|
1431
|
+
/**
|
|
1432
|
+
* <p>A detailed description of the catalog item.</p>
|
|
1433
|
+
* @public
|
|
1434
|
+
*/
|
|
1435
|
+
Description?: string | undefined;
|
|
1436
|
+
/**
|
|
1437
|
+
* <p>Supplementary information about the catalog item beyond the basic description.</p>
|
|
1438
|
+
* @public
|
|
1439
|
+
*/
|
|
1440
|
+
AdditionalInformation?: string | undefined;
|
|
1441
|
+
/**
|
|
1442
|
+
* <p>The URL link to the item's image.</p>
|
|
1443
|
+
* @public
|
|
1444
|
+
*/
|
|
1445
|
+
ImageLink?: string | undefined;
|
|
1446
|
+
/**
|
|
1447
|
+
* <p>The URL link to the item's detailed page or external resource.</p>
|
|
1448
|
+
* @public
|
|
1449
|
+
*/
|
|
1450
|
+
Link?: string | undefined;
|
|
1451
|
+
/**
|
|
1452
|
+
* <p>The timestamp when the catalog item was created.</p>
|
|
1453
|
+
* @public
|
|
1454
|
+
*/
|
|
1455
|
+
CreatedAt?: Date | undefined;
|
|
1456
|
+
/**
|
|
1457
|
+
* <p>The timestamp when the catalog item was last updated.</p>
|
|
1458
|
+
* @public
|
|
1459
|
+
*/
|
|
1460
|
+
UpdatedAt?: Date | undefined;
|
|
1461
|
+
/**
|
|
1462
|
+
* <p>The price of the catalog item.</p>
|
|
1463
|
+
* @public
|
|
1464
|
+
*/
|
|
1465
|
+
Price?: string | undefined;
|
|
1466
|
+
/**
|
|
1467
|
+
* <p>Additional attributes or properties associated with the catalog item stored as key-value pairs.</p>
|
|
1468
|
+
* @public
|
|
1469
|
+
*/
|
|
1470
|
+
Attributes?: Record<string, string> | undefined;
|
|
1471
|
+
}
|
|
1401
1472
|
/**
|
|
1402
1473
|
* <p>A structure letting customers specify a relative time window over which over which data
|
|
1403
1474
|
* is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint
|
|
@@ -1696,6 +1767,17 @@ export interface CreateCalculatedAttributeDefinitionResponse {
|
|
|
1696
1767
|
*/
|
|
1697
1768
|
Tags?: Record<string, string> | undefined;
|
|
1698
1769
|
}
|
|
1770
|
+
/**
|
|
1771
|
+
* <p>The data store request.</p>
|
|
1772
|
+
* @public
|
|
1773
|
+
*/
|
|
1774
|
+
export interface DataStoreRequest {
|
|
1775
|
+
/**
|
|
1776
|
+
* <p>Enabled: Set to true to enabled data store for this domain.</p>
|
|
1777
|
+
* @public
|
|
1778
|
+
*/
|
|
1779
|
+
Enabled?: boolean | undefined;
|
|
1780
|
+
}
|
|
1699
1781
|
/**
|
|
1700
1782
|
* <p>Configuration information about the S3 bucket where Identity Resolution Jobs write result files.</p>
|
|
1701
1783
|
* @public
|
|
@@ -1940,12 +2022,34 @@ export interface CreateDomainRequest {
|
|
|
1940
2022
|
* @public
|
|
1941
2023
|
*/
|
|
1942
2024
|
RuleBasedMatching?: RuleBasedMatchingRequest | undefined;
|
|
2025
|
+
/**
|
|
2026
|
+
* <p>Set to true to enabled data store for this domain.</p>
|
|
2027
|
+
* @public
|
|
2028
|
+
*/
|
|
2029
|
+
DataStore?: DataStoreRequest | undefined;
|
|
1943
2030
|
/**
|
|
1944
2031
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1945
2032
|
* @public
|
|
1946
2033
|
*/
|
|
1947
2034
|
Tags?: Record<string, string> | undefined;
|
|
1948
2035
|
}
|
|
2036
|
+
/**
|
|
2037
|
+
* <p>The data store response.</p>
|
|
2038
|
+
* @public
|
|
2039
|
+
*/
|
|
2040
|
+
export interface DataStoreResponse {
|
|
2041
|
+
/**
|
|
2042
|
+
* <p>True if data store is enabled for this domain</p>
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
Enabled?: boolean | undefined;
|
|
2046
|
+
/**
|
|
2047
|
+
* <p>Information indicating if the Calculated Attribute is ready for use by confirming all
|
|
2048
|
+
* historical data has been processed and reflected.</p>
|
|
2049
|
+
* @public
|
|
2050
|
+
*/
|
|
2051
|
+
Readiness?: Readiness | undefined;
|
|
2052
|
+
}
|
|
1949
2053
|
/**
|
|
1950
2054
|
* <p>The flag that enables the matching process of duplicate profiles.</p>
|
|
1951
2055
|
* @public
|
|
@@ -2100,6 +2204,11 @@ export interface CreateDomainResponse {
|
|
|
2100
2204
|
* @public
|
|
2101
2205
|
*/
|
|
2102
2206
|
RuleBasedMatching?: RuleBasedMatchingResponse | undefined;
|
|
2207
|
+
/**
|
|
2208
|
+
* <p>The data store.</p>
|
|
2209
|
+
* @public
|
|
2210
|
+
*/
|
|
2211
|
+
DataStore?: DataStoreResponse | undefined;
|
|
2103
2212
|
/**
|
|
2104
2213
|
* <p>The timestamp of when the domain was created.</p>
|
|
2105
2214
|
* @public
|
|
@@ -2673,6 +2782,99 @@ export interface CreateProfileResponse {
|
|
|
2673
2782
|
*/
|
|
2674
2783
|
ProfileId: string | undefined;
|
|
2675
2784
|
}
|
|
2785
|
+
/**
|
|
2786
|
+
* <p>Configuration parameters for events in the personalization system.</p>
|
|
2787
|
+
* @public
|
|
2788
|
+
*/
|
|
2789
|
+
export interface EventParameters {
|
|
2790
|
+
/**
|
|
2791
|
+
* <p>The type of event being tracked (e.g., 'click', 'purchase', 'view').</p>
|
|
2792
|
+
* @public
|
|
2793
|
+
*/
|
|
2794
|
+
EventType: string | undefined;
|
|
2795
|
+
/**
|
|
2796
|
+
* <p>The minimum value threshold that an event must meet to be considered valid.</p>
|
|
2797
|
+
* @public
|
|
2798
|
+
*/
|
|
2799
|
+
EventValueThreshold?: number | undefined;
|
|
2800
|
+
}
|
|
2801
|
+
/**
|
|
2802
|
+
* <p>Configuration settings that define how events are processed and tracked.</p>
|
|
2803
|
+
* @public
|
|
2804
|
+
*/
|
|
2805
|
+
export interface EventsConfig {
|
|
2806
|
+
/**
|
|
2807
|
+
* <p>A list of event parameters configurations that specify how different event types should be handled.</p>
|
|
2808
|
+
* @public
|
|
2809
|
+
*/
|
|
2810
|
+
EventParametersList: EventParameters[] | undefined;
|
|
2811
|
+
}
|
|
2812
|
+
/**
|
|
2813
|
+
* <p>Configuration settings that define the behavior and parameters of a recommender.</p>
|
|
2814
|
+
* @public
|
|
2815
|
+
*/
|
|
2816
|
+
export interface RecommenderConfig {
|
|
2817
|
+
/**
|
|
2818
|
+
* <p>Configuration settings for how the recommender processes and uses events.</p>
|
|
2819
|
+
* @public
|
|
2820
|
+
*/
|
|
2821
|
+
EventsConfig: EventsConfig | undefined;
|
|
2822
|
+
/**
|
|
2823
|
+
* <p>How often the recommender should retrain its model with new data.</p>
|
|
2824
|
+
* @public
|
|
2825
|
+
*/
|
|
2826
|
+
TrainingFrequency?: number | undefined;
|
|
2827
|
+
}
|
|
2828
|
+
/**
|
|
2829
|
+
* @public
|
|
2830
|
+
*/
|
|
2831
|
+
export interface CreateRecommenderRequest {
|
|
2832
|
+
/**
|
|
2833
|
+
* <p>The unique name of the domain.</p>
|
|
2834
|
+
* @public
|
|
2835
|
+
*/
|
|
2836
|
+
DomainName: string | undefined;
|
|
2837
|
+
/**
|
|
2838
|
+
* <p>The name of the recommender.</p>
|
|
2839
|
+
* @public
|
|
2840
|
+
*/
|
|
2841
|
+
RecommenderName: string | undefined;
|
|
2842
|
+
/**
|
|
2843
|
+
* <p>The name of the recommeder recipe.</p>
|
|
2844
|
+
* @public
|
|
2845
|
+
*/
|
|
2846
|
+
RecommenderRecipeName: RecommenderRecipeName | undefined;
|
|
2847
|
+
/**
|
|
2848
|
+
* <p>The recommender configuration.</p>
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2851
|
+
RecommenderConfig?: RecommenderConfig | undefined;
|
|
2852
|
+
/**
|
|
2853
|
+
* <p>The description of the domain object type.</p>
|
|
2854
|
+
* @public
|
|
2855
|
+
*/
|
|
2856
|
+
Description?: string | undefined;
|
|
2857
|
+
/**
|
|
2858
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2859
|
+
* @public
|
|
2860
|
+
*/
|
|
2861
|
+
Tags?: Record<string, string> | undefined;
|
|
2862
|
+
}
|
|
2863
|
+
/**
|
|
2864
|
+
* @public
|
|
2865
|
+
*/
|
|
2866
|
+
export interface CreateRecommenderResponse {
|
|
2867
|
+
/**
|
|
2868
|
+
* <p>The ARN of the recommender</p>
|
|
2869
|
+
* @public
|
|
2870
|
+
*/
|
|
2871
|
+
RecommenderArn: string | undefined;
|
|
2872
|
+
/**
|
|
2873
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2874
|
+
* @public
|
|
2875
|
+
*/
|
|
2876
|
+
Tags?: Record<string, string> | undefined;
|
|
2877
|
+
}
|
|
2676
2878
|
/**
|
|
2677
2879
|
* <p>Object that segments on various Customer profile's fields that are larger than
|
|
2678
2880
|
* normal.</p>
|
|
@@ -2965,7 +3167,12 @@ export interface CreateSegmentDefinitionRequest {
|
|
|
2965
3167
|
* respective relationship.</p>
|
|
2966
3168
|
* @public
|
|
2967
3169
|
*/
|
|
2968
|
-
SegmentGroups
|
|
3170
|
+
SegmentGroups?: SegmentGroup | undefined;
|
|
3171
|
+
/**
|
|
3172
|
+
* <p>The segment SQL query.</p>
|
|
3173
|
+
* @public
|
|
3174
|
+
*/
|
|
3175
|
+
SegmentSqlQuery?: string | undefined;
|
|
2969
3176
|
/**
|
|
2970
3177
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2971
3178
|
* @public
|
|
@@ -3036,7 +3243,12 @@ export interface CreateSegmentEstimateRequest {
|
|
|
3036
3243
|
* <p>The segment query for calculating a segment estimate.</p>
|
|
3037
3244
|
* @public
|
|
3038
3245
|
*/
|
|
3039
|
-
SegmentQuery
|
|
3246
|
+
SegmentQuery?: SegmentGroupStructure | undefined;
|
|
3247
|
+
/**
|
|
3248
|
+
* <p>The segment SQL query.</p>
|
|
3249
|
+
* @public
|
|
3250
|
+
*/
|
|
3251
|
+
SegmentSqlQuery?: string | undefined;
|
|
3040
3252
|
}
|
|
3041
3253
|
/**
|
|
3042
3254
|
* @public
|
|
@@ -3241,6 +3453,26 @@ export interface DeleteDomainLayoutResponse {
|
|
|
3241
3453
|
*/
|
|
3242
3454
|
Message: string | undefined;
|
|
3243
3455
|
}
|
|
3456
|
+
/**
|
|
3457
|
+
* @public
|
|
3458
|
+
*/
|
|
3459
|
+
export interface DeleteDomainObjectTypeRequest {
|
|
3460
|
+
/**
|
|
3461
|
+
* <p>The unique name of the domain.</p>
|
|
3462
|
+
* @public
|
|
3463
|
+
*/
|
|
3464
|
+
DomainName: string | undefined;
|
|
3465
|
+
/**
|
|
3466
|
+
* <p>The unique name of the domain object type.</p>
|
|
3467
|
+
* @public
|
|
3468
|
+
*/
|
|
3469
|
+
ObjectTypeName: string | undefined;
|
|
3470
|
+
}
|
|
3471
|
+
/**
|
|
3472
|
+
* @public
|
|
3473
|
+
*/
|
|
3474
|
+
export interface DeleteDomainObjectTypeResponse {
|
|
3475
|
+
}
|
|
3244
3476
|
/**
|
|
3245
3477
|
* @public
|
|
3246
3478
|
*/
|
|
@@ -3431,6 +3663,26 @@ export interface DeleteProfileObjectTypeResponse {
|
|
|
3431
3663
|
*/
|
|
3432
3664
|
Message: string | undefined;
|
|
3433
3665
|
}
|
|
3666
|
+
/**
|
|
3667
|
+
* @public
|
|
3668
|
+
*/
|
|
3669
|
+
export interface DeleteRecommenderRequest {
|
|
3670
|
+
/**
|
|
3671
|
+
* <p>The unique name of the domain.</p>
|
|
3672
|
+
* @public
|
|
3673
|
+
*/
|
|
3674
|
+
DomainName: string | undefined;
|
|
3675
|
+
/**
|
|
3676
|
+
* <p>The recommender name.</p>
|
|
3677
|
+
* @public
|
|
3678
|
+
*/
|
|
3679
|
+
RecommenderName: string | undefined;
|
|
3680
|
+
}
|
|
3681
|
+
/**
|
|
3682
|
+
* @public
|
|
3683
|
+
*/
|
|
3684
|
+
export interface DeleteRecommenderResponse {
|
|
3685
|
+
}
|
|
3434
3686
|
/**
|
|
3435
3687
|
* @public
|
|
3436
3688
|
*/
|
|
@@ -3836,6 +4088,11 @@ export interface GetDomainResponse {
|
|
|
3836
4088
|
* @public
|
|
3837
4089
|
*/
|
|
3838
4090
|
RuleBasedMatching?: RuleBasedMatchingResponse | undefined;
|
|
4091
|
+
/**
|
|
4092
|
+
* <p> True if data store is enabled for this domain.</p>
|
|
4093
|
+
* @public
|
|
4094
|
+
*/
|
|
4095
|
+
DataStore?: DataStoreResponse | undefined;
|
|
3839
4096
|
/**
|
|
3840
4097
|
* <p>The timestamp of when the domain was created.</p>
|
|
3841
4098
|
* @public
|
|
@@ -3924,6 +4181,87 @@ export interface GetDomainLayoutResponse {
|
|
|
3924
4181
|
*/
|
|
3925
4182
|
Tags?: Record<string, string> | undefined;
|
|
3926
4183
|
}
|
|
4184
|
+
/**
|
|
4185
|
+
* @public
|
|
4186
|
+
*/
|
|
4187
|
+
export interface GetDomainObjectTypeRequest {
|
|
4188
|
+
/**
|
|
4189
|
+
* <p>The unique name of the domain.</p>
|
|
4190
|
+
* @public
|
|
4191
|
+
*/
|
|
4192
|
+
DomainName: string | undefined;
|
|
4193
|
+
/**
|
|
4194
|
+
* <p>The unique name of the domain object type.</p>
|
|
4195
|
+
* @public
|
|
4196
|
+
*/
|
|
4197
|
+
ObjectTypeName: string | undefined;
|
|
4198
|
+
}
|
|
4199
|
+
/**
|
|
4200
|
+
* <p>The standard domain object type.</p>
|
|
4201
|
+
* @public
|
|
4202
|
+
*/
|
|
4203
|
+
export interface DomainObjectTypeField {
|
|
4204
|
+
/**
|
|
4205
|
+
* <p>The expression that defines how to extract the field value from the source object.></p>
|
|
4206
|
+
* @public
|
|
4207
|
+
*/
|
|
4208
|
+
Source: string | undefined;
|
|
4209
|
+
/**
|
|
4210
|
+
* <p>The expression that defines where the field value should be placed in the standard domain object.</p>
|
|
4211
|
+
* @public
|
|
4212
|
+
*/
|
|
4213
|
+
Target: string | undefined;
|
|
4214
|
+
/**
|
|
4215
|
+
* <p>The content type of the field.</p>
|
|
4216
|
+
* @public
|
|
4217
|
+
*/
|
|
4218
|
+
ContentType?: ContentType | undefined;
|
|
4219
|
+
/**
|
|
4220
|
+
* <p>The semantic meaning of the field.</p>
|
|
4221
|
+
* @public
|
|
4222
|
+
*/
|
|
4223
|
+
FeatureType?: FeatureType | undefined;
|
|
4224
|
+
}
|
|
4225
|
+
/**
|
|
4226
|
+
* @public
|
|
4227
|
+
*/
|
|
4228
|
+
export interface GetDomainObjectTypeResponse {
|
|
4229
|
+
/**
|
|
4230
|
+
* <p>The unique name of the domain object type.</p>
|
|
4231
|
+
* @public
|
|
4232
|
+
*/
|
|
4233
|
+
ObjectTypeName: string | undefined;
|
|
4234
|
+
/**
|
|
4235
|
+
* <p>The description of the domain object type.</p>
|
|
4236
|
+
* @public
|
|
4237
|
+
*/
|
|
4238
|
+
Description?: string | undefined;
|
|
4239
|
+
/**
|
|
4240
|
+
* <p>The customer provided KMS key used to encrypt this type of domain object.</p>
|
|
4241
|
+
* @public
|
|
4242
|
+
*/
|
|
4243
|
+
EncryptionKey?: string | undefined;
|
|
4244
|
+
/**
|
|
4245
|
+
* <p>A map of field names to their corresponding domain object type field definitions.</p>
|
|
4246
|
+
* @public
|
|
4247
|
+
*/
|
|
4248
|
+
Fields?: Record<string, DomainObjectTypeField> | undefined;
|
|
4249
|
+
/**
|
|
4250
|
+
* <p>The timestamp of when the domain object type was created.</p>
|
|
4251
|
+
* @public
|
|
4252
|
+
*/
|
|
4253
|
+
CreatedAt?: Date | undefined;
|
|
4254
|
+
/**
|
|
4255
|
+
* <p>The timestamp of when the domain object type was most recently edited.</p>
|
|
4256
|
+
* @public
|
|
4257
|
+
*/
|
|
4258
|
+
LastUpdatedAt?: Date | undefined;
|
|
4259
|
+
/**
|
|
4260
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4261
|
+
* @public
|
|
4262
|
+
*/
|
|
4263
|
+
Tags?: Record<string, string> | undefined;
|
|
4264
|
+
}
|
|
3927
4265
|
/**
|
|
3928
4266
|
* @public
|
|
3929
4267
|
*/
|
|
@@ -4312,6 +4650,11 @@ export interface GetIntegrationResponse {
|
|
|
4312
4650
|
* @public
|
|
4313
4651
|
*/
|
|
4314
4652
|
EventTriggerNames?: string[] | undefined;
|
|
4653
|
+
/**
|
|
4654
|
+
* <p>Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.</p>
|
|
4655
|
+
* @public
|
|
4656
|
+
*/
|
|
4657
|
+
Scope?: Scope | undefined;
|
|
4315
4658
|
}
|
|
4316
4659
|
/**
|
|
4317
4660
|
* @public
|
|
@@ -4389,19 +4732,116 @@ export interface GetMatchesResponse {
|
|
|
4389
4732
|
/**
|
|
4390
4733
|
* @public
|
|
4391
4734
|
*/
|
|
4392
|
-
export interface
|
|
4735
|
+
export interface GetObjectTypeAttributeStatisticsRequest {
|
|
4393
4736
|
/**
|
|
4394
|
-
* <p>The unique name of the domain
|
|
4737
|
+
* <p>The unique name of the domain.</p>
|
|
4395
4738
|
* @public
|
|
4396
4739
|
*/
|
|
4397
4740
|
DomainName: string | undefined;
|
|
4398
4741
|
/**
|
|
4399
|
-
* <p>The unique
|
|
4742
|
+
* <p>The unique name of the domain object type.</p>
|
|
4400
4743
|
* @public
|
|
4401
4744
|
*/
|
|
4402
|
-
|
|
4745
|
+
ObjectTypeName: string | undefined;
|
|
4403
4746
|
/**
|
|
4404
|
-
* <p>The
|
|
4747
|
+
* <p>The attribute name.</p>
|
|
4748
|
+
* @public
|
|
4749
|
+
*/
|
|
4750
|
+
AttributeName: string | undefined;
|
|
4751
|
+
}
|
|
4752
|
+
/**
|
|
4753
|
+
* <p>Contains percentile statistics for object type attributes.</p>
|
|
4754
|
+
* @public
|
|
4755
|
+
*/
|
|
4756
|
+
export interface GetObjectTypeAttributeStatisticsPercentiles {
|
|
4757
|
+
/**
|
|
4758
|
+
* <p>The 5th percentile value of the attribute.</p>
|
|
4759
|
+
* @public
|
|
4760
|
+
*/
|
|
4761
|
+
P5: number | undefined;
|
|
4762
|
+
/**
|
|
4763
|
+
* <p>The 25th percentile value of the attribute.</p>
|
|
4764
|
+
* @public
|
|
4765
|
+
*/
|
|
4766
|
+
P25: number | undefined;
|
|
4767
|
+
/**
|
|
4768
|
+
* <p>The 50th percentile (median) value of the attribute.</p>
|
|
4769
|
+
* @public
|
|
4770
|
+
*/
|
|
4771
|
+
P50: number | undefined;
|
|
4772
|
+
/**
|
|
4773
|
+
* <p>The 75th percentile value of the attribute.</p>
|
|
4774
|
+
* @public
|
|
4775
|
+
*/
|
|
4776
|
+
P75: number | undefined;
|
|
4777
|
+
/**
|
|
4778
|
+
* <p>The 95th percentile value of the attribute.</p>
|
|
4779
|
+
* @public
|
|
4780
|
+
*/
|
|
4781
|
+
P95: number | undefined;
|
|
4782
|
+
}
|
|
4783
|
+
/**
|
|
4784
|
+
* <p>Statistical measurements for object type attributes including basic statistics and percentiles.</p>
|
|
4785
|
+
* @public
|
|
4786
|
+
*/
|
|
4787
|
+
export interface GetObjectTypeAttributeStatisticsStats {
|
|
4788
|
+
/**
|
|
4789
|
+
* <p>The maximum value found in the attribute dataset.</p>
|
|
4790
|
+
* @public
|
|
4791
|
+
*/
|
|
4792
|
+
Maximum: number | undefined;
|
|
4793
|
+
/**
|
|
4794
|
+
* <p>The minimum value found in the attribute dataset.</p>
|
|
4795
|
+
* @public
|
|
4796
|
+
*/
|
|
4797
|
+
Minimum: number | undefined;
|
|
4798
|
+
/**
|
|
4799
|
+
* <p>The arithmetic mean of the attribute values.</p>
|
|
4800
|
+
* @public
|
|
4801
|
+
*/
|
|
4802
|
+
Average: number | undefined;
|
|
4803
|
+
/**
|
|
4804
|
+
* <p>The standard deviation of the attribute values, measuring their spread around the mean.</p>
|
|
4805
|
+
* @public
|
|
4806
|
+
*/
|
|
4807
|
+
StandardDeviation: number | undefined;
|
|
4808
|
+
/**
|
|
4809
|
+
* <p>Percentile distribution statistics for the attribute values.</p>
|
|
4810
|
+
* @public
|
|
4811
|
+
*/
|
|
4812
|
+
Percentiles: GetObjectTypeAttributeStatisticsPercentiles | undefined;
|
|
4813
|
+
}
|
|
4814
|
+
/**
|
|
4815
|
+
* @public
|
|
4816
|
+
*/
|
|
4817
|
+
export interface GetObjectTypeAttributeStatisticsResponse {
|
|
4818
|
+
/**
|
|
4819
|
+
* <p>The statistics.</p>
|
|
4820
|
+
* @public
|
|
4821
|
+
*/
|
|
4822
|
+
Statistics: GetObjectTypeAttributeStatisticsStats | undefined;
|
|
4823
|
+
/**
|
|
4824
|
+
* <p>Time when this statistics was calculated.</p>
|
|
4825
|
+
* @public
|
|
4826
|
+
*/
|
|
4827
|
+
CalculatedAt: Date | undefined;
|
|
4828
|
+
}
|
|
4829
|
+
/**
|
|
4830
|
+
* @public
|
|
4831
|
+
*/
|
|
4832
|
+
export interface GetProfileHistoryRecordRequest {
|
|
4833
|
+
/**
|
|
4834
|
+
* <p>The unique name of the domain for which to return a profile history record.</p>
|
|
4835
|
+
* @public
|
|
4836
|
+
*/
|
|
4837
|
+
DomainName: string | undefined;
|
|
4838
|
+
/**
|
|
4839
|
+
* <p>The unique identifier of the profile for which to return a history record.</p>
|
|
4840
|
+
* @public
|
|
4841
|
+
*/
|
|
4842
|
+
ProfileId: string | undefined;
|
|
4843
|
+
/**
|
|
4844
|
+
* <p>The unique identifier of the profile history record to return.</p>
|
|
4405
4845
|
* @public
|
|
4406
4846
|
*/
|
|
4407
4847
|
Id: string | undefined;
|
|
@@ -4602,6 +5042,189 @@ export interface GetProfileObjectTypeTemplateResponse {
|
|
|
4602
5042
|
*/
|
|
4603
5043
|
Keys?: Record<string, ObjectTypeKey[]> | undefined;
|
|
4604
5044
|
}
|
|
5045
|
+
/**
|
|
5046
|
+
* @public
|
|
5047
|
+
*/
|
|
5048
|
+
export interface GetProfileRecommendationsRequest {
|
|
5049
|
+
/**
|
|
5050
|
+
* <p>The unique name of the domain.</p>
|
|
5051
|
+
* @public
|
|
5052
|
+
*/
|
|
5053
|
+
DomainName: string | undefined;
|
|
5054
|
+
/**
|
|
5055
|
+
* <p>The unique identifier of the profile for which to retrieve recommendations.</p>
|
|
5056
|
+
* @public
|
|
5057
|
+
*/
|
|
5058
|
+
ProfileId: string | undefined;
|
|
5059
|
+
/**
|
|
5060
|
+
* <p>The unique name of the recommender.</p>
|
|
5061
|
+
* @public
|
|
5062
|
+
*/
|
|
5063
|
+
RecommenderName: string | undefined;
|
|
5064
|
+
/**
|
|
5065
|
+
* <p>The contextual metadata used to provide dynamic runtime information to tailor recommendations.</p>
|
|
5066
|
+
* @public
|
|
5067
|
+
*/
|
|
5068
|
+
Context?: Record<string, string> | undefined;
|
|
5069
|
+
/**
|
|
5070
|
+
* <p>The maximum number of recommendations to return. The default value is 10.</p>
|
|
5071
|
+
* @public
|
|
5072
|
+
*/
|
|
5073
|
+
MaxResults?: number | undefined;
|
|
5074
|
+
}
|
|
5075
|
+
/**
|
|
5076
|
+
* <p>Represents a single recommendation generated by the recommender system.</p>
|
|
5077
|
+
* @public
|
|
5078
|
+
*/
|
|
5079
|
+
export interface Recommendation {
|
|
5080
|
+
/**
|
|
5081
|
+
* <p>The catalog item being recommended, including its complete details and attributes.</p>
|
|
5082
|
+
* @public
|
|
5083
|
+
*/
|
|
5084
|
+
CatalogItem?: CatalogItem | undefined;
|
|
5085
|
+
/**
|
|
5086
|
+
* <p>Recommendation Score between 0 and 1.</p>
|
|
5087
|
+
* @public
|
|
5088
|
+
*/
|
|
5089
|
+
Score?: number | undefined;
|
|
5090
|
+
}
|
|
5091
|
+
/**
|
|
5092
|
+
* @public
|
|
5093
|
+
*/
|
|
5094
|
+
export interface GetProfileRecommendationsResponse {
|
|
5095
|
+
/**
|
|
5096
|
+
* <p>List of recommendations generated by the recommender.</p>
|
|
5097
|
+
* @public
|
|
5098
|
+
*/
|
|
5099
|
+
Recommendations?: Recommendation[] | undefined;
|
|
5100
|
+
}
|
|
5101
|
+
/**
|
|
5102
|
+
* @public
|
|
5103
|
+
*/
|
|
5104
|
+
export interface GetRecommenderRequest {
|
|
5105
|
+
/**
|
|
5106
|
+
* <p>The unique name of the domain.</p>
|
|
5107
|
+
* @public
|
|
5108
|
+
*/
|
|
5109
|
+
DomainName: string | undefined;
|
|
5110
|
+
/**
|
|
5111
|
+
* <p>The name of the recommender.</p>
|
|
5112
|
+
* @public
|
|
5113
|
+
*/
|
|
5114
|
+
RecommenderName: string | undefined;
|
|
5115
|
+
/**
|
|
5116
|
+
* <p>The number of training metrics to retrieve for the recommender.</p>
|
|
5117
|
+
* @public
|
|
5118
|
+
*/
|
|
5119
|
+
TrainingMetricsCount?: number | undefined;
|
|
5120
|
+
}
|
|
5121
|
+
/**
|
|
5122
|
+
* <p>Contains information about an update operation performed on a recommender.</p>
|
|
5123
|
+
* @public
|
|
5124
|
+
*/
|
|
5125
|
+
export interface RecommenderUpdate {
|
|
5126
|
+
/**
|
|
5127
|
+
* <p>The updated configuration settings applied to the recommender during this update.</p>
|
|
5128
|
+
* @public
|
|
5129
|
+
*/
|
|
5130
|
+
RecommenderConfig?: RecommenderConfig | undefined;
|
|
5131
|
+
/**
|
|
5132
|
+
* <p>The current status of the recommender update operation.</p>
|
|
5133
|
+
* @public
|
|
5134
|
+
*/
|
|
5135
|
+
Status?: RecommenderStatus | undefined;
|
|
5136
|
+
/**
|
|
5137
|
+
* <p>The timestamp when this recommender update was initiated.</p>
|
|
5138
|
+
* @public
|
|
5139
|
+
*/
|
|
5140
|
+
CreatedAt?: Date | undefined;
|
|
5141
|
+
/**
|
|
5142
|
+
* <p>The timestamp of when the recommender was edited.</p>
|
|
5143
|
+
* @public
|
|
5144
|
+
*/
|
|
5145
|
+
LastUpdatedAt?: Date | undefined;
|
|
5146
|
+
/**
|
|
5147
|
+
* <p>If the update operation failed, provides the reason for the failure.</p>
|
|
5148
|
+
* @public
|
|
5149
|
+
*/
|
|
5150
|
+
FailureReason?: string | undefined;
|
|
5151
|
+
}
|
|
5152
|
+
/**
|
|
5153
|
+
* <p>Contains metrics and performance indicators from the training of a recommender model.</p>
|
|
5154
|
+
* @public
|
|
5155
|
+
*/
|
|
5156
|
+
export interface TrainingMetrics {
|
|
5157
|
+
/**
|
|
5158
|
+
* <p>The timestamp when these training metrics were recorded.</p>
|
|
5159
|
+
* @public
|
|
5160
|
+
*/
|
|
5161
|
+
Time?: Date | undefined;
|
|
5162
|
+
/**
|
|
5163
|
+
* <p>A collection of performance metrics and statistics from the training process.</p>
|
|
5164
|
+
* @public
|
|
5165
|
+
*/
|
|
5166
|
+
Metrics?: Partial<Record<TrainingMetricName, number>> | undefined;
|
|
5167
|
+
}
|
|
5168
|
+
/**
|
|
5169
|
+
* @public
|
|
5170
|
+
*/
|
|
5171
|
+
export interface GetRecommenderResponse {
|
|
5172
|
+
/**
|
|
5173
|
+
* <p>The name of the recommender.</p>
|
|
5174
|
+
* @public
|
|
5175
|
+
*/
|
|
5176
|
+
RecommenderName: string | undefined;
|
|
5177
|
+
/**
|
|
5178
|
+
* <p>The name of the recipe used by the recommender to generate recommendations.</p>
|
|
5179
|
+
* @public
|
|
5180
|
+
*/
|
|
5181
|
+
RecommenderRecipeName: RecommenderRecipeName | undefined;
|
|
5182
|
+
/**
|
|
5183
|
+
* <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
|
|
5184
|
+
* @public
|
|
5185
|
+
*/
|
|
5186
|
+
RecommenderConfig?: RecommenderConfig | undefined;
|
|
5187
|
+
/**
|
|
5188
|
+
* <p>A detailed description of the recommender providing information about its purpose and functionality.</p>
|
|
5189
|
+
* @public
|
|
5190
|
+
*/
|
|
5191
|
+
Description?: string | undefined;
|
|
5192
|
+
/**
|
|
5193
|
+
* <p>The current status of the recommender, indicating whether it is active, creating, updating, or in another state.</p>
|
|
5194
|
+
* @public
|
|
5195
|
+
*/
|
|
5196
|
+
Status?: RecommenderStatus | undefined;
|
|
5197
|
+
/**
|
|
5198
|
+
* <p>The timestamp of when the recommender was edited.</p>
|
|
5199
|
+
* @public
|
|
5200
|
+
*/
|
|
5201
|
+
LastUpdatedAt?: Date | undefined;
|
|
5202
|
+
/**
|
|
5203
|
+
* <p>The timestamp of when the recommender was created.</p>
|
|
5204
|
+
* @public
|
|
5205
|
+
*/
|
|
5206
|
+
CreatedAt?: Date | undefined;
|
|
5207
|
+
/**
|
|
5208
|
+
* <p>If the recommender fails, provides the reason for the failure.</p>
|
|
5209
|
+
* @public
|
|
5210
|
+
*/
|
|
5211
|
+
FailureReason?: string | undefined;
|
|
5212
|
+
/**
|
|
5213
|
+
* <p>Information about the most recent update performed on the recommender, including status and timestamp.</p>
|
|
5214
|
+
* @public
|
|
5215
|
+
*/
|
|
5216
|
+
LatestRecommenderUpdate?: RecommenderUpdate | undefined;
|
|
5217
|
+
/**
|
|
5218
|
+
* <p>A set of metrics that provide information about the recommender's training performance and accuracy.</p>
|
|
5219
|
+
* @public
|
|
5220
|
+
*/
|
|
5221
|
+
TrainingMetrics?: TrainingMetrics[] | undefined;
|
|
5222
|
+
/**
|
|
5223
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
5224
|
+
* @public
|
|
5225
|
+
*/
|
|
5226
|
+
Tags?: Record<string, string> | undefined;
|
|
5227
|
+
}
|
|
4605
5228
|
/**
|
|
4606
5229
|
* @public
|
|
4607
5230
|
*/
|
|
@@ -4656,6 +5279,19 @@ export interface GetSegmentDefinitionResponse {
|
|
|
4656
5279
|
* @public
|
|
4657
5280
|
*/
|
|
4658
5281
|
Tags?: Record<string, string> | undefined;
|
|
5282
|
+
/**
|
|
5283
|
+
* <p>The segment SQL query.</p>
|
|
5284
|
+
* @public
|
|
5285
|
+
*/
|
|
5286
|
+
SegmentSqlQuery?: string | undefined;
|
|
5287
|
+
/**
|
|
5288
|
+
* <p>The segment type.</p>
|
|
5289
|
+
* <p> Classic : Segments created using traditional SegmentGroup structure</p>
|
|
5290
|
+
* <p> Enhanced : Segments created using SQL queries
|
|
5291
|
+
* </p>
|
|
5292
|
+
* @public
|
|
5293
|
+
*/
|
|
5294
|
+
SegmentType?: SegmentType | undefined;
|
|
4659
5295
|
}
|
|
4660
5296
|
/**
|
|
4661
5297
|
* @public
|
|
@@ -4790,6 +5426,11 @@ export interface GetSegmentMembershipResponse {
|
|
|
4790
5426
|
* @public
|
|
4791
5427
|
*/
|
|
4792
5428
|
Failures?: ProfileQueryFailures[] | undefined;
|
|
5429
|
+
/**
|
|
5430
|
+
* <p>The timestamp indicating when the segment membership was last computed or updated.</p>
|
|
5431
|
+
* @public
|
|
5432
|
+
*/
|
|
5433
|
+
LastComputedAt?: Date | undefined;
|
|
4793
5434
|
}
|
|
4794
5435
|
/**
|
|
4795
5436
|
* @public
|
|
@@ -5316,7 +5957,7 @@ export interface ListIntegrationItem {
|
|
|
5316
5957
|
*/
|
|
5317
5958
|
CreatedAt: Date | undefined;
|
|
5318
5959
|
/**
|
|
5319
|
-
* <p>The timestamp of when the
|
|
5960
|
+
* <p>The timestamp of when the integration was most recently edited.</p>
|
|
5320
5961
|
* @public
|
|
5321
5962
|
*/
|
|
5322
5963
|
LastUpdatedAt: Date | undefined;
|
|
@@ -5355,6 +5996,11 @@ export interface ListIntegrationItem {
|
|
|
5355
5996
|
* @public
|
|
5356
5997
|
*/
|
|
5357
5998
|
EventTriggerNames?: string[] | undefined;
|
|
5999
|
+
/**
|
|
6000
|
+
* <p>The scope or boundary of the integration item's applicability.</p>
|
|
6001
|
+
* @public
|
|
6002
|
+
*/
|
|
6003
|
+
Scope?: Scope | undefined;
|
|
5358
6004
|
}
|
|
5359
6005
|
/**
|
|
5360
6006
|
* @public
|
|
@@ -5537,38 +6183,48 @@ export interface ListDomainLayoutsResponse {
|
|
|
5537
6183
|
/**
|
|
5538
6184
|
* @public
|
|
5539
6185
|
*/
|
|
5540
|
-
export interface
|
|
6186
|
+
export interface ListDomainObjectTypesRequest {
|
|
5541
6187
|
/**
|
|
5542
|
-
* <p>The
|
|
6188
|
+
* <p>The unique name of the domain.</p>
|
|
5543
6189
|
* @public
|
|
5544
6190
|
*/
|
|
5545
|
-
|
|
6191
|
+
DomainName: string | undefined;
|
|
5546
6192
|
/**
|
|
5547
|
-
* <p>The maximum number of
|
|
6193
|
+
* <p>The maximum number of domain object types returned per page.</p>
|
|
5548
6194
|
* @public
|
|
5549
6195
|
*/
|
|
5550
6196
|
MaxResults?: number | undefined;
|
|
6197
|
+
/**
|
|
6198
|
+
* <p>The pagination token from the previous call to ListDomainObjectTypes.</p>
|
|
6199
|
+
* @public
|
|
6200
|
+
*/
|
|
6201
|
+
NextToken?: string | undefined;
|
|
5551
6202
|
}
|
|
5552
6203
|
/**
|
|
5553
|
-
* <p>
|
|
6204
|
+
* <p>Represents an item in the list of domain object types, containing basic information about a specific object type within a domain.</p>
|
|
5554
6205
|
* @public
|
|
5555
6206
|
*/
|
|
5556
|
-
export interface
|
|
6207
|
+
export interface DomainObjectTypesListItem {
|
|
5557
6208
|
/**
|
|
5558
|
-
* <p>The
|
|
6209
|
+
* <p>The name that identifies the object type within the domain.</p>
|
|
5559
6210
|
* @public
|
|
5560
6211
|
*/
|
|
5561
|
-
|
|
6212
|
+
ObjectTypeName: string | undefined;
|
|
5562
6213
|
/**
|
|
5563
|
-
* <p>
|
|
6214
|
+
* <p>A description explaining the purpose and characteristics of this object type.</p>
|
|
5564
6215
|
* @public
|
|
5565
6216
|
*/
|
|
5566
|
-
|
|
6217
|
+
Description?: string | undefined;
|
|
5567
6218
|
/**
|
|
5568
|
-
* <p>The timestamp of when the domain
|
|
6219
|
+
* <p>The timestamp of when the domain object type was created.</p>
|
|
5569
6220
|
* @public
|
|
5570
6221
|
*/
|
|
5571
|
-
|
|
6222
|
+
CreatedAt?: Date | undefined;
|
|
6223
|
+
/**
|
|
6224
|
+
* <p>The timestamp of when the domain object type was most recently edited.</p>
|
|
6225
|
+
* @public
|
|
6226
|
+
*/
|
|
6227
|
+
LastUpdatedAt?: Date | undefined;
|
|
5572
6228
|
/**
|
|
5573
6229
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
5574
6230
|
* @public
|
|
@@ -5578,14 +6234,14 @@ export interface ListDomainItem {
|
|
|
5578
6234
|
/**
|
|
5579
6235
|
* @public
|
|
5580
6236
|
*/
|
|
5581
|
-
export interface
|
|
6237
|
+
export interface ListDomainObjectTypesResponse {
|
|
5582
6238
|
/**
|
|
5583
|
-
* <p>The list of
|
|
6239
|
+
* <p>The list of domain object types.</p>
|
|
5584
6240
|
* @public
|
|
5585
6241
|
*/
|
|
5586
|
-
Items?:
|
|
6242
|
+
Items?: DomainObjectTypesListItem[] | undefined;
|
|
5587
6243
|
/**
|
|
5588
|
-
* <p>The pagination token from the previous
|
|
6244
|
+
* <p>The pagination token from the previous call to ListDomainObjectTypes.</p>
|
|
5589
6245
|
* @public
|
|
5590
6246
|
*/
|
|
5591
6247
|
NextToken?: string | undefined;
|
|
@@ -5593,14 +6249,9 @@ export interface ListDomainsResponse {
|
|
|
5593
6249
|
/**
|
|
5594
6250
|
* @public
|
|
5595
6251
|
*/
|
|
5596
|
-
export interface
|
|
5597
|
-
/**
|
|
5598
|
-
* <p>The unique name of the domain.</p>
|
|
5599
|
-
* @public
|
|
5600
|
-
*/
|
|
5601
|
-
DomainName: string | undefined;
|
|
6252
|
+
export interface ListDomainsRequest {
|
|
5602
6253
|
/**
|
|
5603
|
-
* <p>
|
|
6254
|
+
* <p>The pagination token from the previous ListDomain API call.</p>
|
|
5604
6255
|
* @public
|
|
5605
6256
|
*/
|
|
5606
6257
|
NextToken?: string | undefined;
|
|
@@ -5611,16 +6262,77 @@ export interface ListEventStreamsRequest {
|
|
|
5611
6262
|
MaxResults?: number | undefined;
|
|
5612
6263
|
}
|
|
5613
6264
|
/**
|
|
5614
|
-
* <p>
|
|
6265
|
+
* <p>An object in a list that represents a domain.</p>
|
|
5615
6266
|
* @public
|
|
5616
6267
|
*/
|
|
5617
|
-
export interface
|
|
6268
|
+
export interface ListDomainItem {
|
|
5618
6269
|
/**
|
|
5619
|
-
* <p>The
|
|
5620
|
-
* arn:aws:kinesis:region:account-id:stream/stream-name.</p>
|
|
6270
|
+
* <p>The unique name of the domain.</p>
|
|
5621
6271
|
* @public
|
|
5622
6272
|
*/
|
|
5623
|
-
|
|
6273
|
+
DomainName: string | undefined;
|
|
6274
|
+
/**
|
|
6275
|
+
* <p>The timestamp of when the domain was created.</p>
|
|
6276
|
+
* @public
|
|
6277
|
+
*/
|
|
6278
|
+
CreatedAt: Date | undefined;
|
|
6279
|
+
/**
|
|
6280
|
+
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
6281
|
+
* @public
|
|
6282
|
+
*/
|
|
6283
|
+
LastUpdatedAt: Date | undefined;
|
|
6284
|
+
/**
|
|
6285
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6286
|
+
* @public
|
|
6287
|
+
*/
|
|
6288
|
+
Tags?: Record<string, string> | undefined;
|
|
6289
|
+
}
|
|
6290
|
+
/**
|
|
6291
|
+
* @public
|
|
6292
|
+
*/
|
|
6293
|
+
export interface ListDomainsResponse {
|
|
6294
|
+
/**
|
|
6295
|
+
* <p>The list of ListDomains instances.</p>
|
|
6296
|
+
* @public
|
|
6297
|
+
*/
|
|
6298
|
+
Items?: ListDomainItem[] | undefined;
|
|
6299
|
+
/**
|
|
6300
|
+
* <p>The pagination token from the previous ListDomains API call.</p>
|
|
6301
|
+
* @public
|
|
6302
|
+
*/
|
|
6303
|
+
NextToken?: string | undefined;
|
|
6304
|
+
}
|
|
6305
|
+
/**
|
|
6306
|
+
* @public
|
|
6307
|
+
*/
|
|
6308
|
+
export interface ListEventStreamsRequest {
|
|
6309
|
+
/**
|
|
6310
|
+
* <p>The unique name of the domain.</p>
|
|
6311
|
+
* @public
|
|
6312
|
+
*/
|
|
6313
|
+
DomainName: string | undefined;
|
|
6314
|
+
/**
|
|
6315
|
+
* <p>Identifies the next page of results to return.</p>
|
|
6316
|
+
* @public
|
|
6317
|
+
*/
|
|
6318
|
+
NextToken?: string | undefined;
|
|
6319
|
+
/**
|
|
6320
|
+
* <p>The maximum number of objects returned per page.</p>
|
|
6321
|
+
* @public
|
|
6322
|
+
*/
|
|
6323
|
+
MaxResults?: number | undefined;
|
|
6324
|
+
}
|
|
6325
|
+
/**
|
|
6326
|
+
* <p>Summary information about the Kinesis data stream</p>
|
|
6327
|
+
* @public
|
|
6328
|
+
*/
|
|
6329
|
+
export interface DestinationSummary {
|
|
6330
|
+
/**
|
|
6331
|
+
* <p>The StreamARN of the destination to deliver profile events to. For example,
|
|
6332
|
+
* arn:aws:kinesis:region:account-id:stream/stream-name.</p>
|
|
6333
|
+
* @public
|
|
6334
|
+
*/
|
|
6335
|
+
Uri: string | undefined;
|
|
5624
6336
|
/**
|
|
5625
6337
|
* <p>The status of enabling the Kinesis stream as a destination for export.</p>
|
|
5626
6338
|
* @public
|
|
@@ -5972,6 +6684,67 @@ export interface ListObjectTypeAttributesResponse {
|
|
|
5972
6684
|
*/
|
|
5973
6685
|
NextToken?: string | undefined;
|
|
5974
6686
|
}
|
|
6687
|
+
/**
|
|
6688
|
+
* @public
|
|
6689
|
+
*/
|
|
6690
|
+
export interface ListObjectTypeAttributeValuesRequest {
|
|
6691
|
+
/**
|
|
6692
|
+
* <p>The pagination token from the previous call.</p>
|
|
6693
|
+
* @public
|
|
6694
|
+
*/
|
|
6695
|
+
NextToken?: string | undefined;
|
|
6696
|
+
/**
|
|
6697
|
+
* <p>The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. If not provided default as 100.</p>
|
|
6698
|
+
* @public
|
|
6699
|
+
*/
|
|
6700
|
+
MaxResults?: number | undefined;
|
|
6701
|
+
/**
|
|
6702
|
+
* <p>The unique name of the domain.</p>
|
|
6703
|
+
* @public
|
|
6704
|
+
*/
|
|
6705
|
+
DomainName: string | undefined;
|
|
6706
|
+
/**
|
|
6707
|
+
* <p>The unique name of the domain object type.</p>
|
|
6708
|
+
* @public
|
|
6709
|
+
*/
|
|
6710
|
+
ObjectTypeName: string | undefined;
|
|
6711
|
+
/**
|
|
6712
|
+
* <p>The attribute name.</p>
|
|
6713
|
+
* @public
|
|
6714
|
+
*/
|
|
6715
|
+
AttributeName: string | undefined;
|
|
6716
|
+
}
|
|
6717
|
+
/**
|
|
6718
|
+
* <p>Represents an item in the list of object type attribute values with its associated metadata.</p>
|
|
6719
|
+
* @public
|
|
6720
|
+
*/
|
|
6721
|
+
export interface ListObjectTypeAttributeValuesItem {
|
|
6722
|
+
/**
|
|
6723
|
+
* <p>The actual value of the object type attribute.</p>
|
|
6724
|
+
* @public
|
|
6725
|
+
*/
|
|
6726
|
+
Value: string | undefined;
|
|
6727
|
+
/**
|
|
6728
|
+
* <p>The timestamp of when the object type attribute value was most recently updated.</p>
|
|
6729
|
+
* @public
|
|
6730
|
+
*/
|
|
6731
|
+
LastUpdatedAt: Date | undefined;
|
|
6732
|
+
}
|
|
6733
|
+
/**
|
|
6734
|
+
* @public
|
|
6735
|
+
*/
|
|
6736
|
+
export interface ListObjectTypeAttributeValuesResponse {
|
|
6737
|
+
/**
|
|
6738
|
+
* <p>A list of unique attribute values sorted on the basis of LastUpdatedAt. </p>
|
|
6739
|
+
* @public
|
|
6740
|
+
*/
|
|
6741
|
+
Items?: ListObjectTypeAttributeValuesItem[] | undefined;
|
|
6742
|
+
/**
|
|
6743
|
+
* <p>The pagination token from the previous call to call ListObjectTypeAttributeValues. </p>
|
|
6744
|
+
* @public
|
|
6745
|
+
*/
|
|
6746
|
+
NextToken?: string | undefined;
|
|
6747
|
+
}
|
|
5975
6748
|
/**
|
|
5976
6749
|
* @public
|
|
5977
6750
|
*/
|
|
@@ -6244,7 +7017,7 @@ export interface ListProfileObjectTypeItem {
|
|
|
6244
7017
|
*/
|
|
6245
7018
|
CreatedAt?: Date | undefined;
|
|
6246
7019
|
/**
|
|
6247
|
-
* <p>The timestamp of when the
|
|
7020
|
+
* <p>The timestamp of when the profile object type was most recently edited.</p>
|
|
6248
7021
|
* @public
|
|
6249
7022
|
*/
|
|
6250
7023
|
LastUpdatedAt?: Date | undefined;
|
|
@@ -6330,6 +7103,143 @@ export interface ListProfileObjectTypeTemplatesResponse {
|
|
|
6330
7103
|
*/
|
|
6331
7104
|
NextToken?: string | undefined;
|
|
6332
7105
|
}
|
|
7106
|
+
/**
|
|
7107
|
+
* @public
|
|
7108
|
+
*/
|
|
7109
|
+
export interface ListRecommenderRecipesRequest {
|
|
7110
|
+
/**
|
|
7111
|
+
* <p>The maximum number of recommender recipes to return in the response. The default value is 100.</p>
|
|
7112
|
+
* @public
|
|
7113
|
+
*/
|
|
7114
|
+
MaxResults?: number | undefined;
|
|
7115
|
+
/**
|
|
7116
|
+
* <p>A token received from a previous ListRecommenderRecipes call to retrieve the next page of results.</p>
|
|
7117
|
+
* @public
|
|
7118
|
+
*/
|
|
7119
|
+
NextToken?: string | undefined;
|
|
7120
|
+
}
|
|
7121
|
+
/**
|
|
7122
|
+
* <p>Defines the algorithm and approach used to generate recommendations.</p>
|
|
7123
|
+
* @public
|
|
7124
|
+
*/
|
|
7125
|
+
export interface RecommenderRecipe {
|
|
7126
|
+
/**
|
|
7127
|
+
* <p>The name of the recommender recipe.</p>
|
|
7128
|
+
* @public
|
|
7129
|
+
*/
|
|
7130
|
+
name?: RecommenderRecipeName | undefined;
|
|
7131
|
+
/**
|
|
7132
|
+
* <p>A description of the recommender recipe's purpose and functionality.</p>
|
|
7133
|
+
* @public
|
|
7134
|
+
*/
|
|
7135
|
+
description?: string | undefined;
|
|
7136
|
+
}
|
|
7137
|
+
/**
|
|
7138
|
+
* @public
|
|
7139
|
+
*/
|
|
7140
|
+
export interface ListRecommenderRecipesResponse {
|
|
7141
|
+
/**
|
|
7142
|
+
* <p>A token to retrieve the next page of results. Null if there are no more results to retrieve.</p>
|
|
7143
|
+
* @public
|
|
7144
|
+
*/
|
|
7145
|
+
NextToken?: string | undefined;
|
|
7146
|
+
/**
|
|
7147
|
+
* <p>A list of available recommender recipes and their properties.</p>
|
|
7148
|
+
* @public
|
|
7149
|
+
*/
|
|
7150
|
+
RecommenderRecipes?: RecommenderRecipe[] | undefined;
|
|
7151
|
+
}
|
|
7152
|
+
/**
|
|
7153
|
+
* @public
|
|
7154
|
+
*/
|
|
7155
|
+
export interface ListRecommendersRequest {
|
|
7156
|
+
/**
|
|
7157
|
+
* <p>The unique name of the domain.</p>
|
|
7158
|
+
* @public
|
|
7159
|
+
*/
|
|
7160
|
+
DomainName: string | undefined;
|
|
7161
|
+
/**
|
|
7162
|
+
* <p>The maximum number of recommenders to return in the response. The default value is 100.</p>
|
|
7163
|
+
* @public
|
|
7164
|
+
*/
|
|
7165
|
+
MaxResults?: number | undefined;
|
|
7166
|
+
/**
|
|
7167
|
+
* <p>A token received from a previous ListRecommenders call to retrieve the next page of results.</p>
|
|
7168
|
+
* @public
|
|
7169
|
+
*/
|
|
7170
|
+
NextToken?: string | undefined;
|
|
7171
|
+
}
|
|
7172
|
+
/**
|
|
7173
|
+
* <p>Provides a summary of a recommender's configuration and current state.</p>
|
|
7174
|
+
* @public
|
|
7175
|
+
*/
|
|
7176
|
+
export interface RecommenderSummary {
|
|
7177
|
+
/**
|
|
7178
|
+
* <p>The name of the recommender.</p>
|
|
7179
|
+
* @public
|
|
7180
|
+
*/
|
|
7181
|
+
RecommenderName?: string | undefined;
|
|
7182
|
+
/**
|
|
7183
|
+
* <p>The name of the recipe used by this recommender.</p>
|
|
7184
|
+
* @public
|
|
7185
|
+
*/
|
|
7186
|
+
RecipeName?: RecommenderRecipeName | undefined;
|
|
7187
|
+
/**
|
|
7188
|
+
* <p>The configuration settings applied to this recommender.</p>
|
|
7189
|
+
* @public
|
|
7190
|
+
*/
|
|
7191
|
+
RecommenderConfig?: RecommenderConfig | undefined;
|
|
7192
|
+
/**
|
|
7193
|
+
* <p>The timestamp when the recommender was created.</p>
|
|
7194
|
+
* @public
|
|
7195
|
+
*/
|
|
7196
|
+
CreatedAt?: Date | undefined;
|
|
7197
|
+
/**
|
|
7198
|
+
* <p>A description of the recommender's purpose and characteristics.</p>
|
|
7199
|
+
* @public
|
|
7200
|
+
*/
|
|
7201
|
+
Description?: string | undefined;
|
|
7202
|
+
/**
|
|
7203
|
+
* <p>The current operational status of the recommender.</p>
|
|
7204
|
+
* @public
|
|
7205
|
+
*/
|
|
7206
|
+
Status?: RecommenderStatus | undefined;
|
|
7207
|
+
/**
|
|
7208
|
+
* <p>The timestamp of when the recommender was edited.</p>
|
|
7209
|
+
* @public
|
|
7210
|
+
*/
|
|
7211
|
+
LastUpdatedAt?: Date | undefined;
|
|
7212
|
+
/**
|
|
7213
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7214
|
+
* @public
|
|
7215
|
+
*/
|
|
7216
|
+
Tags?: Record<string, string> | undefined;
|
|
7217
|
+
/**
|
|
7218
|
+
* <p>If the recommender is in a failed state, provides the reason for the failure.</p>
|
|
7219
|
+
* @public
|
|
7220
|
+
*/
|
|
7221
|
+
FailureReason?: string | undefined;
|
|
7222
|
+
/**
|
|
7223
|
+
* <p>Information about the most recent update performed on the recommender, including its status and timing.</p>
|
|
7224
|
+
* @public
|
|
7225
|
+
*/
|
|
7226
|
+
LatestRecommenderUpdate?: RecommenderUpdate | undefined;
|
|
7227
|
+
}
|
|
7228
|
+
/**
|
|
7229
|
+
* @public
|
|
7230
|
+
*/
|
|
7231
|
+
export interface ListRecommendersResponse {
|
|
7232
|
+
/**
|
|
7233
|
+
* <p>A token to retrieve the next page of results. Null if there are no more results to retrieve.</p>
|
|
7234
|
+
* @public
|
|
7235
|
+
*/
|
|
7236
|
+
NextToken?: string | undefined;
|
|
7237
|
+
/**
|
|
7238
|
+
* <p>A list of recommenders and their properties in the specified domain.</p>
|
|
7239
|
+
* @public
|
|
7240
|
+
*/
|
|
7241
|
+
Recommenders?: RecommenderSummary[] | undefined;
|
|
7242
|
+
}
|
|
6333
7243
|
/**
|
|
6334
7244
|
* @public
|
|
6335
7245
|
*/
|
|
@@ -6422,6 +7332,14 @@ export interface SegmentDefinitionItem {
|
|
|
6422
7332
|
* @public
|
|
6423
7333
|
*/
|
|
6424
7334
|
Tags?: Record<string, string> | undefined;
|
|
7335
|
+
/**
|
|
7336
|
+
* <p>The segment type.</p>
|
|
7337
|
+
* <p> Classic : Segments created using traditional SegmentGroup structure</p>
|
|
7338
|
+
* <p> Enhanced : Segments created using SQL queries
|
|
7339
|
+
* </p>
|
|
7340
|
+
* @public
|
|
7341
|
+
*/
|
|
7342
|
+
SegmentType?: SegmentType | undefined;
|
|
6425
7343
|
}
|
|
6426
7344
|
/**
|
|
6427
7345
|
* @public
|
|
@@ -6788,68 +7706,148 @@ export interface MergeProfilesResponse {
|
|
|
6788
7706
|
/**
|
|
6789
7707
|
* @public
|
|
6790
7708
|
*/
|
|
6791
|
-
export interface
|
|
7709
|
+
export interface PutDomainObjectTypeRequest {
|
|
6792
7710
|
/**
|
|
6793
7711
|
* <p>The unique name of the domain.</p>
|
|
6794
7712
|
* @public
|
|
6795
7713
|
*/
|
|
6796
7714
|
DomainName: string | undefined;
|
|
6797
7715
|
/**
|
|
6798
|
-
* <p>The
|
|
6799
|
-
* @public
|
|
6800
|
-
*/
|
|
6801
|
-
Uri?: string | undefined;
|
|
6802
|
-
/**
|
|
6803
|
-
* <p>The name of the profile object type.</p>
|
|
6804
|
-
* @public
|
|
6805
|
-
*/
|
|
6806
|
-
ObjectTypeName?: string | undefined;
|
|
6807
|
-
/**
|
|
6808
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7716
|
+
* <p>The unique name of the domain object type.</p>
|
|
6809
7717
|
* @public
|
|
6810
7718
|
*/
|
|
6811
|
-
|
|
7719
|
+
ObjectTypeName: string | undefined;
|
|
6812
7720
|
/**
|
|
6813
|
-
* <p>The
|
|
6814
|
-
* source.</p>
|
|
7721
|
+
* <p>The description of the domain object type.</p>
|
|
6815
7722
|
* @public
|
|
6816
7723
|
*/
|
|
6817
|
-
|
|
7724
|
+
Description?: string | undefined;
|
|
6818
7725
|
/**
|
|
6819
|
-
* <p>
|
|
6820
|
-
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
6821
|
-
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
7726
|
+
* <p>The customer provided KMS key used to encrypt this type of domain object.</p>
|
|
6822
7727
|
* @public
|
|
6823
7728
|
*/
|
|
6824
|
-
|
|
7729
|
+
EncryptionKey?: string | undefined;
|
|
6825
7730
|
/**
|
|
6826
|
-
* <p>
|
|
6827
|
-
* Customer Profiles requests on your behalf.</p>
|
|
7731
|
+
* <p>A map of field names to their corresponding domain object type field definitions.</p>
|
|
6828
7732
|
* @public
|
|
6829
7733
|
*/
|
|
6830
|
-
|
|
7734
|
+
Fields: Record<string, DomainObjectTypeField> | undefined;
|
|
6831
7735
|
/**
|
|
6832
|
-
* <p>
|
|
7736
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6833
7737
|
* @public
|
|
6834
7738
|
*/
|
|
6835
|
-
|
|
7739
|
+
Tags?: Record<string, string> | undefined;
|
|
6836
7740
|
}
|
|
6837
7741
|
/**
|
|
6838
7742
|
* @public
|
|
6839
7743
|
*/
|
|
6840
|
-
export interface
|
|
7744
|
+
export interface PutDomainObjectTypeResponse {
|
|
6841
7745
|
/**
|
|
6842
|
-
* <p>The unique name of the domain.</p>
|
|
7746
|
+
* <p>The unique name of the domain object type.</p>
|
|
6843
7747
|
* @public
|
|
6844
7748
|
*/
|
|
6845
|
-
|
|
7749
|
+
ObjectTypeName?: string | undefined;
|
|
6846
7750
|
/**
|
|
6847
|
-
* <p>The
|
|
7751
|
+
* <p>The description of the domain object type.</p>
|
|
6848
7752
|
* @public
|
|
6849
7753
|
*/
|
|
6850
|
-
|
|
7754
|
+
Description?: string | undefined;
|
|
6851
7755
|
/**
|
|
6852
|
-
* <p>The
|
|
7756
|
+
* <p>The customer provided KMS key used to encrypt this type of domain object.</p>
|
|
7757
|
+
* @public
|
|
7758
|
+
*/
|
|
7759
|
+
EncryptionKey?: string | undefined;
|
|
7760
|
+
/**
|
|
7761
|
+
* <p>A map of field names to their corresponding domain object type field definitions.</p>
|
|
7762
|
+
* @public
|
|
7763
|
+
*/
|
|
7764
|
+
Fields?: Record<string, DomainObjectTypeField> | undefined;
|
|
7765
|
+
/**
|
|
7766
|
+
* <p>The timestamp of when the domain object type was created.</p>
|
|
7767
|
+
* @public
|
|
7768
|
+
*/
|
|
7769
|
+
CreatedAt?: Date | undefined;
|
|
7770
|
+
/**
|
|
7771
|
+
* <p>The timestamp of when the domain object type was most recently edited.</p>
|
|
7772
|
+
* @public
|
|
7773
|
+
*/
|
|
7774
|
+
LastUpdatedAt?: Date | undefined;
|
|
7775
|
+
/**
|
|
7776
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7777
|
+
* @public
|
|
7778
|
+
*/
|
|
7779
|
+
Tags?: Record<string, string> | undefined;
|
|
7780
|
+
}
|
|
7781
|
+
/**
|
|
7782
|
+
* @public
|
|
7783
|
+
*/
|
|
7784
|
+
export interface PutIntegrationRequest {
|
|
7785
|
+
/**
|
|
7786
|
+
* <p>The unique name of the domain.</p>
|
|
7787
|
+
* @public
|
|
7788
|
+
*/
|
|
7789
|
+
DomainName: string | undefined;
|
|
7790
|
+
/**
|
|
7791
|
+
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
7792
|
+
* @public
|
|
7793
|
+
*/
|
|
7794
|
+
Uri?: string | undefined;
|
|
7795
|
+
/**
|
|
7796
|
+
* <p>The name of the profile object type.</p>
|
|
7797
|
+
* @public
|
|
7798
|
+
*/
|
|
7799
|
+
ObjectTypeName?: string | undefined;
|
|
7800
|
+
/**
|
|
7801
|
+
* <p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.
|
|
7802
|
+
* It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>,
|
|
7803
|
+
* <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>
|
|
7804
|
+
* @public
|
|
7805
|
+
*/
|
|
7806
|
+
ObjectTypeNames?: Record<string, string> | undefined;
|
|
7807
|
+
/**
|
|
7808
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7809
|
+
* @public
|
|
7810
|
+
*/
|
|
7811
|
+
Tags?: Record<string, string> | undefined;
|
|
7812
|
+
/**
|
|
7813
|
+
* <p>The configuration that controls how Customer Profiles retrieves data from the
|
|
7814
|
+
* source.</p>
|
|
7815
|
+
* @public
|
|
7816
|
+
*/
|
|
7817
|
+
FlowDefinition?: FlowDefinition | undefined;
|
|
7818
|
+
/**
|
|
7819
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make
|
|
7820
|
+
* Customer Profiles requests on your behalf.</p>
|
|
7821
|
+
* @public
|
|
7822
|
+
*/
|
|
7823
|
+
RoleArn?: string | undefined;
|
|
7824
|
+
/**
|
|
7825
|
+
* <p>A list of unique names for active event triggers associated with the integration.</p>
|
|
7826
|
+
* @public
|
|
7827
|
+
*/
|
|
7828
|
+
EventTriggerNames?: string[] | undefined;
|
|
7829
|
+
/**
|
|
7830
|
+
* <p>Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.</p>
|
|
7831
|
+
* @public
|
|
7832
|
+
*/
|
|
7833
|
+
Scope?: Scope | undefined;
|
|
7834
|
+
}
|
|
7835
|
+
/**
|
|
7836
|
+
* @public
|
|
7837
|
+
*/
|
|
7838
|
+
export interface PutIntegrationResponse {
|
|
7839
|
+
/**
|
|
7840
|
+
* <p>The unique name of the domain.</p>
|
|
7841
|
+
* @public
|
|
7842
|
+
*/
|
|
7843
|
+
DomainName: string | undefined;
|
|
7844
|
+
/**
|
|
7845
|
+
* <p>The URI of the S3 bucket or any other type of data source.</p>
|
|
7846
|
+
* @public
|
|
7847
|
+
*/
|
|
7848
|
+
Uri: string | undefined;
|
|
7849
|
+
/**
|
|
7850
|
+
* <p>The name of the profile object type.</p>
|
|
6853
7851
|
* @public
|
|
6854
7852
|
*/
|
|
6855
7853
|
ObjectTypeName?: string | undefined;
|
|
@@ -6899,6 +7897,11 @@ export interface PutIntegrationResponse {
|
|
|
6899
7897
|
* @public
|
|
6900
7898
|
*/
|
|
6901
7899
|
EventTriggerNames?: string[] | undefined;
|
|
7900
|
+
/**
|
|
7901
|
+
* <p>Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.</p>
|
|
7902
|
+
* @public
|
|
7903
|
+
*/
|
|
7904
|
+
Scope?: Scope | undefined;
|
|
6902
7905
|
}
|
|
6903
7906
|
/**
|
|
6904
7907
|
* @public
|
|
@@ -7176,34 +8179,34 @@ export interface SearchProfilesResponse {
|
|
|
7176
8179
|
/**
|
|
7177
8180
|
* @public
|
|
7178
8181
|
*/
|
|
7179
|
-
export interface
|
|
8182
|
+
export interface StartRecommenderRequest {
|
|
7180
8183
|
/**
|
|
7181
|
-
* <p>The unique name of the domain
|
|
8184
|
+
* <p>The unique name of the domain.</p>
|
|
7182
8185
|
* @public
|
|
7183
8186
|
*/
|
|
7184
8187
|
DomainName: string | undefined;
|
|
7185
8188
|
/**
|
|
7186
|
-
* <p>The
|
|
8189
|
+
* <p>The name of the recommender to start.</p>
|
|
7187
8190
|
* @public
|
|
7188
8191
|
*/
|
|
7189
|
-
|
|
8192
|
+
RecommenderName: string | undefined;
|
|
7190
8193
|
}
|
|
7191
8194
|
/**
|
|
7192
8195
|
* @public
|
|
7193
8196
|
*/
|
|
7194
|
-
export interface
|
|
8197
|
+
export interface StartRecommenderResponse {
|
|
7195
8198
|
}
|
|
7196
8199
|
/**
|
|
7197
8200
|
* @public
|
|
7198
8201
|
*/
|
|
7199
|
-
export interface
|
|
8202
|
+
export interface StartUploadJobRequest {
|
|
7200
8203
|
/**
|
|
7201
|
-
* <p>The unique name of the domain containing the upload job to
|
|
8204
|
+
* <p>The unique name of the domain containing the upload job to start. </p>
|
|
7202
8205
|
* @public
|
|
7203
8206
|
*/
|
|
7204
8207
|
DomainName: string | undefined;
|
|
7205
8208
|
/**
|
|
7206
|
-
* <p>The unique identifier of the upload job to
|
|
8209
|
+
* <p>The unique identifier of the upload job to start. </p>
|
|
7207
8210
|
* @public
|
|
7208
8211
|
*/
|
|
7209
8212
|
JobId: string | undefined;
|
|
@@ -7211,677 +8214,20 @@ export interface StopUploadJobRequest {
|
|
|
7211
8214
|
/**
|
|
7212
8215
|
* @public
|
|
7213
8216
|
*/
|
|
7214
|
-
export interface
|
|
7215
|
-
}
|
|
7216
|
-
/**
|
|
7217
|
-
* @public
|
|
7218
|
-
*/
|
|
7219
|
-
export interface TagResourceRequest {
|
|
7220
|
-
/**
|
|
7221
|
-
* <p>The ARN of the resource that you're adding tags to.</p>
|
|
7222
|
-
* @public
|
|
7223
|
-
*/
|
|
7224
|
-
resourceArn: string | undefined;
|
|
7225
|
-
/**
|
|
7226
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7227
|
-
* @public
|
|
7228
|
-
*/
|
|
7229
|
-
tags: Record<string, string> | undefined;
|
|
7230
|
-
}
|
|
7231
|
-
/**
|
|
7232
|
-
* @public
|
|
7233
|
-
*/
|
|
7234
|
-
export interface TagResourceResponse {
|
|
7235
|
-
}
|
|
7236
|
-
/**
|
|
7237
|
-
* @public
|
|
7238
|
-
*/
|
|
7239
|
-
export interface UntagResourceRequest {
|
|
7240
|
-
/**
|
|
7241
|
-
* <p>The ARN of the resource from which you are removing tags.</p>
|
|
7242
|
-
* @public
|
|
7243
|
-
*/
|
|
7244
|
-
resourceArn: string | undefined;
|
|
7245
|
-
/**
|
|
7246
|
-
* <p>The list of tag keys to remove from the resource.</p>
|
|
7247
|
-
* @public
|
|
7248
|
-
*/
|
|
7249
|
-
tagKeys: string[] | undefined;
|
|
7250
|
-
}
|
|
7251
|
-
/**
|
|
7252
|
-
* @public
|
|
7253
|
-
*/
|
|
7254
|
-
export interface UntagResourceResponse {
|
|
7255
|
-
}
|
|
7256
|
-
/**
|
|
7257
|
-
* @public
|
|
7258
|
-
*/
|
|
7259
|
-
export interface UpdateCalculatedAttributeDefinitionRequest {
|
|
7260
|
-
/**
|
|
7261
|
-
* <p>The unique name of the domain.</p>
|
|
7262
|
-
* @public
|
|
7263
|
-
*/
|
|
7264
|
-
DomainName: string | undefined;
|
|
7265
|
-
/**
|
|
7266
|
-
* <p>The unique name of the calculated attribute.</p>
|
|
7267
|
-
* @public
|
|
7268
|
-
*/
|
|
7269
|
-
CalculatedAttributeName: string | undefined;
|
|
7270
|
-
/**
|
|
7271
|
-
* <p>The display name of the calculated attribute.</p>
|
|
7272
|
-
* @public
|
|
7273
|
-
*/
|
|
7274
|
-
DisplayName?: string | undefined;
|
|
7275
|
-
/**
|
|
7276
|
-
* <p>The description of the calculated attribute.</p>
|
|
7277
|
-
* @public
|
|
7278
|
-
*/
|
|
7279
|
-
Description?: string | undefined;
|
|
7280
|
-
/**
|
|
7281
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
7282
|
-
* attribute.</p>
|
|
7283
|
-
* @public
|
|
7284
|
-
*/
|
|
7285
|
-
Conditions?: Conditions | undefined;
|
|
7286
|
-
}
|
|
7287
|
-
/**
|
|
7288
|
-
* @public
|
|
7289
|
-
*/
|
|
7290
|
-
export interface UpdateCalculatedAttributeDefinitionResponse {
|
|
7291
|
-
/**
|
|
7292
|
-
* <p>The unique name of the calculated attribute.</p>
|
|
7293
|
-
* @public
|
|
7294
|
-
*/
|
|
7295
|
-
CalculatedAttributeName?: string | undefined;
|
|
7296
|
-
/**
|
|
7297
|
-
* <p>The display name of the calculated attribute.</p>
|
|
7298
|
-
* @public
|
|
7299
|
-
*/
|
|
7300
|
-
DisplayName?: string | undefined;
|
|
7301
|
-
/**
|
|
7302
|
-
* <p>The description of the calculated attribute.</p>
|
|
7303
|
-
* @public
|
|
7304
|
-
*/
|
|
7305
|
-
Description?: string | undefined;
|
|
7306
|
-
/**
|
|
7307
|
-
* <p>The timestamp of when the calculated attribute definition was created.</p>
|
|
7308
|
-
* @public
|
|
7309
|
-
*/
|
|
7310
|
-
CreatedAt?: Date | undefined;
|
|
7311
|
-
/**
|
|
7312
|
-
* <p>The timestamp of when the calculated attribute definition was most recently
|
|
7313
|
-
* edited.</p>
|
|
7314
|
-
* @public
|
|
7315
|
-
*/
|
|
7316
|
-
LastUpdatedAt?: Date | undefined;
|
|
7317
|
-
/**
|
|
7318
|
-
* <p>The aggregation operation to perform for the calculated attribute.</p>
|
|
7319
|
-
* @public
|
|
7320
|
-
*/
|
|
7321
|
-
Statistic?: Statistic | undefined;
|
|
7322
|
-
/**
|
|
7323
|
-
* <p>The conditions including range, object count, and threshold for the calculated
|
|
7324
|
-
* attribute.</p>
|
|
7325
|
-
* @public
|
|
7326
|
-
*/
|
|
7327
|
-
Conditions?: Conditions | undefined;
|
|
7328
|
-
/**
|
|
7329
|
-
* <p>The mathematical expression and a list of attribute items specified in that
|
|
7330
|
-
* expression.</p>
|
|
7331
|
-
* @public
|
|
7332
|
-
*/
|
|
7333
|
-
AttributeDetails?: AttributeDetails | undefined;
|
|
7334
|
-
/**
|
|
7335
|
-
* <p>Whether historical data ingested before the Calculated Attribute was created should be
|
|
7336
|
-
* included in calculations.</p>
|
|
7337
|
-
* @public
|
|
7338
|
-
*/
|
|
7339
|
-
UseHistoricalData?: boolean | undefined;
|
|
7340
|
-
/**
|
|
7341
|
-
* <p>Status of the Calculated Attribute creation (whether all historical data has been
|
|
7342
|
-
* indexed.)</p>
|
|
7343
|
-
* @public
|
|
7344
|
-
*/
|
|
7345
|
-
Status?: ReadinessStatus | undefined;
|
|
7346
|
-
/**
|
|
7347
|
-
* <p>Information indicating if the Calculated Attribute is ready for use by confirming all
|
|
7348
|
-
* historical data has been processed and reflected.</p>
|
|
7349
|
-
* @public
|
|
7350
|
-
*/
|
|
7351
|
-
Readiness?: Readiness | undefined;
|
|
7352
|
-
/**
|
|
7353
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7354
|
-
* @public
|
|
7355
|
-
*/
|
|
7356
|
-
Tags?: Record<string, string> | undefined;
|
|
8217
|
+
export interface StartUploadJobResponse {
|
|
7357
8218
|
}
|
|
7358
8219
|
/**
|
|
7359
8220
|
* @public
|
|
7360
8221
|
*/
|
|
7361
|
-
export interface
|
|
8222
|
+
export interface StopRecommenderRequest {
|
|
7362
8223
|
/**
|
|
7363
8224
|
* <p>The unique name of the domain.</p>
|
|
7364
8225
|
* @public
|
|
7365
8226
|
*/
|
|
7366
8227
|
DomainName: string | undefined;
|
|
7367
8228
|
/**
|
|
7368
|
-
* <p>The
|
|
7369
|
-
* @public
|
|
7370
|
-
*/
|
|
7371
|
-
DefaultExpirationDays?: number | undefined;
|
|
7372
|
-
/**
|
|
7373
|
-
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
7374
|
-
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
7375
|
-
* permanent or semi-permanent storage. If specified as an empty string, it will clear any
|
|
7376
|
-
* existing value.</p>
|
|
7377
|
-
* @public
|
|
7378
|
-
*/
|
|
7379
|
-
DefaultEncryptionKey?: string | undefined;
|
|
7380
|
-
/**
|
|
7381
|
-
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
7382
|
-
* ingesting data from third party applications. If specified as an empty string, it will
|
|
7383
|
-
* clear any existing value. You must set up a policy on the DeadLetterQueue for the
|
|
7384
|
-
* SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the
|
|
7385
|
-
* DeadLetterQueue.</p>
|
|
7386
|
-
* @public
|
|
7387
|
-
*/
|
|
7388
|
-
DeadLetterQueueUrl?: string | undefined;
|
|
7389
|
-
/**
|
|
7390
|
-
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
7391
|
-
* 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
|
|
7392
|
-
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
7393
|
-
* <p>After the Identity Resolution Job completes, use the
|
|
7394
|
-
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
|
|
7395
|
-
* 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
|
|
7396
|
-
* S3.</p>
|
|
8229
|
+
* <p>The name of the recommender to stop.</p>
|
|
7397
8230
|
* @public
|
|
7398
8231
|
*/
|
|
7399
|
-
|
|
7400
|
-
/**
|
|
7401
|
-
* <p>The process of matching duplicate profiles using the rule-Based matching. If
|
|
7402
|
-
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
7403
|
-
* to match and merge your profiles according to your configuration in the
|
|
7404
|
-
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
7405
|
-
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
7406
|
-
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
7407
|
-
* can download the results from S3.</p>
|
|
7408
|
-
* @public
|
|
7409
|
-
*/
|
|
7410
|
-
RuleBasedMatching?: RuleBasedMatchingRequest | undefined;
|
|
7411
|
-
/**
|
|
7412
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7413
|
-
* @public
|
|
7414
|
-
*/
|
|
7415
|
-
Tags?: Record<string, string> | undefined;
|
|
7416
|
-
}
|
|
7417
|
-
/**
|
|
7418
|
-
* @public
|
|
7419
|
-
*/
|
|
7420
|
-
export interface UpdateDomainResponse {
|
|
7421
|
-
/**
|
|
7422
|
-
* <p>The unique name of the domain.</p>
|
|
7423
|
-
* @public
|
|
7424
|
-
*/
|
|
7425
|
-
DomainName: string | undefined;
|
|
7426
|
-
/**
|
|
7427
|
-
* <p>The default number of days until the data within the domain expires.</p>
|
|
7428
|
-
* @public
|
|
7429
|
-
*/
|
|
7430
|
-
DefaultExpirationDays?: number | undefined;
|
|
7431
|
-
/**
|
|
7432
|
-
* <p>The default encryption key, which is an AWS managed key, is used when no specific type
|
|
7433
|
-
* of encryption key is specified. It is used to encrypt all data before it is placed in
|
|
7434
|
-
* permanent or semi-permanent storage.</p>
|
|
7435
|
-
* @public
|
|
7436
|
-
*/
|
|
7437
|
-
DefaultEncryptionKey?: string | undefined;
|
|
7438
|
-
/**
|
|
7439
|
-
* <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with
|
|
7440
|
-
* ingesting data from third party applications.</p>
|
|
7441
|
-
* @public
|
|
7442
|
-
*/
|
|
7443
|
-
DeadLetterQueueUrl?: string | undefined;
|
|
7444
|
-
/**
|
|
7445
|
-
* <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly
|
|
7446
|
-
* 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
|
|
7447
|
-
* Saturday at 12AM UTC to detect duplicate profiles in your domains. </p>
|
|
7448
|
-
* <p>After the Identity Resolution Job completes, use the
|
|
7449
|
-
* <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>
|
|
7450
|
-
* 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
|
|
7451
|
-
* S3.</p>
|
|
7452
|
-
* @public
|
|
7453
|
-
*/
|
|
7454
|
-
Matching?: MatchingResponse | undefined;
|
|
7455
|
-
/**
|
|
7456
|
-
* <p>The process of matching duplicate profiles using the rule-Based matching. If
|
|
7457
|
-
* <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start
|
|
7458
|
-
* to match and merge your profiles according to your configuration in the
|
|
7459
|
-
* <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code>
|
|
7460
|
-
* and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have
|
|
7461
|
-
* configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you
|
|
7462
|
-
* can download the results from S3.</p>
|
|
7463
|
-
* @public
|
|
7464
|
-
*/
|
|
7465
|
-
RuleBasedMatching?: RuleBasedMatchingResponse | undefined;
|
|
7466
|
-
/**
|
|
7467
|
-
* <p>The timestamp of when the domain was created.</p>
|
|
7468
|
-
* @public
|
|
7469
|
-
*/
|
|
7470
|
-
CreatedAt: Date | undefined;
|
|
7471
|
-
/**
|
|
7472
|
-
* <p>The timestamp of when the domain was most recently edited.</p>
|
|
7473
|
-
* @public
|
|
7474
|
-
*/
|
|
7475
|
-
LastUpdatedAt: Date | undefined;
|
|
7476
|
-
/**
|
|
7477
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7478
|
-
* @public
|
|
7479
|
-
*/
|
|
7480
|
-
Tags?: Record<string, string> | undefined;
|
|
7481
|
-
}
|
|
7482
|
-
/**
|
|
7483
|
-
* @public
|
|
7484
|
-
*/
|
|
7485
|
-
export interface UpdateDomainLayoutRequest {
|
|
7486
|
-
/**
|
|
7487
|
-
* <p>The unique name of the domain.</p>
|
|
7488
|
-
* @public
|
|
7489
|
-
*/
|
|
7490
|
-
DomainName: string | undefined;
|
|
7491
|
-
/**
|
|
7492
|
-
* <p>The unique name of the layout.</p>
|
|
7493
|
-
* @public
|
|
7494
|
-
*/
|
|
7495
|
-
LayoutDefinitionName: string | undefined;
|
|
7496
|
-
/**
|
|
7497
|
-
* <p>The description of the layout</p>
|
|
7498
|
-
* @public
|
|
7499
|
-
*/
|
|
7500
|
-
Description?: string | undefined;
|
|
7501
|
-
/**
|
|
7502
|
-
* <p>The display name of the layout</p>
|
|
7503
|
-
* @public
|
|
7504
|
-
*/
|
|
7505
|
-
DisplayName?: string | undefined;
|
|
7506
|
-
/**
|
|
7507
|
-
* <p>If set to true for a layout, this layout will be used by default to view data. If set to
|
|
7508
|
-
* false, then the layout will not be used by default, but it can be used to view data by
|
|
7509
|
-
* explicitly selecting it in the console.</p>
|
|
7510
|
-
* @public
|
|
7511
|
-
*/
|
|
7512
|
-
IsDefault?: boolean | undefined;
|
|
7513
|
-
/**
|
|
7514
|
-
* <p>The type of layout that can be used to view data under a Customer Profiles domain.</p>
|
|
7515
|
-
* @public
|
|
7516
|
-
*/
|
|
7517
|
-
LayoutType?: LayoutType | undefined;
|
|
7518
|
-
/**
|
|
7519
|
-
* <p>A customizable layout that can be used to view data under a Customer Profiles domain.</p>
|
|
7520
|
-
* @public
|
|
7521
|
-
*/
|
|
7522
|
-
Layout?: string | undefined;
|
|
7523
|
-
}
|
|
7524
|
-
/**
|
|
7525
|
-
* @public
|
|
7526
|
-
*/
|
|
7527
|
-
export interface UpdateDomainLayoutResponse {
|
|
7528
|
-
/**
|
|
7529
|
-
* <p>The unique name of the layout.</p>
|
|
7530
|
-
* @public
|
|
7531
|
-
*/
|
|
7532
|
-
LayoutDefinitionName?: string | undefined;
|
|
7533
|
-
/**
|
|
7534
|
-
* <p>The description of the layout</p>
|
|
7535
|
-
* @public
|
|
7536
|
-
*/
|
|
7537
|
-
Description?: string | undefined;
|
|
7538
|
-
/**
|
|
7539
|
-
* <p>The display name of the layout</p>
|
|
7540
|
-
* @public
|
|
7541
|
-
*/
|
|
7542
|
-
DisplayName?: string | undefined;
|
|
7543
|
-
/**
|
|
7544
|
-
* <p>If set to true for a layout, this layout will be used by default to view data. If set to
|
|
7545
|
-
* false, then the layout will not be used by default, but it can be used to view data by
|
|
7546
|
-
* explicitly selecting it in the console.</p>
|
|
7547
|
-
* @public
|
|
7548
|
-
*/
|
|
7549
|
-
IsDefault?: boolean | undefined;
|
|
7550
|
-
/**
|
|
7551
|
-
* <p>The type of layout that can be used to view data under a Customer Profiles domain.</p>
|
|
7552
|
-
* @public
|
|
7553
|
-
*/
|
|
7554
|
-
LayoutType?: LayoutType | undefined;
|
|
7555
|
-
/**
|
|
7556
|
-
* <p>A customizable layout that can be used to view data under a Customer Profiles domain.</p>
|
|
7557
|
-
* @public
|
|
7558
|
-
*/
|
|
7559
|
-
Layout?: string | undefined;
|
|
7560
|
-
/**
|
|
7561
|
-
* <p>The version used to create layout.</p>
|
|
7562
|
-
* @public
|
|
7563
|
-
*/
|
|
7564
|
-
Version?: string | undefined;
|
|
7565
|
-
/**
|
|
7566
|
-
* <p>The timestamp of when the layout was created.</p>
|
|
7567
|
-
* @public
|
|
7568
|
-
*/
|
|
7569
|
-
CreatedAt?: Date | undefined;
|
|
7570
|
-
/**
|
|
7571
|
-
* <p>The timestamp of when the layout was most recently updated.</p>
|
|
7572
|
-
* @public
|
|
7573
|
-
*/
|
|
7574
|
-
LastUpdatedAt?: Date | undefined;
|
|
7575
|
-
/**
|
|
7576
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7577
|
-
* @public
|
|
7578
|
-
*/
|
|
7579
|
-
Tags?: Record<string, string> | undefined;
|
|
7580
|
-
}
|
|
7581
|
-
/**
|
|
7582
|
-
* @public
|
|
7583
|
-
*/
|
|
7584
|
-
export interface UpdateEventTriggerRequest {
|
|
7585
|
-
/**
|
|
7586
|
-
* <p>The unique name of the domain.</p>
|
|
7587
|
-
* @public
|
|
7588
|
-
*/
|
|
7589
|
-
DomainName: string | undefined;
|
|
7590
|
-
/**
|
|
7591
|
-
* <p>The unique name of the event trigger.</p>
|
|
7592
|
-
* @public
|
|
7593
|
-
*/
|
|
7594
|
-
EventTriggerName: string | undefined;
|
|
7595
|
-
/**
|
|
7596
|
-
* <p>The unique name of the object type.</p>
|
|
7597
|
-
* @public
|
|
7598
|
-
*/
|
|
7599
|
-
ObjectTypeName?: string | undefined;
|
|
7600
|
-
/**
|
|
7601
|
-
* <p>The description of the event trigger.</p>
|
|
7602
|
-
* @public
|
|
7603
|
-
*/
|
|
7604
|
-
Description?: string | undefined;
|
|
7605
|
-
/**
|
|
7606
|
-
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
7607
|
-
* @public
|
|
7608
|
-
*/
|
|
7609
|
-
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
7610
|
-
/**
|
|
7611
|
-
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
7612
|
-
* definition.</p>
|
|
7613
|
-
* @public
|
|
7614
|
-
*/
|
|
7615
|
-
SegmentFilter?: string | undefined;
|
|
7616
|
-
/**
|
|
7617
|
-
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion
|
|
7618
|
-
* latency and the number of invocations per profile over specific time periods.</p>
|
|
7619
|
-
* @public
|
|
7620
|
-
*/
|
|
7621
|
-
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
7622
|
-
}
|
|
7623
|
-
/**
|
|
7624
|
-
* @public
|
|
7625
|
-
*/
|
|
7626
|
-
export interface UpdateEventTriggerResponse {
|
|
7627
|
-
/**
|
|
7628
|
-
* <p>The unique name of the event trigger.</p>
|
|
7629
|
-
* @public
|
|
7630
|
-
*/
|
|
7631
|
-
EventTriggerName?: string | undefined;
|
|
7632
|
-
/**
|
|
7633
|
-
* <p>The unique name of the object type.</p>
|
|
7634
|
-
* @public
|
|
7635
|
-
*/
|
|
7636
|
-
ObjectTypeName?: string | undefined;
|
|
7637
|
-
/**
|
|
7638
|
-
* <p>The description of the event trigger.</p>
|
|
7639
|
-
* @public
|
|
7640
|
-
*/
|
|
7641
|
-
Description?: string | undefined;
|
|
7642
|
-
/**
|
|
7643
|
-
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
7644
|
-
* @public
|
|
7645
|
-
*/
|
|
7646
|
-
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
7647
|
-
/**
|
|
7648
|
-
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
7649
|
-
* definition.</p>
|
|
7650
|
-
* @public
|
|
7651
|
-
*/
|
|
7652
|
-
SegmentFilter?: string | undefined;
|
|
7653
|
-
/**
|
|
7654
|
-
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion
|
|
7655
|
-
* latency and the number of invocations per profile over specific time periods.</p>
|
|
7656
|
-
* @public
|
|
7657
|
-
*/
|
|
7658
|
-
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
7659
|
-
/**
|
|
7660
|
-
* <p>The timestamp of when the event trigger was created.</p>
|
|
7661
|
-
* @public
|
|
7662
|
-
*/
|
|
7663
|
-
CreatedAt?: Date | undefined;
|
|
7664
|
-
/**
|
|
7665
|
-
* <p>The timestamp of when the event trigger was most recently updated.</p>
|
|
7666
|
-
* @public
|
|
7667
|
-
*/
|
|
7668
|
-
LastUpdatedAt?: Date | undefined;
|
|
7669
|
-
/**
|
|
7670
|
-
* <p>An array of key-value pairs to apply to this resource.</p>
|
|
7671
|
-
* @public
|
|
7672
|
-
*/
|
|
7673
|
-
Tags?: Record<string, string> | undefined;
|
|
7674
|
-
}
|
|
7675
|
-
/**
|
|
7676
|
-
* <p>Updates associated with the address properties of a customer profile.</p>
|
|
7677
|
-
* @public
|
|
7678
|
-
*/
|
|
7679
|
-
export interface UpdateAddress {
|
|
7680
|
-
/**
|
|
7681
|
-
* <p>The first line of a customer address.</p>
|
|
7682
|
-
* @public
|
|
7683
|
-
*/
|
|
7684
|
-
Address1?: string | undefined;
|
|
7685
|
-
/**
|
|
7686
|
-
* <p>The second line of a customer address.</p>
|
|
7687
|
-
* @public
|
|
7688
|
-
*/
|
|
7689
|
-
Address2?: string | undefined;
|
|
7690
|
-
/**
|
|
7691
|
-
* <p>The third line of a customer address.</p>
|
|
7692
|
-
* @public
|
|
7693
|
-
*/
|
|
7694
|
-
Address3?: string | undefined;
|
|
7695
|
-
/**
|
|
7696
|
-
* <p>The fourth line of a customer address.</p>
|
|
7697
|
-
* @public
|
|
7698
|
-
*/
|
|
7699
|
-
Address4?: string | undefined;
|
|
7700
|
-
/**
|
|
7701
|
-
* <p>The city in which a customer lives.</p>
|
|
7702
|
-
* @public
|
|
7703
|
-
*/
|
|
7704
|
-
City?: string | undefined;
|
|
7705
|
-
/**
|
|
7706
|
-
* <p>The county in which a customer lives.</p>
|
|
7707
|
-
* @public
|
|
7708
|
-
*/
|
|
7709
|
-
County?: string | undefined;
|
|
7710
|
-
/**
|
|
7711
|
-
* <p>The state in which a customer lives.</p>
|
|
7712
|
-
* @public
|
|
7713
|
-
*/
|
|
7714
|
-
State?: string | undefined;
|
|
7715
|
-
/**
|
|
7716
|
-
* <p>The province in which a customer lives.</p>
|
|
7717
|
-
* @public
|
|
7718
|
-
*/
|
|
7719
|
-
Province?: string | undefined;
|
|
7720
|
-
/**
|
|
7721
|
-
* <p>The country in which a customer lives.</p>
|
|
7722
|
-
* @public
|
|
7723
|
-
*/
|
|
7724
|
-
Country?: string | undefined;
|
|
7725
|
-
/**
|
|
7726
|
-
* <p>The postal code of a customer address.</p>
|
|
7727
|
-
* @public
|
|
7728
|
-
*/
|
|
7729
|
-
PostalCode?: string | undefined;
|
|
7730
|
-
}
|
|
7731
|
-
/**
|
|
7732
|
-
* @public
|
|
7733
|
-
*/
|
|
7734
|
-
export interface UpdateProfileRequest {
|
|
7735
|
-
/**
|
|
7736
|
-
* <p>The unique name of the domain.</p>
|
|
7737
|
-
* @public
|
|
7738
|
-
*/
|
|
7739
|
-
DomainName: string | undefined;
|
|
7740
|
-
/**
|
|
7741
|
-
* <p>The unique identifier of a customer profile.</p>
|
|
7742
|
-
* @public
|
|
7743
|
-
*/
|
|
7744
|
-
ProfileId: string | undefined;
|
|
7745
|
-
/**
|
|
7746
|
-
* <p>Any additional information relevant to the customer’s profile.</p>
|
|
7747
|
-
* @public
|
|
7748
|
-
*/
|
|
7749
|
-
AdditionalInformation?: string | undefined;
|
|
7750
|
-
/**
|
|
7751
|
-
* <p>An account number that you have assigned to the customer.</p>
|
|
7752
|
-
* @public
|
|
7753
|
-
*/
|
|
7754
|
-
AccountNumber?: string | undefined;
|
|
7755
|
-
/**
|
|
7756
|
-
* <p>The type of profile used to describe the customer.</p>
|
|
7757
|
-
*
|
|
7758
|
-
* @deprecated deprecated
|
|
7759
|
-
* @public
|
|
7760
|
-
*/
|
|
7761
|
-
PartyType?: PartyType | undefined;
|
|
7762
|
-
/**
|
|
7763
|
-
* <p>The name of the customer’s business.</p>
|
|
7764
|
-
* @public
|
|
7765
|
-
*/
|
|
7766
|
-
BusinessName?: string | undefined;
|
|
7767
|
-
/**
|
|
7768
|
-
* <p>The customer’s first name.</p>
|
|
7769
|
-
* @public
|
|
7770
|
-
*/
|
|
7771
|
-
FirstName?: string | undefined;
|
|
7772
|
-
/**
|
|
7773
|
-
* <p>The customer’s middle name.</p>
|
|
7774
|
-
* @public
|
|
7775
|
-
*/
|
|
7776
|
-
MiddleName?: string | undefined;
|
|
7777
|
-
/**
|
|
7778
|
-
* <p>The customer’s last name.</p>
|
|
7779
|
-
* @public
|
|
7780
|
-
*/
|
|
7781
|
-
LastName?: string | undefined;
|
|
7782
|
-
/**
|
|
7783
|
-
* <p>The customer’s birth date. </p>
|
|
7784
|
-
* @public
|
|
7785
|
-
*/
|
|
7786
|
-
BirthDate?: string | undefined;
|
|
7787
|
-
/**
|
|
7788
|
-
* <p>The gender with which the customer identifies. </p>
|
|
7789
|
-
*
|
|
7790
|
-
* @deprecated deprecated
|
|
7791
|
-
* @public
|
|
7792
|
-
*/
|
|
7793
|
-
Gender?: Gender | undefined;
|
|
7794
|
-
/**
|
|
7795
|
-
* <p>The customer’s phone number, which has not been specified as a mobile, home, or business
|
|
7796
|
-
* number. </p>
|
|
7797
|
-
* @public
|
|
7798
|
-
*/
|
|
7799
|
-
PhoneNumber?: string | undefined;
|
|
7800
|
-
/**
|
|
7801
|
-
* <p>The customer’s mobile phone number.</p>
|
|
7802
|
-
* @public
|
|
7803
|
-
*/
|
|
7804
|
-
MobilePhoneNumber?: string | undefined;
|
|
7805
|
-
/**
|
|
7806
|
-
* <p>The customer’s home phone number.</p>
|
|
7807
|
-
* @public
|
|
7808
|
-
*/
|
|
7809
|
-
HomePhoneNumber?: string | undefined;
|
|
7810
|
-
/**
|
|
7811
|
-
* <p>The customer’s business phone number.</p>
|
|
7812
|
-
* @public
|
|
7813
|
-
*/
|
|
7814
|
-
BusinessPhoneNumber?: string | undefined;
|
|
7815
|
-
/**
|
|
7816
|
-
* <p>The customer’s email address, which has not been specified as a personal or business
|
|
7817
|
-
* address. </p>
|
|
7818
|
-
* @public
|
|
7819
|
-
*/
|
|
7820
|
-
EmailAddress?: string | undefined;
|
|
7821
|
-
/**
|
|
7822
|
-
* <p>The customer’s personal email address.</p>
|
|
7823
|
-
* @public
|
|
7824
|
-
*/
|
|
7825
|
-
PersonalEmailAddress?: string | undefined;
|
|
7826
|
-
/**
|
|
7827
|
-
* <p>The customer’s business email address.</p>
|
|
7828
|
-
* @public
|
|
7829
|
-
*/
|
|
7830
|
-
BusinessEmailAddress?: string | undefined;
|
|
7831
|
-
/**
|
|
7832
|
-
* <p>A generic address associated with the customer that is not mailing, shipping, or
|
|
7833
|
-
* billing.</p>
|
|
7834
|
-
* @public
|
|
7835
|
-
*/
|
|
7836
|
-
Address?: UpdateAddress | undefined;
|
|
7837
|
-
/**
|
|
7838
|
-
* <p>The customer’s shipping address.</p>
|
|
7839
|
-
* @public
|
|
7840
|
-
*/
|
|
7841
|
-
ShippingAddress?: UpdateAddress | undefined;
|
|
7842
|
-
/**
|
|
7843
|
-
* <p>The customer’s mailing address.</p>
|
|
7844
|
-
* @public
|
|
7845
|
-
*/
|
|
7846
|
-
MailingAddress?: UpdateAddress | undefined;
|
|
7847
|
-
/**
|
|
7848
|
-
* <p>The customer’s billing address.</p>
|
|
7849
|
-
* @public
|
|
7850
|
-
*/
|
|
7851
|
-
BillingAddress?: UpdateAddress | undefined;
|
|
7852
|
-
/**
|
|
7853
|
-
* <p>A key value pair of attributes of a customer profile.</p>
|
|
7854
|
-
* @public
|
|
7855
|
-
*/
|
|
7856
|
-
Attributes?: Record<string, string> | undefined;
|
|
7857
|
-
/**
|
|
7858
|
-
* <p>An alternative to <code>PartyType</code> which accepts any string as input.</p>
|
|
7859
|
-
* @public
|
|
7860
|
-
*/
|
|
7861
|
-
PartyTypeString?: string | undefined;
|
|
7862
|
-
/**
|
|
7863
|
-
* <p>An alternative to <code>Gender</code> which accepts any string as input.</p>
|
|
7864
|
-
* @public
|
|
7865
|
-
*/
|
|
7866
|
-
GenderString?: string | undefined;
|
|
7867
|
-
/**
|
|
7868
|
-
* <p>Determines the type of the profile.</p>
|
|
7869
|
-
* @public
|
|
7870
|
-
*/
|
|
7871
|
-
ProfileType?: ProfileType | undefined;
|
|
7872
|
-
/**
|
|
7873
|
-
* <p>Object that defines users preferred methods of engagement.</p>
|
|
7874
|
-
* @public
|
|
7875
|
-
*/
|
|
7876
|
-
EngagementPreferences?: EngagementPreferences | undefined;
|
|
7877
|
-
}
|
|
7878
|
-
/**
|
|
7879
|
-
* @public
|
|
7880
|
-
*/
|
|
7881
|
-
export interface UpdateProfileResponse {
|
|
7882
|
-
/**
|
|
7883
|
-
* <p>The unique identifier of a customer profile.</p>
|
|
7884
|
-
* @public
|
|
7885
|
-
*/
|
|
7886
|
-
ProfileId: string | undefined;
|
|
8232
|
+
RecommenderName: string | undefined;
|
|
7887
8233
|
}
|