@aws-sdk/client-customer-profiles 3.940.0 → 3.943.0

package/dist-types/ts3.4/models/models_0.d.ts

@@ -5,6 +5,7 @@ import {
   ComparisonOperator,
   ConflictResolvingModel,
   ContactType,
+  ContentType,
   DataFormat,
   DataPullMode,
   DateDimensionType,
@@ -12,6 +13,7 @@ import {
   EventStreamDestinationStatus,
   EventStreamState,
   EventTriggerLogicalOperator,
+  FeatureType,
   FieldContentType,
   FilterDimensionType,
   Gender,
@@ -32,10 +34,14 @@ import {
   QueryResult,
   RangeUnit,
   ReadinessStatus,
+  RecommenderRecipeName,
+  RecommenderStatus,
   RuleBasedMatchingStatus,
   S3ConnectorOperator,
   SalesforceConnectorOperator,
+  Scope,
   SegmentSnapshotStatus,
+  SegmentType,
   ServiceNowConnectorOperator,
   SourceConnectorType,
   StandardIdentifier,
@@ -44,6 +50,7 @@ import {
   StatusReason,
   StringDimensionType,
   TaskType,
+  TrainingMetricName,
   TriggerType,
   Type,
   Unit,
@@ -336,6 +343,21 @@ export interface ListCalculatedAttributeForProfileItem {
   Value?: string | undefined;
   LastObjectTimestamp?: Date | undefined;
 }
+export interface CatalogItem {
+  Id?: string | undefined;
+  Name?: string | undefined;
+  Code?: string | undefined;
+  Type?: string | undefined;
+  Category?: string | undefined;
+  Description?: string | undefined;
+  AdditionalInformation?: string | undefined;
+  ImageLink?: string | undefined;
+  Link?: string | undefined;
+  CreatedAt?: Date | undefined;
+  UpdatedAt?: Date | undefined;
+  Price?: string | undefined;
+  Attributes?: Record<string, string> | undefined;
+}
 export interface ValueRange {
   Start: number | undefined;
   End: number | undefined;
@@ -398,6 +420,9 @@ export interface CreateCalculatedAttributeDefinitionResponse {
   Readiness?: Readiness | undefined;
   Tags?: Record<string, string> | undefined;
 }
+export interface DataStoreRequest {
+  Enabled?: boolean | undefined;
+}
 export interface S3ExportingConfig {
   S3BucketName: string | undefined;
   S3KeyName?: string | undefined;
@@ -434,8 +459,13 @@ export interface CreateDomainRequest {
   DeadLetterQueueUrl?: string | undefined;
   Matching?: MatchingRequest | undefined;
   RuleBasedMatching?: RuleBasedMatchingRequest | undefined;
+  DataStore?: DataStoreRequest | undefined;
   Tags?: Record<string, string> | undefined;
 }
+export interface DataStoreResponse {
+  Enabled?: boolean | undefined;
+  Readiness?: Readiness | undefined;
+}
 export interface MatchingResponse {
   Enabled?: boolean | undefined;
   JobSchedule?: JobSchedule | undefined;
@@ -459,6 +489,7 @@ export interface CreateDomainResponse {
   DeadLetterQueueUrl?: string | undefined;
   Matching?: MatchingResponse | undefined;
   RuleBasedMatching?: RuleBasedMatchingResponse | undefined;
+  DataStore?: DataStoreResponse | undefined;
   CreatedAt: Date | undefined;
   LastUpdatedAt: Date | undefined;
   Tags?: Record<string, string> | undefined;
@@ -585,6 +616,29 @@ export interface CreateProfileRequest {
 export interface CreateProfileResponse {
   ProfileId: string | undefined;
 }
+export interface EventParameters {
+  EventType: string | undefined;
+  EventValueThreshold?: number | undefined;
+}
+export interface EventsConfig {
+  EventParametersList: EventParameters[] | undefined;
+}
+export interface RecommenderConfig {
+  EventsConfig: EventsConfig | undefined;
+  TrainingFrequency?: number | undefined;
+}
+export interface CreateRecommenderRequest {
+  DomainName: string | undefined;
+  RecommenderName: string | undefined;
+  RecommenderRecipeName: RecommenderRecipeName | undefined;
+  RecommenderConfig?: RecommenderConfig | undefined;
+  Description?: string | undefined;
+  Tags?: Record<string, string> | undefined;
+}
+export interface CreateRecommenderResponse {
+  RecommenderArn: string | undefined;
+  Tags?: Record<string, string> | undefined;
+}
 export interface ExtraLengthValueProfileDimension {
   DimensionType: StringDimensionType | undefined;
   Values: string[] | undefined;
@@ -667,7 +721,8 @@ export interface CreateSegmentDefinitionRequest {
   SegmentDefinitionName: string | undefined;
   DisplayName: string | undefined;
   Description?: string | undefined;
-  SegmentGroups: SegmentGroup | undefined;
+  SegmentGroups?: SegmentGroup | undefined;
+  SegmentSqlQuery?: string | undefined;
   Tags?: Record<string, string> | undefined;
 }
 export interface CreateSegmentDefinitionResponse {
@@ -684,7 +739,8 @@ export interface SegmentGroupStructure {
 }
 export interface CreateSegmentEstimateRequest {
   DomainName: string | undefined;
-  SegmentQuery: SegmentGroupStructure | undefined;
+  SegmentQuery?: SegmentGroupStructure | undefined;
+  SegmentSqlQuery?: string | undefined;
 }
 export interface CreateSegmentEstimateResponse {
   DomainName?: string | undefined;
@@ -735,6 +791,11 @@ export interface DeleteDomainLayoutRequest {
 export interface DeleteDomainLayoutResponse {
   Message: string | undefined;
 }
+export interface DeleteDomainObjectTypeRequest {
+  DomainName: string | undefined;
+  ObjectTypeName: string | undefined;
+}
+export interface DeleteDomainObjectTypeResponse {}
 export interface DeleteEventStreamRequest {
   DomainName: string | undefined;
   EventStreamName: string | undefined;
@@ -786,6 +847,11 @@ export interface DeleteProfileObjectTypeRequest {
 export interface DeleteProfileObjectTypeResponse {
   Message: string | undefined;
 }
+export interface DeleteRecommenderRequest {
+  DomainName: string | undefined;
+  RecommenderName: string | undefined;
+}
+export interface DeleteRecommenderResponse {}
 export interface DeleteSegmentDefinitionRequest {
   DomainName: string | undefined;
   SegmentDefinitionName: string | undefined;
@@ -874,6 +940,7 @@ export interface GetDomainResponse {
   Stats?: DomainStats | undefined;
   Matching?: MatchingResponse | undefined;
   RuleBasedMatching?: RuleBasedMatchingResponse | undefined;
+  DataStore?: DataStoreResponse | undefined;
   CreatedAt: Date | undefined;
   LastUpdatedAt: Date | undefined;
   Tags?: Record<string, string> | undefined;
@@ -894,6 +961,25 @@ export interface GetDomainLayoutResponse {
   LastUpdatedAt: Date | undefined;
   Tags?: Record<string, string> | undefined;
 }
+export interface GetDomainObjectTypeRequest {
+  DomainName: string | undefined;
+  ObjectTypeName: string | undefined;
+}
+export interface DomainObjectTypeField {
+  Source: string | undefined;
+  Target: string | undefined;
+  ContentType?: ContentType | undefined;
+  FeatureType?: FeatureType | undefined;
+}
+export interface GetDomainObjectTypeResponse {
+  ObjectTypeName: string | undefined;
+  Description?: string | undefined;
+  EncryptionKey?: string | undefined;
+  Fields?: Record<string, DomainObjectTypeField> | undefined;
+  CreatedAt?: Date | undefined;
+  LastUpdatedAt?: Date | undefined;
+  Tags?: Record<string, string> | undefined;
+}
 export interface GetEventStreamRequest {
   DomainName: string | undefined;
   EventStreamName: string | undefined;
@@ -973,6 +1059,7 @@ export interface GetIntegrationResponse {
   IsUnstructured?: boolean | undefined;
   RoleArn?: string | undefined;
   EventTriggerNames?: string[] | undefined;
+  Scope?: Scope | undefined;
 }
 export interface GetMatchesRequest {
   NextToken?: string | undefined;
@@ -990,6 +1077,29 @@ export interface GetMatchesResponse {
   PotentialMatches?: number | undefined;
   Matches?: MatchItem[] | undefined;
 }
+export interface GetObjectTypeAttributeStatisticsRequest {
+  DomainName: string | undefined;
+  ObjectTypeName: string | undefined;
+  AttributeName: string | undefined;
+}
+export interface GetObjectTypeAttributeStatisticsPercentiles {
+  P5: number | undefined;
+  P25: number | undefined;
+  P50: number | undefined;
+  P75: number | undefined;
+  P95: number | undefined;
+}
+export interface GetObjectTypeAttributeStatisticsStats {
+  Maximum: number | undefined;
+  Minimum: number | undefined;
+  Average: number | undefined;
+  StandardDeviation: number | undefined;
+  Percentiles: GetObjectTypeAttributeStatisticsPercentiles | undefined;
+}
+export interface GetObjectTypeAttributeStatisticsResponse {
+  Statistics: GetObjectTypeAttributeStatisticsStats | undefined;
+  CalculatedAt: Date | undefined;
+}
 export interface GetProfileHistoryRecordRequest {
   DomainName: string | undefined;
   ProfileId: string | undefined;
@@ -1037,6 +1147,49 @@ export interface GetProfileObjectTypeTemplateResponse {
   Fields?: Record<string, ObjectTypeField> | undefined;
   Keys?: Record<string, ObjectTypeKey[]> | undefined;
 }
+export interface GetProfileRecommendationsRequest {
+  DomainName: string | undefined;
+  ProfileId: string | undefined;
+  RecommenderName: string | undefined;
+  Context?: Record<string, string> | undefined;
+  MaxResults?: number | undefined;
+}
+export interface Recommendation {
+  CatalogItem?: CatalogItem | undefined;
+  Score?: number | undefined;
+}
+export interface GetProfileRecommendationsResponse {
+  Recommendations?: Recommendation[] | undefined;
+}
+export interface GetRecommenderRequest {
+  DomainName: string | undefined;
+  RecommenderName: string | undefined;
+  TrainingMetricsCount?: number | undefined;
+}
+export interface RecommenderUpdate {
+  RecommenderConfig?: RecommenderConfig | undefined;
+  Status?: RecommenderStatus | undefined;
+  CreatedAt?: Date | undefined;
+  LastUpdatedAt?: Date | undefined;
+  FailureReason?: string | undefined;
+}
+export interface TrainingMetrics {
+  Time?: Date | undefined;
+  Metrics?: Partial<Record<TrainingMetricName, number>> | undefined;
+}
+export interface GetRecommenderResponse {
+  RecommenderName: string | undefined;
+  RecommenderRecipeName: RecommenderRecipeName | undefined;
+  RecommenderConfig?: RecommenderConfig | undefined;
+  Description?: string | undefined;
+  Status?: RecommenderStatus | undefined;
+  LastUpdatedAt?: Date | undefined;
+  CreatedAt?: Date | undefined;
+  FailureReason?: string | undefined;
+  LatestRecommenderUpdate?: RecommenderUpdate | undefined;
+  TrainingMetrics?: TrainingMetrics[] | undefined;
+  Tags?: Record<string, string> | undefined;
+}
 export interface GetSegmentDefinitionRequest {
   DomainName: string | undefined;
   SegmentDefinitionName: string | undefined;
@@ -1049,6 +1202,8 @@ export interface GetSegmentDefinitionResponse {
   SegmentDefinitionArn: string | undefined;
   CreatedAt?: Date | undefined;
   Tags?: Record<string, string> | undefined;
+  SegmentSqlQuery?: string | undefined;
+  SegmentType?: SegmentType | undefined;
 }
 export interface GetSegmentEstimateRequest {
   DomainName: string | undefined;
@@ -1081,6 +1236,7 @@ export interface GetSegmentMembershipResponse {
   SegmentDefinitionName?: string | undefined;
   Profiles?: ProfileQueryResult[] | undefined;
   Failures?: ProfileQueryFailures[] | undefined;
+  LastComputedAt?: Date | undefined;
 }
 export interface GetSegmentSnapshotRequest {
   DomainName: string | undefined;
@@ -1195,6 +1351,7 @@ export interface ListIntegrationItem {
   IsUnstructured?: boolean | undefined;
   RoleArn?: string | undefined;
   EventTriggerNames?: string[] | undefined;
+  Scope?: Scope | undefined;
 }
 export interface ListAccountIntegrationsResponse {
   Items?: ListIntegrationItem[] | undefined;
@@ -1238,6 +1395,22 @@ export interface ListDomainLayoutsResponse {
   Items?: LayoutItem[] | undefined;
   NextToken?: string | undefined;
 }
+export interface ListDomainObjectTypesRequest {
+  DomainName: string | undefined;
+  MaxResults?: number | undefined;
+  NextToken?: string | undefined;
+}
+export interface DomainObjectTypesListItem {
+  ObjectTypeName: string | undefined;
+  Description?: string | undefined;
+  CreatedAt?: Date | undefined;
+  LastUpdatedAt?: Date | undefined;
+  Tags?: Record<string, string> | undefined;
+}
+export interface ListDomainObjectTypesResponse {
+  Items?: DomainObjectTypesListItem[] | undefined;
+  NextToken?: string | undefined;
+}
 export interface ListDomainsRequest {
   NextToken?: string | undefined;
   MaxResults?: number | undefined;
@@ -1335,6 +1508,21 @@ export interface ListObjectTypeAttributesResponse {
   Items?: ListObjectTypeAttributeItem[] | undefined;
   NextToken?: string | undefined;
 }
+export interface ListObjectTypeAttributeValuesRequest {
+  NextToken?: string | undefined;
+  MaxResults?: number | undefined;
+  DomainName: string | undefined;
+  ObjectTypeName: string | undefined;
+  AttributeName: string | undefined;
+}
+export interface ListObjectTypeAttributeValuesItem {
+  Value: string | undefined;
+  LastUpdatedAt: Date | undefined;
+}
+export interface ListObjectTypeAttributeValuesResponse {
+  Items?: ListObjectTypeAttributeValuesItem[] | undefined;
+  NextToken?: string | undefined;
+}
 export interface ProfileAttributeValuesRequest {
   DomainName: string | undefined;
   AttributeName: string | undefined;
@@ -1419,6 +1607,39 @@ export interface ListProfileObjectTypeTemplatesResponse {
   Items?: ListProfileObjectTypeTemplateItem[] | undefined;
   NextToken?: string | undefined;
 }
+export interface ListRecommenderRecipesRequest {
+  MaxResults?: number | undefined;
+  NextToken?: string | undefined;
+}
+export interface RecommenderRecipe {
+  name?: RecommenderRecipeName | undefined;
+  description?: string | undefined;
+}
+export interface ListRecommenderRecipesResponse {
+  NextToken?: string | undefined;
+  RecommenderRecipes?: RecommenderRecipe[] | undefined;
+}
+export interface ListRecommendersRequest {
+  DomainName: string | undefined;
+  MaxResults?: number | undefined;
+  NextToken?: string | undefined;
+}
+export interface RecommenderSummary {
+  RecommenderName?: string | undefined;
+  RecipeName?: RecommenderRecipeName | undefined;
+  RecommenderConfig?: RecommenderConfig | undefined;
+  CreatedAt?: Date | undefined;
+  Description?: string | undefined;
+  Status?: RecommenderStatus | undefined;
+  LastUpdatedAt?: Date | undefined;
+  Tags?: Record<string, string> | undefined;
+  FailureReason?: string | undefined;
+  LatestRecommenderUpdate?: RecommenderUpdate | undefined;
+}
+export interface ListRecommendersResponse {
+  NextToken?: string | undefined;
+  Recommenders?: RecommenderSummary[] | undefined;
+}
 export interface ListRuleBasedMatchesRequest {
   NextToken?: string | undefined;
   MaxResults?: number | undefined;
@@ -1440,6 +1661,7 @@ export interface SegmentDefinitionItem {
   SegmentDefinitionArn?: string | undefined;
   CreatedAt?: Date | undefined;
   Tags?: Record<string, string> | undefined;
+  SegmentType?: SegmentType | undefined;
 }
 export interface ListSegmentDefinitionsResponse {
   NextToken?: string | undefined;
@@ -1524,15 +1746,33 @@ export interface MergeProfilesRequest {
 export interface MergeProfilesResponse {
   Message?: string | undefined;
 }
+export interface PutDomainObjectTypeRequest {
+  DomainName: string | undefined;
+  ObjectTypeName: string | undefined;
+  Description?: string | undefined;
+  EncryptionKey?: string | undefined;
+  Fields: Record<string, DomainObjectTypeField> | undefined;
+  Tags?: Record<string, string> | undefined;
+}
+export interface PutDomainObjectTypeResponse {
+  ObjectTypeName?: string | undefined;
+  Description?: string | undefined;
+  EncryptionKey?: string | undefined;
+  Fields?: Record<string, DomainObjectTypeField> | undefined;
+  CreatedAt?: Date | undefined;
+  LastUpdatedAt?: Date | undefined;
+  Tags?: Record<string, string> | undefined;
+}
 export interface PutIntegrationRequest {
   DomainName: string | undefined;
   Uri?: string | undefined;
   ObjectTypeName?: string | undefined;
+  ObjectTypeNames?: Record<string, string> | undefined;
   Tags?: Record<string, string> | undefined;
   FlowDefinition?: FlowDefinition | undefined;
-  ObjectTypeNames?: Record<string, string> | undefined;
   RoleArn?: string | undefined;
   EventTriggerNames?: string[] | undefined;
+  Scope?: Scope | undefined;
 }
 export interface PutIntegrationResponse {
   DomainName: string | undefined;
@@ -1546,6 +1786,7 @@ export interface PutIntegrationResponse {
   IsUnstructured?: boolean | undefined;
   RoleArn?: string | undefined;
   EventTriggerNames?: string[] | undefined;
+  Scope?: Scope | undefined;
 }
 export interface PutProfileObjectRequest {
   ObjectTypeName: string | undefined;
@@ -1598,149 +1839,17 @@ export interface SearchProfilesResponse {
   Items?: Profile[] | undefined;
   NextToken?: string | undefined;
 }
-export interface StartUploadJobRequest {
+export interface StartRecommenderRequest {
   DomainName: string | undefined;
-  JobId: string | undefined;
+  RecommenderName: string | undefined;
 }
-export interface StartUploadJobResponse {}
-export interface StopUploadJobRequest {
+export interface StartRecommenderResponse {}
+export interface StartUploadJobRequest {
   DomainName: string | undefined;
   JobId: string | undefined;
 }
-export interface StopUploadJobResponse {}
-export interface TagResourceRequest {
-  resourceArn: string | undefined;
-  tags: Record<string, string> | undefined;
-}
-export interface TagResourceResponse {}
-export interface UntagResourceRequest {
-  resourceArn: string | undefined;
-  tagKeys: string[] | undefined;
-}
-export interface UntagResourceResponse {}
-export interface UpdateCalculatedAttributeDefinitionRequest {
-  DomainName: string | undefined;
-  CalculatedAttributeName: string | undefined;
-  DisplayName?: string | undefined;
-  Description?: string | undefined;
-  Conditions?: Conditions | undefined;
-}
-export interface UpdateCalculatedAttributeDefinitionResponse {
-  CalculatedAttributeName?: string | undefined;
-  DisplayName?: string | undefined;
-  Description?: string | undefined;
-  CreatedAt?: Date | undefined;
-  LastUpdatedAt?: Date | undefined;
-  Statistic?: Statistic | undefined;
-  Conditions?: Conditions | undefined;
-  AttributeDetails?: AttributeDetails | undefined;
-  UseHistoricalData?: boolean | undefined;
-  Status?: ReadinessStatus | undefined;
-  Readiness?: Readiness | undefined;
-  Tags?: Record<string, string> | undefined;
-}
-export interface UpdateDomainRequest {
-  DomainName: string | undefined;
-  DefaultExpirationDays?: number | undefined;
-  DefaultEncryptionKey?: string | undefined;
-  DeadLetterQueueUrl?: string | undefined;
-  Matching?: MatchingRequest | undefined;
-  RuleBasedMatching?: RuleBasedMatchingRequest | undefined;
-  Tags?: Record<string, string> | undefined;
-}
-export interface UpdateDomainResponse {
-  DomainName: string | undefined;
-  DefaultExpirationDays?: number | undefined;
-  DefaultEncryptionKey?: string | undefined;
-  DeadLetterQueueUrl?: string | undefined;
-  Matching?: MatchingResponse | undefined;
-  RuleBasedMatching?: RuleBasedMatchingResponse | undefined;
-  CreatedAt: Date | undefined;
-  LastUpdatedAt: Date | undefined;
-  Tags?: Record<string, string> | undefined;
-}
-export interface UpdateDomainLayoutRequest {
-  DomainName: string | undefined;
-  LayoutDefinitionName: string | undefined;
-  Description?: string | undefined;
-  DisplayName?: string | undefined;
-  IsDefault?: boolean | undefined;
-  LayoutType?: LayoutType | undefined;
-  Layout?: string | undefined;
-}
-export interface UpdateDomainLayoutResponse {
-  LayoutDefinitionName?: string | undefined;
-  Description?: string | undefined;
-  DisplayName?: string | undefined;
-  IsDefault?: boolean | undefined;
-  LayoutType?: LayoutType | undefined;
-  Layout?: string | undefined;
-  Version?: string | undefined;
-  CreatedAt?: Date | undefined;
-  LastUpdatedAt?: Date | undefined;
-  Tags?: Record<string, string> | undefined;
-}
-export interface UpdateEventTriggerRequest {
-  DomainName: string | undefined;
-  EventTriggerName: string | undefined;
-  ObjectTypeName?: string | undefined;
-  Description?: string | undefined;
-  EventTriggerConditions?: EventTriggerCondition[] | undefined;
-  SegmentFilter?: string | undefined;
-  EventTriggerLimits?: EventTriggerLimits | undefined;
-}
-export interface UpdateEventTriggerResponse {
-  EventTriggerName?: string | undefined;
-  ObjectTypeName?: string | undefined;
-  Description?: string | undefined;
-  EventTriggerConditions?: EventTriggerCondition[] | undefined;
-  SegmentFilter?: string | undefined;
-  EventTriggerLimits?: EventTriggerLimits | undefined;
-  CreatedAt?: Date | undefined;
-  LastUpdatedAt?: Date | undefined;
-  Tags?: Record<string, string> | undefined;
-}
-export interface UpdateAddress {
-  Address1?: string | undefined;
-  Address2?: string | undefined;
-  Address3?: string | undefined;
-  Address4?: string | undefined;
-  City?: string | undefined;
-  County?: string | undefined;
-  State?: string | undefined;
-  Province?: string | undefined;
-  Country?: string | undefined;
-  PostalCode?: string | undefined;
-}
-export interface UpdateProfileRequest {
+export interface StartUploadJobResponse {}
+export interface StopRecommenderRequest {
   DomainName: string | undefined;
-  ProfileId: string | undefined;
-  AdditionalInformation?: string | undefined;
-  AccountNumber?: string | undefined;
-  PartyType?: PartyType | undefined;
-  BusinessName?: string | undefined;
-  FirstName?: string | undefined;
-  MiddleName?: string | undefined;
-  LastName?: string | undefined;
-  BirthDate?: string | undefined;
-  Gender?: Gender | undefined;
-  PhoneNumber?: string | undefined;
-  MobilePhoneNumber?: string | undefined;
-  HomePhoneNumber?: string | undefined;
-  BusinessPhoneNumber?: string | undefined;
-  EmailAddress?: string | undefined;
-  PersonalEmailAddress?: string | undefined;
-  BusinessEmailAddress?: string | undefined;
-  Address?: UpdateAddress | undefined;
-  ShippingAddress?: UpdateAddress | undefined;
-  MailingAddress?: UpdateAddress | undefined;
-  BillingAddress?: UpdateAddress | undefined;
-  Attributes?: Record<string, string> | undefined;
-  PartyTypeString?: string | undefined;
-  GenderString?: string | undefined;
-  ProfileType?: ProfileType | undefined;
-  EngagementPreferences?: EngagementPreferences | undefined;
-}
-export interface UpdateProfileResponse {
-  ProfileId: string | undefined;
+  RecommenderName: string | undefined;
 }