@aws-sdk/client-customer-profiles 3.696.0 → 3.703.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 +40 -0
- package/dist-cjs/index.js +357 -0
- package/dist-es/CustomerProfiles.js +10 -0
- package/dist-es/commands/CreateEventTriggerCommand.js +23 -0
- package/dist-es/commands/DeleteEventTriggerCommand.js +22 -0
- package/dist-es/commands/GetEventTriggerCommand.js +23 -0
- package/dist-es/commands/ListEventTriggersCommand.js +23 -0
- package/dist-es/commands/UpdateEventTriggerCommand.js +23 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +57 -0
- package/dist-es/pagination/ListEventTriggersPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +189 -0
- package/dist-types/CustomerProfiles.d.ts +35 -0
- package/dist-types/CustomerProfilesClient.d.ts +7 -2
- package/dist-types/commands/CreateEventTriggerCommand.d.ts +164 -0
- package/dist-types/commands/DeleteEventTriggerCommand.d.ts +90 -0
- package/dist-types/commands/GetEventTriggerCommand.d.ts +125 -0
- package/dist-types/commands/GetIntegrationCommand.d.ts +3 -0
- package/dist-types/commands/ListAccountIntegrationsCommand.d.ts +3 -0
- package/dist-types/commands/ListEventTriggersCommand.d.ts +100 -0
- package/dist-types/commands/ListIntegrationsCommand.d.ts +3 -0
- package/dist-types/commands/PutIntegrationCommand.d.ts +6 -0
- package/dist-types/commands/UpdateEventTriggerCommand.d.ts +158 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +585 -19
- package/dist-types/pagination/ListEventTriggersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +85 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateEventTriggerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteEventTriggerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetEventTriggerCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListEventTriggersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateEventTriggerCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +158 -0
- package/dist-types/ts3.4/pagination/ListEventTriggersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +4 -4
|
@@ -1053,7 +1053,8 @@ export declare const FilterDimensionType: {
|
|
|
1053
1053
|
*/
|
|
1054
1054
|
export type FilterDimensionType = (typeof FilterDimensionType)[keyof typeof FilterDimensionType];
|
|
1055
1055
|
/**
|
|
1056
|
-
* <p>Object that defines how to filter the incoming objects for the calculated
|
|
1056
|
+
* <p>Object that defines how to filter the incoming objects for the calculated
|
|
1057
|
+
* attribute.</p>
|
|
1057
1058
|
* @public
|
|
1058
1059
|
*/
|
|
1059
1060
|
export interface FilterAttributeDimension {
|
|
@@ -1305,7 +1306,8 @@ export interface RangeOverride {
|
|
|
1305
1306
|
*/
|
|
1306
1307
|
export interface ConditionOverrides {
|
|
1307
1308
|
/**
|
|
1308
|
-
* <p>The relative time period over which data is included in the aggregation for this
|
|
1309
|
+
* <p>The relative time period over which data is included in the aggregation for this
|
|
1310
|
+
* override.</p>
|
|
1309
1311
|
* @public
|
|
1310
1312
|
*/
|
|
1311
1313
|
Range?: RangeOverride | undefined;
|
|
@@ -1330,7 +1332,8 @@ export interface BatchGetCalculatedAttributeForProfileRequest {
|
|
|
1330
1332
|
*/
|
|
1331
1333
|
ProfileIds: string[] | undefined;
|
|
1332
1334
|
/**
|
|
1333
|
-
* <p>Overrides the condition block within the original calculated attribute
|
|
1335
|
+
* <p>Overrides the condition block within the original calculated attribute
|
|
1336
|
+
* definition.</p>
|
|
1334
1337
|
* @public
|
|
1335
1338
|
*/
|
|
1336
1339
|
ConditionOverrides?: ConditionOverrides | undefined;
|
|
@@ -1351,7 +1354,8 @@ export interface CalculatedAttributeValue {
|
|
|
1351
1354
|
*/
|
|
1352
1355
|
DisplayName?: string | undefined;
|
|
1353
1356
|
/**
|
|
1354
|
-
* <p>Indicates whether the calculated attribute's value is based on partial data. If the data
|
|
1357
|
+
* <p>Indicates whether the calculated attribute's value is based on partial data. If the data
|
|
1358
|
+
* is partial, it is set to true.</p>
|
|
1355
1359
|
* @public
|
|
1356
1360
|
*/
|
|
1357
1361
|
IsDataPartial?: string | undefined;
|
|
@@ -1402,7 +1406,8 @@ export interface BatchGetCalculatedAttributeForProfileResponse {
|
|
|
1402
1406
|
*/
|
|
1403
1407
|
CalculatedAttributeValues?: CalculatedAttributeValue[] | undefined;
|
|
1404
1408
|
/**
|
|
1405
|
-
* <p>Overrides the condition block within the original calculated attribute
|
|
1409
|
+
* <p>Overrides the condition block within the original calculated attribute
|
|
1410
|
+
* definition.</p>
|
|
1406
1411
|
* @public
|
|
1407
1412
|
*/
|
|
1408
1413
|
ConditionOverrides?: ConditionOverrides | undefined;
|
|
@@ -1652,7 +1657,8 @@ export interface Profile {
|
|
|
1652
1657
|
*/
|
|
1653
1658
|
export interface BatchGetProfileResponse {
|
|
1654
1659
|
/**
|
|
1655
|
-
* <p>For information about the errors that are common to all actions, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/CommonErrors.html">Common
|
|
1660
|
+
* <p>For information about the errors that are common to all actions, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/CommonErrors.html">Common
|
|
1661
|
+
* Errors</a>.</p>
|
|
1656
1662
|
* @public
|
|
1657
1663
|
*/
|
|
1658
1664
|
Errors?: BatchGetProfileError[] | undefined;
|
|
@@ -1747,6 +1753,31 @@ export interface ListCalculatedAttributeForProfileItem {
|
|
|
1747
1753
|
*/
|
|
1748
1754
|
Value?: string | undefined;
|
|
1749
1755
|
}
|
|
1756
|
+
/**
|
|
1757
|
+
* @public
|
|
1758
|
+
* @enum
|
|
1759
|
+
*/
|
|
1760
|
+
export declare const ComparisonOperator: {
|
|
1761
|
+
readonly AFTER: "AFTER";
|
|
1762
|
+
readonly BEFORE: "BEFORE";
|
|
1763
|
+
readonly BEGINS_WITH: "BEGINS_WITH";
|
|
1764
|
+
readonly BETWEEN: "BETWEEN";
|
|
1765
|
+
readonly CONTAINS: "CONTAINS";
|
|
1766
|
+
readonly ENDS_WITH: "ENDS_WITH";
|
|
1767
|
+
readonly EQUAL: "EQUAL";
|
|
1768
|
+
readonly EXCLUSIVE: "EXCLUSIVE";
|
|
1769
|
+
readonly GREATER_THAN: "GREATER_THAN";
|
|
1770
|
+
readonly GREATER_THAN_OR_EQUAL: "GREATER_THAN_OR_EQUAL";
|
|
1771
|
+
readonly INCLUSIVE: "INCLUSIVE";
|
|
1772
|
+
readonly LESS_THAN: "LESS_THAN";
|
|
1773
|
+
readonly LESS_THAN_OR_EQUAL: "LESS_THAN_OR_EQUAL";
|
|
1774
|
+
readonly NOT_BETWEEN: "NOT_BETWEEN";
|
|
1775
|
+
readonly ON: "ON";
|
|
1776
|
+
};
|
|
1777
|
+
/**
|
|
1778
|
+
* @public
|
|
1779
|
+
*/
|
|
1780
|
+
export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator];
|
|
1750
1781
|
/**
|
|
1751
1782
|
* @public
|
|
1752
1783
|
* @enum
|
|
@@ -1885,7 +1916,8 @@ export type Include = (typeof Include)[keyof typeof Include];
|
|
|
1885
1916
|
*/
|
|
1886
1917
|
export interface Filter {
|
|
1887
1918
|
/**
|
|
1888
|
-
* <p>Define whether to include or exclude objects for Calculated Attributed calculation that
|
|
1919
|
+
* <p>Define whether to include or exclude objects for Calculated Attributed calculation that
|
|
1920
|
+
* fit the filter groups criteria.</p>
|
|
1889
1921
|
* @public
|
|
1890
1922
|
*/
|
|
1891
1923
|
Include: Include | undefined;
|
|
@@ -1950,7 +1982,8 @@ export interface CreateCalculatedAttributeDefinitionRequest {
|
|
|
1950
1982
|
*/
|
|
1951
1983
|
Conditions?: Conditions | undefined;
|
|
1952
1984
|
/**
|
|
1953
|
-
* <p>Defines how to filter incoming objects to include part of the Calculated
|
|
1985
|
+
* <p>Defines how to filter incoming objects to include part of the Calculated
|
|
1986
|
+
* Attribute.</p>
|
|
1954
1987
|
* @public
|
|
1955
1988
|
*/
|
|
1956
1989
|
Filter?: Filter | undefined;
|
|
@@ -2514,6 +2547,227 @@ export interface CreateEventStreamResponse {
|
|
|
2514
2547
|
*/
|
|
2515
2548
|
Tags?: Record<string, string> | undefined;
|
|
2516
2549
|
}
|
|
2550
|
+
/**
|
|
2551
|
+
* <p>The criteria that a specific object attribute must meet to trigger the destination.</p>
|
|
2552
|
+
* @public
|
|
2553
|
+
*/
|
|
2554
|
+
export interface ObjectAttribute {
|
|
2555
|
+
/**
|
|
2556
|
+
* <p>An attribute contained within a source object.</p>
|
|
2557
|
+
* @public
|
|
2558
|
+
*/
|
|
2559
|
+
Source?: string | undefined;
|
|
2560
|
+
/**
|
|
2561
|
+
* <p>A field defined within an object type.</p>
|
|
2562
|
+
* @public
|
|
2563
|
+
*/
|
|
2564
|
+
FieldName?: string | undefined;
|
|
2565
|
+
/**
|
|
2566
|
+
* <p>The operator used to compare an attribute against a list of values.</p>
|
|
2567
|
+
* @public
|
|
2568
|
+
*/
|
|
2569
|
+
ComparisonOperator: ComparisonOperator | undefined;
|
|
2570
|
+
/**
|
|
2571
|
+
* <p>A list of attribute values used for comparison.</p>
|
|
2572
|
+
* @public
|
|
2573
|
+
*/
|
|
2574
|
+
Values: string[] | undefined;
|
|
2575
|
+
}
|
|
2576
|
+
/**
|
|
2577
|
+
* <p>A specific event dimension to be assessed.</p>
|
|
2578
|
+
* @public
|
|
2579
|
+
*/
|
|
2580
|
+
export interface EventTriggerDimension {
|
|
2581
|
+
/**
|
|
2582
|
+
* <p>A list of object attributes to be evaluated.</p>
|
|
2583
|
+
* @public
|
|
2584
|
+
*/
|
|
2585
|
+
ObjectAttributes: ObjectAttribute[] | undefined;
|
|
2586
|
+
}
|
|
2587
|
+
/**
|
|
2588
|
+
* @public
|
|
2589
|
+
* @enum
|
|
2590
|
+
*/
|
|
2591
|
+
export declare const EventTriggerLogicalOperator: {
|
|
2592
|
+
readonly ALL: "ALL";
|
|
2593
|
+
readonly ANY: "ANY";
|
|
2594
|
+
readonly NONE: "NONE";
|
|
2595
|
+
};
|
|
2596
|
+
/**
|
|
2597
|
+
* @public
|
|
2598
|
+
*/
|
|
2599
|
+
export type EventTriggerLogicalOperator = (typeof EventTriggerLogicalOperator)[keyof typeof EventTriggerLogicalOperator];
|
|
2600
|
+
/**
|
|
2601
|
+
* <p>Specifies the circumstances under which the event should trigger the destination.</p>
|
|
2602
|
+
* @public
|
|
2603
|
+
*/
|
|
2604
|
+
export interface EventTriggerCondition {
|
|
2605
|
+
/**
|
|
2606
|
+
* <p>A list of dimensions to be evaluated for the event.</p>
|
|
2607
|
+
* @public
|
|
2608
|
+
*/
|
|
2609
|
+
EventTriggerDimensions: EventTriggerDimension[] | undefined;
|
|
2610
|
+
/**
|
|
2611
|
+
* <p>The operator used to combine multiple dimensions.</p>
|
|
2612
|
+
* @public
|
|
2613
|
+
*/
|
|
2614
|
+
LogicalOperator: EventTriggerLogicalOperator | undefined;
|
|
2615
|
+
}
|
|
2616
|
+
/**
|
|
2617
|
+
* @public
|
|
2618
|
+
* @enum
|
|
2619
|
+
*/
|
|
2620
|
+
export declare const PeriodUnit: {
|
|
2621
|
+
readonly DAYS: "DAYS";
|
|
2622
|
+
readonly HOURS: "HOURS";
|
|
2623
|
+
readonly MONTHS: "MONTHS";
|
|
2624
|
+
readonly WEEKS: "WEEKS";
|
|
2625
|
+
};
|
|
2626
|
+
/**
|
|
2627
|
+
* @public
|
|
2628
|
+
*/
|
|
2629
|
+
export type PeriodUnit = (typeof PeriodUnit)[keyof typeof PeriodUnit];
|
|
2630
|
+
/**
|
|
2631
|
+
* <p>Defines a limit and the time period during which it is enforced.</p>
|
|
2632
|
+
* @public
|
|
2633
|
+
*/
|
|
2634
|
+
export interface Period {
|
|
2635
|
+
/**
|
|
2636
|
+
* <p>The unit of time.</p>
|
|
2637
|
+
* @public
|
|
2638
|
+
*/
|
|
2639
|
+
Unit: PeriodUnit | undefined;
|
|
2640
|
+
/**
|
|
2641
|
+
* <p>The amount of time of the specified unit.</p>
|
|
2642
|
+
* @public
|
|
2643
|
+
*/
|
|
2644
|
+
Value: number | undefined;
|
|
2645
|
+
/**
|
|
2646
|
+
* <p>The maximum allowed number of destination invocations per profile.</p>
|
|
2647
|
+
* @public
|
|
2648
|
+
*/
|
|
2649
|
+
MaxInvocationsPerProfile?: number | undefined;
|
|
2650
|
+
/**
|
|
2651
|
+
* <p>If set to true, there is no limit on the number of destination invocations per profile. The default is false.</p>
|
|
2652
|
+
* @public
|
|
2653
|
+
*/
|
|
2654
|
+
Unlimited?: boolean | undefined;
|
|
2655
|
+
}
|
|
2656
|
+
/**
|
|
2657
|
+
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.</p>
|
|
2658
|
+
* @public
|
|
2659
|
+
*/
|
|
2660
|
+
export interface EventTriggerLimits {
|
|
2661
|
+
/**
|
|
2662
|
+
* <p>In milliseconds. Specifies that an event will only trigger the destination if it is processed within a certain latency period.</p>
|
|
2663
|
+
* @public
|
|
2664
|
+
*/
|
|
2665
|
+
EventExpiration?: number | undefined;
|
|
2666
|
+
/**
|
|
2667
|
+
* <p>A list of time periods during which the limits apply.</p>
|
|
2668
|
+
* @public
|
|
2669
|
+
*/
|
|
2670
|
+
Periods?: Period[] | undefined;
|
|
2671
|
+
}
|
|
2672
|
+
/**
|
|
2673
|
+
* @public
|
|
2674
|
+
*/
|
|
2675
|
+
export interface CreateEventTriggerRequest {
|
|
2676
|
+
/**
|
|
2677
|
+
* <p>The unique name of the domain.</p>
|
|
2678
|
+
* @public
|
|
2679
|
+
*/
|
|
2680
|
+
DomainName: string | undefined;
|
|
2681
|
+
/**
|
|
2682
|
+
* <p>The unique name of the event trigger.</p>
|
|
2683
|
+
* @public
|
|
2684
|
+
*/
|
|
2685
|
+
EventTriggerName: string | undefined;
|
|
2686
|
+
/**
|
|
2687
|
+
* <p>The unique name of the object type.</p>
|
|
2688
|
+
* @public
|
|
2689
|
+
*/
|
|
2690
|
+
ObjectTypeName: string | undefined;
|
|
2691
|
+
/**
|
|
2692
|
+
* <p>The description of the event trigger.</p>
|
|
2693
|
+
* @public
|
|
2694
|
+
*/
|
|
2695
|
+
Description?: string | undefined;
|
|
2696
|
+
/**
|
|
2697
|
+
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
2698
|
+
* @public
|
|
2699
|
+
*/
|
|
2700
|
+
EventTriggerConditions: EventTriggerCondition[] | undefined;
|
|
2701
|
+
/**
|
|
2702
|
+
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
2703
|
+
* definition.</p>
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
SegmentFilter?: string | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion
|
|
2709
|
+
* latency and the number of invocations per profile over specific time periods.</p>
|
|
2710
|
+
* @public
|
|
2711
|
+
*/
|
|
2712
|
+
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
2713
|
+
/**
|
|
2714
|
+
* <p>An array of key-value pairs to apply to this resource.</p>
|
|
2715
|
+
* @public
|
|
2716
|
+
*/
|
|
2717
|
+
Tags?: Record<string, string> | undefined;
|
|
2718
|
+
}
|
|
2719
|
+
/**
|
|
2720
|
+
* @public
|
|
2721
|
+
*/
|
|
2722
|
+
export interface CreateEventTriggerResponse {
|
|
2723
|
+
/**
|
|
2724
|
+
* <p>The unique name of the event trigger.</p>
|
|
2725
|
+
* @public
|
|
2726
|
+
*/
|
|
2727
|
+
EventTriggerName?: string | undefined;
|
|
2728
|
+
/**
|
|
2729
|
+
* <p>The unique name of the object type.</p>
|
|
2730
|
+
* @public
|
|
2731
|
+
*/
|
|
2732
|
+
ObjectTypeName?: string | undefined;
|
|
2733
|
+
/**
|
|
2734
|
+
* <p>The description of the event trigger.</p>
|
|
2735
|
+
* @public
|
|
2736
|
+
*/
|
|
2737
|
+
Description?: string | undefined;
|
|
2738
|
+
/**
|
|
2739
|
+
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
2740
|
+
* @public
|
|
2741
|
+
*/
|
|
2742
|
+
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
2743
|
+
/**
|
|
2744
|
+
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
2745
|
+
* definition.</p>
|
|
2746
|
+
* @public
|
|
2747
|
+
*/
|
|
2748
|
+
SegmentFilter?: string | undefined;
|
|
2749
|
+
/**
|
|
2750
|
+
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion
|
|
2751
|
+
* latency and the number of invocations per profile over specific time periods.</p>
|
|
2752
|
+
* @public
|
|
2753
|
+
*/
|
|
2754
|
+
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
2755
|
+
/**
|
|
2756
|
+
* <p>The timestamp of when the event trigger was created.</p>
|
|
2757
|
+
* @public
|
|
2758
|
+
*/
|
|
2759
|
+
CreatedAt?: Date | undefined;
|
|
2760
|
+
/**
|
|
2761
|
+
* <p>The timestamp of when the event trigger was most recently updated.</p>
|
|
2762
|
+
* @public
|
|
2763
|
+
*/
|
|
2764
|
+
LastUpdatedAt?: Date | undefined;
|
|
2765
|
+
/**
|
|
2766
|
+
* <p>An array of key-value pairs to apply to this resource.</p>
|
|
2767
|
+
* @public
|
|
2768
|
+
*/
|
|
2769
|
+
Tags?: Record<string, string> | undefined;
|
|
2770
|
+
}
|
|
2517
2771
|
/**
|
|
2518
2772
|
* <p>Configuration data for integration workflow.</p>
|
|
2519
2773
|
* @public
|
|
@@ -2729,7 +2983,8 @@ export interface CreateProfileResponse {
|
|
|
2729
2983
|
ProfileId: string | undefined;
|
|
2730
2984
|
}
|
|
2731
2985
|
/**
|
|
2732
|
-
* <p>Object that segments on various Customer profile's fields that are larger than
|
|
2986
|
+
* <p>Object that segments on various Customer profile's fields that are larger than
|
|
2987
|
+
* normal.</p>
|
|
2733
2988
|
* @public
|
|
2734
2989
|
*/
|
|
2735
2990
|
export interface ExtraLengthValueProfileDimension {
|
|
@@ -3019,7 +3274,8 @@ export interface CreateSegmentDefinitionRequest {
|
|
|
3019
3274
|
*/
|
|
3020
3275
|
Description?: string | undefined;
|
|
3021
3276
|
/**
|
|
3022
|
-
* <p>Specifies the base segments and dimensions for a segment definition along with their
|
|
3277
|
+
* <p>Specifies the base segments and dimensions for a segment definition along with their
|
|
3278
|
+
* respective relationship.</p>
|
|
3023
3279
|
* @public
|
|
3024
3280
|
*/
|
|
3025
3281
|
SegmentGroups: SegmentGroup | undefined;
|
|
@@ -3105,7 +3361,9 @@ export interface CreateSegmentEstimateResponse {
|
|
|
3105
3361
|
*/
|
|
3106
3362
|
DomainName?: string | undefined;
|
|
3107
3363
|
/**
|
|
3108
|
-
* <p>A unique identifier for the resource. The value can be passed to
|
|
3364
|
+
* <p>A unique identifier for the resource. The value can be passed to
|
|
3365
|
+
* <code>GetSegmentEstimate</code> to retrieve the result of segment estimate
|
|
3366
|
+
* status.</p>
|
|
3109
3367
|
* @public
|
|
3110
3368
|
*/
|
|
3111
3369
|
EstimateId?: string | undefined;
|
|
@@ -3148,17 +3406,20 @@ export interface CreateSegmentSnapshotRequest {
|
|
|
3148
3406
|
*/
|
|
3149
3407
|
DataFormat: DataFormat | undefined;
|
|
3150
3408
|
/**
|
|
3151
|
-
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported
|
|
3409
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported
|
|
3410
|
+
* segment.</p>
|
|
3152
3411
|
* @public
|
|
3153
3412
|
*/
|
|
3154
3413
|
EncryptionKey?: string | undefined;
|
|
3155
3414
|
/**
|
|
3156
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service
|
|
3415
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service
|
|
3416
|
+
* principal to assume the role for conducting KMS and S3 operations.</p>
|
|
3157
3417
|
* @public
|
|
3158
3418
|
*/
|
|
3159
3419
|
RoleArn?: string | undefined;
|
|
3160
3420
|
/**
|
|
3161
|
-
* <p>The destination to which the segment will be exported. This field must be provided if
|
|
3421
|
+
* <p>The destination to which the segment will be exported. This field must be provided if
|
|
3422
|
+
* the request is not submitted from the Amazon Connect Admin Website.</p>
|
|
3162
3423
|
* @public
|
|
3163
3424
|
*/
|
|
3164
3425
|
DestinationUri?: string | undefined;
|
|
@@ -3233,6 +3494,31 @@ export interface DeleteEventStreamRequest {
|
|
|
3233
3494
|
*/
|
|
3234
3495
|
export interface DeleteEventStreamResponse {
|
|
3235
3496
|
}
|
|
3497
|
+
/**
|
|
3498
|
+
* @public
|
|
3499
|
+
*/
|
|
3500
|
+
export interface DeleteEventTriggerRequest {
|
|
3501
|
+
/**
|
|
3502
|
+
* <p>The unique name of the domain.</p>
|
|
3503
|
+
* @public
|
|
3504
|
+
*/
|
|
3505
|
+
DomainName: string | undefined;
|
|
3506
|
+
/**
|
|
3507
|
+
* <p>The unique name of the event trigger.</p>
|
|
3508
|
+
* @public
|
|
3509
|
+
*/
|
|
3510
|
+
EventTriggerName: string | undefined;
|
|
3511
|
+
}
|
|
3512
|
+
/**
|
|
3513
|
+
* @public
|
|
3514
|
+
*/
|
|
3515
|
+
export interface DeleteEventTriggerResponse {
|
|
3516
|
+
/**
|
|
3517
|
+
* <p>A message that indicates the delete request is done.</p>
|
|
3518
|
+
* @public
|
|
3519
|
+
*/
|
|
3520
|
+
Message: string | undefined;
|
|
3521
|
+
}
|
|
3236
3522
|
/**
|
|
3237
3523
|
* @public
|
|
3238
3524
|
*/
|
|
@@ -3939,6 +4225,72 @@ export interface GetEventStreamResponse {
|
|
|
3939
4225
|
*/
|
|
3940
4226
|
Tags?: Record<string, string> | undefined;
|
|
3941
4227
|
}
|
|
4228
|
+
/**
|
|
4229
|
+
* @public
|
|
4230
|
+
*/
|
|
4231
|
+
export interface GetEventTriggerRequest {
|
|
4232
|
+
/**
|
|
4233
|
+
* <p>The unique name of the domain.</p>
|
|
4234
|
+
* @public
|
|
4235
|
+
*/
|
|
4236
|
+
DomainName: string | undefined;
|
|
4237
|
+
/**
|
|
4238
|
+
* <p>The unique name of the event trigger.</p>
|
|
4239
|
+
* @public
|
|
4240
|
+
*/
|
|
4241
|
+
EventTriggerName: string | undefined;
|
|
4242
|
+
}
|
|
4243
|
+
/**
|
|
4244
|
+
* @public
|
|
4245
|
+
*/
|
|
4246
|
+
export interface GetEventTriggerResponse {
|
|
4247
|
+
/**
|
|
4248
|
+
* <p>The unique name of the event trigger.</p>
|
|
4249
|
+
* @public
|
|
4250
|
+
*/
|
|
4251
|
+
EventTriggerName?: string | undefined;
|
|
4252
|
+
/**
|
|
4253
|
+
* <p>The unique name of the object type.</p>
|
|
4254
|
+
* @public
|
|
4255
|
+
*/
|
|
4256
|
+
ObjectTypeName?: string | undefined;
|
|
4257
|
+
/**
|
|
4258
|
+
* <p>The description of the event trigger.</p>
|
|
4259
|
+
* @public
|
|
4260
|
+
*/
|
|
4261
|
+
Description?: string | undefined;
|
|
4262
|
+
/**
|
|
4263
|
+
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
4264
|
+
* @public
|
|
4265
|
+
*/
|
|
4266
|
+
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
4267
|
+
/**
|
|
4268
|
+
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
4269
|
+
* definition.</p>
|
|
4270
|
+
* @public
|
|
4271
|
+
*/
|
|
4272
|
+
SegmentFilter?: string | undefined;
|
|
4273
|
+
/**
|
|
4274
|
+
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.</p>
|
|
4275
|
+
* @public
|
|
4276
|
+
*/
|
|
4277
|
+
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
4278
|
+
/**
|
|
4279
|
+
* <p>The timestamp of when the event trigger was created.</p>
|
|
4280
|
+
* @public
|
|
4281
|
+
*/
|
|
4282
|
+
CreatedAt?: Date | undefined;
|
|
4283
|
+
/**
|
|
4284
|
+
* <p>The timestamp of when the event trigger was most recently updated.</p>
|
|
4285
|
+
* @public
|
|
4286
|
+
*/
|
|
4287
|
+
LastUpdatedAt?: Date | undefined;
|
|
4288
|
+
/**
|
|
4289
|
+
* <p>An array of key-value pairs to apply to this resource.</p>
|
|
4290
|
+
* @public
|
|
4291
|
+
*/
|
|
4292
|
+
Tags?: Record<string, string> | undefined;
|
|
4293
|
+
}
|
|
3942
4294
|
/**
|
|
3943
4295
|
* @public
|
|
3944
4296
|
*/
|
|
@@ -4188,6 +4540,12 @@ export interface GetIntegrationResponse {
|
|
|
4188
4540
|
* @public
|
|
4189
4541
|
*/
|
|
4190
4542
|
RoleArn?: string | undefined;
|
|
4543
|
+
/**
|
|
4544
|
+
* <p>A list of unique names for active event triggers associated with the integration. This
|
|
4545
|
+
* list would be empty if no Event Trigger is associated with the integration.</p>
|
|
4546
|
+
* @public
|
|
4547
|
+
*/
|
|
4548
|
+
EventTriggerNames?: string[] | undefined;
|
|
4191
4549
|
}
|
|
4192
4550
|
/**
|
|
4193
4551
|
* @public
|
|
@@ -4506,7 +4864,8 @@ export interface GetSegmentEstimateResponse {
|
|
|
4506
4864
|
*/
|
|
4507
4865
|
DomainName?: string | undefined;
|
|
4508
4866
|
/**
|
|
4509
|
-
* <p>The <code>QueryId</code> which is the same as the value passed in
|
|
4867
|
+
* <p>The <code>QueryId</code> which is the same as the value passed in
|
|
4868
|
+
* <code>QueryId</code>.</p>
|
|
4510
4869
|
* @public
|
|
4511
4870
|
*/
|
|
4512
4871
|
EstimateId?: string | undefined;
|
|
@@ -4620,7 +4979,8 @@ export interface GetSegmentMembershipResponse {
|
|
|
4620
4979
|
*/
|
|
4621
4980
|
Profiles?: ProfileQueryResult[] | undefined;
|
|
4622
4981
|
/**
|
|
4623
|
-
* <p>An array of maps where each contains a response per profile failed for the
|
|
4982
|
+
* <p>An array of maps where each contains a response per profile failed for the
|
|
4983
|
+
* request.</p>
|
|
4624
4984
|
* @public
|
|
4625
4985
|
*/
|
|
4626
4986
|
Failures?: ProfileQueryFailures[] | undefined;
|
|
@@ -4683,17 +5043,20 @@ export interface GetSegmentSnapshotResponse {
|
|
|
4683
5043
|
*/
|
|
4684
5044
|
DataFormat: DataFormat | undefined;
|
|
4685
5045
|
/**
|
|
4686
|
-
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported
|
|
5046
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported
|
|
5047
|
+
* segment.</p>
|
|
4687
5048
|
* @public
|
|
4688
5049
|
*/
|
|
4689
5050
|
EncryptionKey?: string | undefined;
|
|
4690
5051
|
/**
|
|
4691
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service
|
|
5052
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service
|
|
5053
|
+
* principal to assume the role for conducting KMS and S3 operations.</p>
|
|
4692
5054
|
* @public
|
|
4693
5055
|
*/
|
|
4694
5056
|
RoleArn?: string | undefined;
|
|
4695
5057
|
/**
|
|
4696
|
-
* <p>The destination to which the segment will be exported. This field must be provided if
|
|
5058
|
+
* <p>The destination to which the segment will be exported. This field must be provided if
|
|
5059
|
+
* the request is not submitted from the Amazon Connect Admin Website.</p>
|
|
4697
5060
|
* @public
|
|
4698
5061
|
*/
|
|
4699
5062
|
DestinationUri?: string | undefined;
|
|
@@ -5016,6 +5379,11 @@ export interface ListIntegrationItem {
|
|
|
5016
5379
|
* @public
|
|
5017
5380
|
*/
|
|
5018
5381
|
RoleArn?: string | undefined;
|
|
5382
|
+
/**
|
|
5383
|
+
* <p>A list of unique names for active event triggers associated with the integration.</p>
|
|
5384
|
+
* @public
|
|
5385
|
+
*/
|
|
5386
|
+
EventTriggerNames?: string[] | undefined;
|
|
5019
5387
|
}
|
|
5020
5388
|
/**
|
|
5021
5389
|
* @public
|
|
@@ -5265,6 +5633,77 @@ export interface ListEventStreamsResponse {
|
|
|
5265
5633
|
*/
|
|
5266
5634
|
NextToken?: string | undefined;
|
|
5267
5635
|
}
|
|
5636
|
+
/**
|
|
5637
|
+
* @public
|
|
5638
|
+
*/
|
|
5639
|
+
export interface ListEventTriggersRequest {
|
|
5640
|
+
/**
|
|
5641
|
+
* <p>The unique name of the domain.</p>
|
|
5642
|
+
* @public
|
|
5643
|
+
*/
|
|
5644
|
+
DomainName: string | undefined;
|
|
5645
|
+
/**
|
|
5646
|
+
* <p>The pagination token to use with ListEventTriggers.</p>
|
|
5647
|
+
* @public
|
|
5648
|
+
*/
|
|
5649
|
+
NextToken?: string | undefined;
|
|
5650
|
+
/**
|
|
5651
|
+
* <p>The maximum number of results to return per page.</p>
|
|
5652
|
+
* @public
|
|
5653
|
+
*/
|
|
5654
|
+
MaxResults?: number | undefined;
|
|
5655
|
+
}
|
|
5656
|
+
/**
|
|
5657
|
+
* <p>The summary of the event trigger.</p>
|
|
5658
|
+
* @public
|
|
5659
|
+
*/
|
|
5660
|
+
export interface EventTriggerSummaryItem {
|
|
5661
|
+
/**
|
|
5662
|
+
* <p>The unique name of the object type.</p>
|
|
5663
|
+
* @public
|
|
5664
|
+
*/
|
|
5665
|
+
ObjectTypeName?: string | undefined;
|
|
5666
|
+
/**
|
|
5667
|
+
* <p>The unique name of the event trigger.</p>
|
|
5668
|
+
* @public
|
|
5669
|
+
*/
|
|
5670
|
+
EventTriggerName?: string | undefined;
|
|
5671
|
+
/**
|
|
5672
|
+
* <p>The description of the event trigger.</p>
|
|
5673
|
+
* @public
|
|
5674
|
+
*/
|
|
5675
|
+
Description?: string | undefined;
|
|
5676
|
+
/**
|
|
5677
|
+
* <p>The timestamp of when the event trigger was created.</p>
|
|
5678
|
+
* @public
|
|
5679
|
+
*/
|
|
5680
|
+
CreatedAt?: Date | undefined;
|
|
5681
|
+
/**
|
|
5682
|
+
* <p>The timestamp of when the event trigger was most recently updated.</p>
|
|
5683
|
+
* @public
|
|
5684
|
+
*/
|
|
5685
|
+
LastUpdatedAt?: Date | undefined;
|
|
5686
|
+
/**
|
|
5687
|
+
* <p>An array of key-value pairs to apply to this resource.</p>
|
|
5688
|
+
* @public
|
|
5689
|
+
*/
|
|
5690
|
+
Tags?: Record<string, string> | undefined;
|
|
5691
|
+
}
|
|
5692
|
+
/**
|
|
5693
|
+
* @public
|
|
5694
|
+
*/
|
|
5695
|
+
export interface ListEventTriggersResponse {
|
|
5696
|
+
/**
|
|
5697
|
+
* <p>The list of Event Triggers.</p>
|
|
5698
|
+
* @public
|
|
5699
|
+
*/
|
|
5700
|
+
Items?: EventTriggerSummaryItem[] | undefined;
|
|
5701
|
+
/**
|
|
5702
|
+
* <p>The pagination token from the previous call to ListEventTriggers.</p>
|
|
5703
|
+
* @public
|
|
5704
|
+
*/
|
|
5705
|
+
NextToken?: string | undefined;
|
|
5706
|
+
}
|
|
5268
5707
|
/**
|
|
5269
5708
|
* @public
|
|
5270
5709
|
*/
|
|
@@ -6150,6 +6589,11 @@ export interface PutIntegrationRequest {
|
|
|
6150
6589
|
* @public
|
|
6151
6590
|
*/
|
|
6152
6591
|
RoleArn?: string | undefined;
|
|
6592
|
+
/**
|
|
6593
|
+
* <p>A list of unique names for active event triggers associated with the integration.</p>
|
|
6594
|
+
* @public
|
|
6595
|
+
*/
|
|
6596
|
+
EventTriggerNames?: string[] | undefined;
|
|
6153
6597
|
}
|
|
6154
6598
|
/**
|
|
6155
6599
|
* @public
|
|
@@ -6210,6 +6654,12 @@ export interface PutIntegrationResponse {
|
|
|
6210
6654
|
* @public
|
|
6211
6655
|
*/
|
|
6212
6656
|
RoleArn?: string | undefined;
|
|
6657
|
+
/**
|
|
6658
|
+
* <p>A list of unique names for active event triggers associated with the integration. This
|
|
6659
|
+
* list would be empty if no Event Trigger is associated with the integration.</p>
|
|
6660
|
+
* @public
|
|
6661
|
+
*/
|
|
6662
|
+
EventTriggerNames?: string[] | undefined;
|
|
6213
6663
|
}
|
|
6214
6664
|
/**
|
|
6215
6665
|
* @public
|
|
@@ -6744,6 +7194,98 @@ export interface UpdateDomainResponse {
|
|
|
6744
7194
|
*/
|
|
6745
7195
|
Tags?: Record<string, string> | undefined;
|
|
6746
7196
|
}
|
|
7197
|
+
/**
|
|
7198
|
+
* @public
|
|
7199
|
+
*/
|
|
7200
|
+
export interface UpdateEventTriggerRequest {
|
|
7201
|
+
/**
|
|
7202
|
+
* <p>The unique name of the domain.</p>
|
|
7203
|
+
* @public
|
|
7204
|
+
*/
|
|
7205
|
+
DomainName: string | undefined;
|
|
7206
|
+
/**
|
|
7207
|
+
* <p>The unique name of the event trigger.</p>
|
|
7208
|
+
* @public
|
|
7209
|
+
*/
|
|
7210
|
+
EventTriggerName: string | undefined;
|
|
7211
|
+
/**
|
|
7212
|
+
* <p>The unique name of the object type.</p>
|
|
7213
|
+
* @public
|
|
7214
|
+
*/
|
|
7215
|
+
ObjectTypeName?: string | undefined;
|
|
7216
|
+
/**
|
|
7217
|
+
* <p>The description of the event trigger.</p>
|
|
7218
|
+
* @public
|
|
7219
|
+
*/
|
|
7220
|
+
Description?: string | undefined;
|
|
7221
|
+
/**
|
|
7222
|
+
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
7223
|
+
* @public
|
|
7224
|
+
*/
|
|
7225
|
+
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
7226
|
+
/**
|
|
7227
|
+
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
7228
|
+
* definition.</p>
|
|
7229
|
+
* @public
|
|
7230
|
+
*/
|
|
7231
|
+
SegmentFilter?: string | undefined;
|
|
7232
|
+
/**
|
|
7233
|
+
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.</p>
|
|
7234
|
+
* @public
|
|
7235
|
+
*/
|
|
7236
|
+
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
7237
|
+
}
|
|
7238
|
+
/**
|
|
7239
|
+
* @public
|
|
7240
|
+
*/
|
|
7241
|
+
export interface UpdateEventTriggerResponse {
|
|
7242
|
+
/**
|
|
7243
|
+
* <p>The unique name of the event trigger.</p>
|
|
7244
|
+
* @public
|
|
7245
|
+
*/
|
|
7246
|
+
EventTriggerName?: string | undefined;
|
|
7247
|
+
/**
|
|
7248
|
+
* <p>The unique name of the object type.</p>
|
|
7249
|
+
* @public
|
|
7250
|
+
*/
|
|
7251
|
+
ObjectTypeName?: string | undefined;
|
|
7252
|
+
/**
|
|
7253
|
+
* <p>The description of the event trigger.</p>
|
|
7254
|
+
* @public
|
|
7255
|
+
*/
|
|
7256
|
+
Description?: string | undefined;
|
|
7257
|
+
/**
|
|
7258
|
+
* <p>A list of conditions that determine when an event should trigger the destination.</p>
|
|
7259
|
+
* @public
|
|
7260
|
+
*/
|
|
7261
|
+
EventTriggerConditions?: EventTriggerCondition[] | undefined;
|
|
7262
|
+
/**
|
|
7263
|
+
* <p>The destination is triggered only for profiles that meet the criteria of a segment
|
|
7264
|
+
* definition.</p>
|
|
7265
|
+
* @public
|
|
7266
|
+
*/
|
|
7267
|
+
SegmentFilter?: string | undefined;
|
|
7268
|
+
/**
|
|
7269
|
+
* <p>Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.</p>
|
|
7270
|
+
* @public
|
|
7271
|
+
*/
|
|
7272
|
+
EventTriggerLimits?: EventTriggerLimits | undefined;
|
|
7273
|
+
/**
|
|
7274
|
+
* <p>The timestamp of when the event trigger was created.</p>
|
|
7275
|
+
* @public
|
|
7276
|
+
*/
|
|
7277
|
+
CreatedAt?: Date | undefined;
|
|
7278
|
+
/**
|
|
7279
|
+
* <p>The timestamp of when the event trigger was most recently updated.</p>
|
|
7280
|
+
* @public
|
|
7281
|
+
*/
|
|
7282
|
+
LastUpdatedAt?: Date | undefined;
|
|
7283
|
+
/**
|
|
7284
|
+
* <p>An array of key-value pairs to apply to this resource.</p>
|
|
7285
|
+
* @public
|
|
7286
|
+
*/
|
|
7287
|
+
Tags?: Record<string, string> | undefined;
|
|
7288
|
+
}
|
|
6747
7289
|
/**
|
|
6748
7290
|
* <p>Updates associated with the address properties of a customer profile.</p>
|
|
6749
7291
|
* @public
|
|
@@ -7003,6 +7545,14 @@ export declare const CreateCalculatedAttributeDefinitionRequestFilterSensitiveLo
|
|
|
7003
7545
|
* @internal
|
|
7004
7546
|
*/
|
|
7005
7547
|
export declare const CreateCalculatedAttributeDefinitionResponseFilterSensitiveLog: (obj: CreateCalculatedAttributeDefinitionResponse) => any;
|
|
7548
|
+
/**
|
|
7549
|
+
* @internal
|
|
7550
|
+
*/
|
|
7551
|
+
export declare const CreateEventTriggerRequestFilterSensitiveLog: (obj: CreateEventTriggerRequest) => any;
|
|
7552
|
+
/**
|
|
7553
|
+
* @internal
|
|
7554
|
+
*/
|
|
7555
|
+
export declare const CreateEventTriggerResponseFilterSensitiveLog: (obj: CreateEventTriggerResponse) => any;
|
|
7006
7556
|
/**
|
|
7007
7557
|
* @internal
|
|
7008
7558
|
*/
|
|
@@ -7063,6 +7613,10 @@ export declare const DetectProfileObjectTypeResponseFilterSensitiveLog: (obj: De
|
|
|
7063
7613
|
* @internal
|
|
7064
7614
|
*/
|
|
7065
7615
|
export declare const GetCalculatedAttributeDefinitionResponseFilterSensitiveLog: (obj: GetCalculatedAttributeDefinitionResponse) => any;
|
|
7616
|
+
/**
|
|
7617
|
+
* @internal
|
|
7618
|
+
*/
|
|
7619
|
+
export declare const GetEventTriggerResponseFilterSensitiveLog: (obj: GetEventTriggerResponse) => any;
|
|
7066
7620
|
/**
|
|
7067
7621
|
* @internal
|
|
7068
7622
|
*/
|
|
@@ -7087,6 +7641,10 @@ export declare const GetSegmentMembershipResponseFilterSensitiveLog: (obj: GetSe
|
|
|
7087
7641
|
* @internal
|
|
7088
7642
|
*/
|
|
7089
7643
|
export declare const ListCalculatedAttributeDefinitionsResponseFilterSensitiveLog: (obj: ListCalculatedAttributeDefinitionsResponse) => any;
|
|
7644
|
+
/**
|
|
7645
|
+
* @internal
|
|
7646
|
+
*/
|
|
7647
|
+
export declare const ListEventTriggersResponseFilterSensitiveLog: (obj: ListEventTriggersResponse) => any;
|
|
7090
7648
|
/**
|
|
7091
7649
|
* @internal
|
|
7092
7650
|
*/
|
|
@@ -7135,6 +7693,14 @@ export declare const UpdateCalculatedAttributeDefinitionRequestFilterSensitiveLo
|
|
|
7135
7693
|
* @internal
|
|
7136
7694
|
*/
|
|
7137
7695
|
export declare const UpdateCalculatedAttributeDefinitionResponseFilterSensitiveLog: (obj: UpdateCalculatedAttributeDefinitionResponse) => any;
|
|
7696
|
+
/**
|
|
7697
|
+
* @internal
|
|
7698
|
+
*/
|
|
7699
|
+
export declare const UpdateEventTriggerRequestFilterSensitiveLog: (obj: UpdateEventTriggerRequest) => any;
|
|
7700
|
+
/**
|
|
7701
|
+
* @internal
|
|
7702
|
+
*/
|
|
7703
|
+
export declare const UpdateEventTriggerResponseFilterSensitiveLog: (obj: UpdateEventTriggerResponse) => any;
|
|
7138
7704
|
/**
|
|
7139
7705
|
* @internal
|
|
7140
7706
|
*/
|