@aws-sdk/client-customer-profiles 3.1120.0 → 3.1122.0

package/dist-types/models/models_1.d.ts

@@ -1,5 +1,299 @@
-import type { Gender, LayoutType, LogicalOperator, PartyType, ProfileType, ReadinessStatus, RecommenderSchemaStatus, Scope, SegmentType, Statistic, Status, StatusReason, UploadJobStatus, WorkflowType } from "./enums";
-import type { AdditionalSearchKey, AttributeDetails, Conditions, DataStoreRequest, DataStoreResponse, DomainObjectTypeField, EngagementPreferences, EventTriggerCondition, EventTriggerLimits, FlowDefinition, MatchingRequest, MatchingResponse, ObjectTypeField, ObjectTypeKey, Profile, Readiness, RecommenderConfig, RecommenderSchemaField, RuleBasedMatchingRequest, RuleBasedMatchingResponse } from "./models_0";
+import type { Gender, LayoutType, LogicalOperator, PartyType, ProfileType, ReadinessStatus, RecommenderFilterStatus, RecommenderRecipeName, RecommenderSchemaStatus, RecommenderStatus, Scope, SegmentSubscriptionStatus, SegmentType, Statistic, Status, StatusReason, SubscriptionEvent, SubscriptionEventType, UploadJobStatus, WorkflowType } from "./enums";
+import type { AdditionalSearchKey, AttributeDetails, Conditions, DataStoreRequest, DataStoreResponse, DomainObjectTypeField, EngagementPreferences, EventTriggerCondition, EventTriggerLimits, FlowDefinition, MatchingRequest, MatchingResponse, ObjectTypeField, ObjectTypeKey, Profile, Readiness, RecommenderConfig, RecommenderSchemaField, RecommenderUpdate, RuleBasedMatchingRequest, RuleBasedMatchingResponse, ScheduleConfiguration } from "./models_0";
+/**
+ * @public
+ */
+export interface ListProfileObjectTypeTemplatesRequest {
+    /**
+     * <p>The pagination token from the previous ListObjectTypeTemplates API call.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>The maximum number of objects returned per page.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+}
+/**
+ * <p>A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.</p>
+ * @public
+ */
+export interface ListProfileObjectTypeTemplateItem {
+    /**
+     * <p>A unique identifier for the object template.</p>
+     * @public
+     */
+    TemplateId?: string | undefined;
+    /**
+     * <p>The name of the source of the object template.</p>
+     * @public
+     */
+    SourceName?: string | undefined;
+    /**
+     * <p>The source of the object template.</p>
+     * @public
+     */
+    SourceObject?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListProfileObjectTypeTemplatesResponse {
+    /**
+     * <p>The list of ListProfileObjectType template instances.</p>
+     * @public
+     */
+    Items?: ListProfileObjectTypeTemplateItem[] | undefined;
+    /**
+     * <p>The pagination token from the previous ListObjectTypeTemplates API call. </p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRecommenderFiltersRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The maximum number of recommender filters to return in the response. The default value is 100.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>A token received from a previous ListRecommenderFilters call to retrieve the next page of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * <p>Provides a summary of a recommender filter's configuration and current state.</p>
+ * @public
+ */
+export interface RecommenderFilterSummary {
+    /**
+     * <p>The name of the recommender filter.</p>
+     * @public
+     */
+    RecommenderFilterName?: string | undefined;
+    /**
+     * <p>The name of the recommender schema associated with this recommender filter.</p>
+     * @public
+     */
+    RecommenderSchemaName?: string | undefined;
+    /**
+     * <p>The filter expression that defines which items to include or exclude from recommendations.</p>
+     * @public
+     */
+    RecommenderFilterExpression?: string | undefined;
+    /**
+     * <p>The timestamp when the recommender filter was created.</p>
+     * @public
+     */
+    CreatedAt?: Date | undefined;
+    /**
+     * <p>A description of the recommender filter's purpose and characteristics.</p>
+     * @public
+     */
+    Description?: string | undefined;
+    /**
+     * <p>The current operational status of the recommender filter.</p>
+     * @public
+     */
+    Status?: RecommenderFilterStatus | undefined;
+    /**
+     * <p>If the recommender filter is in a failed state, provides the reason for the failure.</p>
+     * @public
+     */
+    FailureReason?: string | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * @public
+     */
+    Tags?: Record<string, string> | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRecommenderFiltersResponse {
+    /**
+     * <p>A token to retrieve the next page of results. Null if there are no more results to retrieve.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>A list of recommender filters and their properties in the specified domain.</p>
+     * @public
+     */
+    RecommenderFilters?: RecommenderFilterSummary[] | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRecommenderRecipesRequest {
+    /**
+     * <p>The maximum number of recommender recipes to return in the response. The default value is 100.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>A token received from a previous ListRecommenderRecipes call to retrieve the next page of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * <p>Defines the algorithm and approach used to generate recommendations.</p>
+ * @public
+ */
+export interface RecommenderRecipe {
+    /**
+     * <p>The name of the recommender recipe.</p>
+     * @public
+     */
+    name?: RecommenderRecipeName | undefined;
+    /**
+     * <p>A description of the recommender recipe's purpose and functionality.</p>
+     * @public
+     */
+    description?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRecommenderRecipesResponse {
+    /**
+     * <p>A token to retrieve the next page of results. Null if there are no more results to retrieve.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>A list of available recommender recipes and their properties.</p>
+     * @public
+     */
+    RecommenderRecipes?: RecommenderRecipe[] | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRecommendersRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The maximum number of recommenders to return in the response. The default value is 100.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>A token received from a previous ListRecommenders call to retrieve the next page of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * <p>Provides a summary of a recommender's configuration and current state.</p>
+ * @public
+ */
+export interface RecommenderSummary {
+    /**
+     * <p>The name of the recommender.</p>
+     * @public
+     */
+    RecommenderName?: string | undefined;
+    /**
+     * <p>The name of the recipe used by this recommender.</p>
+     * @public
+     */
+    RecipeName?: RecommenderRecipeName | undefined;
+    /**
+     * <p>The name of the recommender schema associated with this recommender.</p>
+     * @public
+     */
+    RecommenderSchemaName?: string | undefined;
+    /**
+     * <p>The configuration settings applied to this recommender.</p>
+     * @public
+     */
+    RecommenderConfig?: RecommenderConfig | undefined;
+    /**
+     * <p>The timestamp when the recommender was created.</p>
+     * @public
+     */
+    CreatedAt?: Date | undefined;
+    /**
+     * <p>A description of the recommender's purpose and characteristics.</p>
+     * @public
+     */
+    Description?: string | undefined;
+    /**
+     * <p>The current operational status of the recommender.</p>
+     * @public
+     */
+    Status?: RecommenderStatus | undefined;
+    /**
+     * <p>The timestamp of when the recommender was edited.</p>
+     * @public
+     */
+    LastUpdatedAt?: Date | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * @public
+     */
+    Tags?: Record<string, string> | undefined;
+    /**
+     * <p>If the recommender is in a failed state, provides the reason for the failure.</p>
+     * @public
+     */
+    FailureReason?: string | undefined;
+    /**
+     * <p>Information about the most recent update performed on the recommender, including its status and timing.</p>
+     * @public
+     */
+    LatestRecommenderUpdate?: RecommenderUpdate | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRecommendersResponse {
+    /**
+     * <p>A token to retrieve the next page of results. Null if there are no more results to retrieve.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>A list of recommenders and their properties in the specified domain.</p>
+     * @public
+     */
+    Recommenders?: RecommenderSummary[] | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRecommenderSchemasRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The maximum number of recommender schemas to return in the response. The default value is 100.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>A token received from a previous ListRecommenderSchemas call to retrieve the next page of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
 /**
  * <p>Provides a summary of a recommender schema's configuration and current state.</p>
  * @public
@@ -157,6 +451,95 @@ export interface ListSegmentDefinitionsResponse {
      */
     Items?: SegmentDefinitionItem[] | undefined;
 }
+/**
+ * @public
+ */
+export interface ListSegmentSubscriptionEventsRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The unique name of the segment definition. </p>
+     * @public
+     */
+    SegmentDefinitionName: string | undefined;
+    /**
+     * <p>The maximum number of events to return per page. </p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>The pagination token from the previous call to retrieve the next page of results. </p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * <p>Represents a single segment membership event. </p>
+ * @public
+ */
+export interface SubscriptionEventItem {
+    /**
+     * <p>The unique identifier of a customer profile.</p>
+     * @public
+     */
+    ProfileId?: string | undefined;
+    /**
+     * <p>The timestamp of when the membership change was detected. </p>
+     * @public
+     */
+    UpdatedAt?: Date | undefined;
+    /**
+     * <p>The type of event that triggered the membership change. The following are valid values:
+     *       </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <b>LIVE</b>: Real-time event triggered by a profile or
+     *                calculated attribute change (Classic segments only). </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>SCHEDULE</b>: Event generated during a scheduled
+     *                execution. </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    EventType?: SubscriptionEventType | undefined;
+    /**
+     * <p>Whether the profile joined or left the segment. The following are valid values: </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <b>JOINED</b>: The profile joined the segment. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>LEFT</b>: The profile left the segment. </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    Event?: SubscriptionEvent | undefined;
+}
+/**
+ * @public
+ */
+export interface ListSegmentSubscriptionEventsResponse {
+    /**
+     * <p>A list of segment membership events. </p>
+     * @public
+     */
+    Events?: SubscriptionEventItem[] | undefined;
+    /**
+     * <p>The pagination token to use to retrieve the next page of results. </p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -903,6 +1286,67 @@ export interface PutProfileObjectTypeResponse {
      */
     Tags?: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
+export interface PutSegmentSubscriptionRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     * @public
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The unique name of the segment definition. </p>
+     * @public
+     */
+    SegmentDefinitionName: string | undefined;
+    /**
+     * <p>The optional schedule configuration that controls how often membership snapshots are run.
+     *          If not provided, the subscription defaults to a 24-hour interval. </p>
+     * @public
+     */
+    ScheduleConfiguration?: ScheduleConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface PutSegmentSubscriptionResponse {
+    /**
+     * <p>The current lifecycle status of the subscription. The following are valid values: </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <b>STARTING</b>: Initial snapshot is in progress. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>RUNNING</b>: Notifications are active and running.
+     *             </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>STOPPED</b>: Notifications have been stopped. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <b>FAILED</b>: Notifications failed (for example, the
+     *                Amazon Kinesis data stream became inaccessible). </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    Status?: SegmentSubscriptionStatus | undefined;
+    /**
+     * <p>The schedule configuration for the subscription, if configured. </p>
+     * @public
+     */
+    ScheduleConfiguration?: ScheduleConfiguration | undefined;
+    /**
+     * <p>The timestamp of when the subscription was started. </p>
+     * @public
+     */
+    StartedAt?: Date | undefined;
+}
 /**
  * @public
  */

package/dist-types/pagination/ListSegmentSubscriptionEventsPaginator.d.ts

@@ -0,0 +1,7 @@
+import type { Paginator } from "@smithy/types";
+import { ListSegmentSubscriptionEventsCommandInput, ListSegmentSubscriptionEventsCommandOutput } from "../commands/ListSegmentSubscriptionEventsCommand";
+import type { CustomerProfilesPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListSegmentSubscriptionEvents: (config: CustomerProfilesPaginationConfiguration, input: ListSegmentSubscriptionEventsCommandInput, ...rest: any[]) => Paginator<ListSegmentSubscriptionEventsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -11,4 +11,5 @@ export * from "./ListRecommendersPaginator";
 export * from "./ListRecommenderSchemasPaginator";
 export * from "./ListRuleBasedMatchesPaginator";
 export * from "./ListSegmentDefinitionsPaginator";
+export * from "./ListSegmentSubscriptionEventsPaginator";
 export * from "./ListUploadJobsPaginator";

package/dist-types/schemas/schemas_0.d.ts

@@ -21,6 +21,9 @@ export declare var AppflowIntegration$: StaticStructureSchema;
 export declare var AppflowIntegrationWorkflowAttributes$: StaticStructureSchema;
 export declare var AppflowIntegrationWorkflowMetrics$: StaticStructureSchema;
 export declare var AppflowIntegrationWorkflowStep$: StaticStructureSchema;
+export declare var AssociatedSegment$: StaticStructureSchema;
+export declare var AssociateStreamForSegmentsRequest$: StaticStructureSchema;
+export declare var AssociateStreamForSegmentsResponse$: StaticStructureSchema;
 export declare var AttributeDetails$: StaticStructureSchema;
 export declare var AttributeDimension$: StaticStructureSchema;
 export declare var AttributeItem$: StaticStructureSchema;
@@ -109,12 +112,16 @@ export declare var DeleteRecommenderSchemaRequest$: StaticStructureSchema;
 export declare var DeleteRecommenderSchemaResponse$: StaticStructureSchema;
 export declare var DeleteSegmentDefinitionRequest$: StaticStructureSchema;
 export declare var DeleteSegmentDefinitionResponse$: StaticStructureSchema;
+export declare var DeleteSegmentSubscriptionRequest$: StaticStructureSchema;
+export declare var DeleteSegmentSubscriptionResponse$: StaticStructureSchema;
 export declare var DeleteWorkflowRequest$: StaticStructureSchema;
 export declare var DeleteWorkflowResponse$: StaticStructureSchema;
 export declare var DestinationSummary$: StaticStructureSchema;
 export declare var DetectedProfileObjectType$: StaticStructureSchema;
 export declare var DetectProfileObjectTypeRequest$: StaticStructureSchema;
 export declare var DetectProfileObjectTypeResponse$: StaticStructureSchema;
+export declare var DisassociateStreamForSegmentsRequest$: StaticStructureSchema;
+export declare var DisassociateStreamForSegmentsResponse$: StaticStructureSchema;
 export declare var DiversityColumn$: StaticStructureSchema;
 export declare var DiversityConfig$: StaticStructureSchema;
 export declare var DomainObjectTypeField$: StaticStructureSchema;
@@ -187,8 +194,12 @@ export declare var GetSegmentMembershipRequest$: StaticStructureSchema;
 export declare var GetSegmentMembershipResponse$: StaticStructureSchema;
 export declare var GetSegmentSnapshotRequest$: StaticStructureSchema;
 export declare var GetSegmentSnapshotResponse$: StaticStructureSchema;
+export declare var GetSegmentSubscriptionRequest$: StaticStructureSchema;
+export declare var GetSegmentSubscriptionResponse$: StaticStructureSchema;
 export declare var GetSimilarProfilesRequest$: StaticStructureSchema;
 export declare var GetSimilarProfilesResponse$: StaticStructureSchema;
+export declare var GetStreamForSegmentsRequest$: StaticStructureSchema;
+export declare var GetStreamForSegmentsResponse$: StaticStructureSchema;
 export declare var GetUploadJobPathRequest$: StaticStructureSchema;
 export declare var GetUploadJobPathResponse$: StaticStructureSchema;
 export declare var GetUploadJobRequest$: StaticStructureSchema;
@@ -258,6 +269,8 @@ export declare var ListRuleBasedMatchesRequest$: StaticStructureSchema;
 export declare var ListRuleBasedMatchesResponse$: StaticStructureSchema;
 export declare var ListSegmentDefinitionsRequest$: StaticStructureSchema;
 export declare var ListSegmentDefinitionsResponse$: StaticStructureSchema;
+export declare var ListSegmentSubscriptionEventsRequest$: StaticStructureSchema;
+export declare var ListSegmentSubscriptionEventsResponse$: StaticStructureSchema;
 export declare var ListTagsForResourceRequest$: StaticStructureSchema;
 export declare var ListTagsForResourceResponse$: StaticStructureSchema;
 export declare var ListUploadJobsRequest$: StaticStructureSchema;
@@ -295,6 +308,8 @@ export declare var PutProfileObjectRequest$: StaticStructureSchema;
 export declare var PutProfileObjectResponse$: StaticStructureSchema;
 export declare var PutProfileObjectTypeRequest$: StaticStructureSchema;
 export declare var PutProfileObjectTypeResponse$: StaticStructureSchema;
+export declare var PutSegmentSubscriptionRequest$: StaticStructureSchema;
+export declare var PutSegmentSubscriptionResponse$: StaticStructureSchema;
 export declare var Range$: StaticStructureSchema;
 export declare var RangeOverride$: StaticStructureSchema;
 export declare var Readiness$: StaticStructureSchema;
@@ -316,6 +331,8 @@ export declare var S3ExportingConfig$: StaticStructureSchema;
 export declare var S3ExportingLocation$: StaticStructureSchema;
 export declare var S3SourceProperties$: StaticStructureSchema;
 export declare var SalesforceSourceProperties$: StaticStructureSchema;
+export declare var ScheduleConfiguration$: StaticStructureSchema;
+export declare var ScheduledExecutions$: StaticStructureSchema;
 export declare var ScheduledTriggerProperties$: StaticStructureSchema;
 export declare var SearchProfilesRequest$: StaticStructureSchema;
 export declare var SearchProfilesResponse$: StaticStructureSchema;
@@ -336,6 +353,7 @@ export declare var StopRecommenderRequest$: StaticStructureSchema;
 export declare var StopRecommenderResponse$: StaticStructureSchema;
 export declare var StopUploadJobRequest$: StaticStructureSchema;
 export declare var StopUploadJobResponse$: StaticStructureSchema;
+export declare var SubscriptionEventItem$: StaticStructureSchema;
 export declare var TagResourceRequest$: StaticStructureSchema;
 export declare var TagResourceResponse$: StaticStructureSchema;
 export declare var Task$: StaticStructureSchema;
@@ -366,6 +384,7 @@ export declare var WorkflowStepItem$: StaticStructureSchema;
 export declare var ZendeskSourceProperties$: StaticStructureSchema;
 export declare var Dimension$: StaticUnionSchema;
 export declare var AddProfileKey$: StaticOperationSchema;
+export declare var AssociateStreamForSegments$: StaticOperationSchema;
 export declare var BatchGetCalculatedAttributeForProfile$: StaticOperationSchema;
 export declare var BatchGetProfile$: StaticOperationSchema;
 export declare var BatchPutProfileObject$: StaticOperationSchema;
@@ -398,8 +417,10 @@ export declare var DeleteRecommender$: StaticOperationSchema;
 export declare var DeleteRecommenderFilter$: StaticOperationSchema;
 export declare var DeleteRecommenderSchema$: StaticOperationSchema;
 export declare var DeleteSegmentDefinition$: StaticOperationSchema;
+export declare var DeleteSegmentSubscription$: StaticOperationSchema;
 export declare var DeleteWorkflow$: StaticOperationSchema;
 export declare var DetectProfileObjectType$: StaticOperationSchema;
+export declare var DisassociateStreamForSegments$: StaticOperationSchema;
 export declare var GetAutoMergingPreview$: StaticOperationSchema;
 export declare var GetCalculatedAttributeDefinition$: StaticOperationSchema;
 export declare var GetCalculatedAttributeForProfile$: StaticOperationSchema;
@@ -423,7 +444,9 @@ export declare var GetSegmentDefinition$: StaticOperationSchema;
 export declare var GetSegmentEstimate$: StaticOperationSchema;
 export declare var GetSegmentMembership$: StaticOperationSchema;
 export declare var GetSegmentSnapshot$: StaticOperationSchema;
+export declare var GetSegmentSubscription$: StaticOperationSchema;
 export declare var GetSimilarProfiles$: StaticOperationSchema;
+export declare var GetStreamForSegments$: StaticOperationSchema;
 export declare var GetUploadJob$: StaticOperationSchema;
 export declare var GetUploadJobPath$: StaticOperationSchema;
 export declare var GetWorkflow$: StaticOperationSchema;
@@ -451,6 +474,7 @@ export declare var ListRecommenders$: StaticOperationSchema;
 export declare var ListRecommenderSchemas$: StaticOperationSchema;
 export declare var ListRuleBasedMatches$: StaticOperationSchema;
 export declare var ListSegmentDefinitions$: StaticOperationSchema;
+export declare var ListSegmentSubscriptionEvents$: StaticOperationSchema;
 export declare var ListTagsForResource$: StaticOperationSchema;
 export declare var ListUploadJobs$: StaticOperationSchema;
 export declare var ListWorkflows$: StaticOperationSchema;
@@ -459,6 +483,7 @@ export declare var PutDomainObjectType$: StaticOperationSchema;
 export declare var PutIntegration$: StaticOperationSchema;
 export declare var PutProfileObject$: StaticOperationSchema;
 export declare var PutProfileObjectType$: StaticOperationSchema;
+export declare var PutSegmentSubscription$: StaticOperationSchema;
 export declare var SearchProfiles$: StaticOperationSchema;
 export declare var StartRecommender$: StaticOperationSchema;
 export declare var StartUploadJob$: StaticOperationSchema;