aws-sdk-customerprofiles 1.79.0 → 1.81.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +262 -12
- data/lib/aws-sdk-customerprofiles/client_api.rb +177 -3
- data/lib/aws-sdk-customerprofiles/types.rb +402 -3
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- data/sig/client.rbs +95 -10
- data/sig/types.rbs +106 -5
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f074c9feba549ede53bdcc4ab790bc9809f10795733bdec6cf64c237d228ada8
|
|
4
|
+
data.tar.gz: b223b4cc3913d8c16e847a156c4ecae53ccfb81c15c5e05d3cbc54edf83bb73c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b08c5d431e58d38556e66549fe0603d84d42ba76c005387cd702fb9eceb6ba26791c763b32a6ea9748af87cb8e23cff03899e54f1c76c75b06457e2f15ffd65e
|
|
7
|
+
data.tar.gz: 947797580103c476c72c17317910faf1da7dc6b631c3e246b0813992247f4d5d02b2a4cbf15e12bfcae4efaddccd9c69d934542dca2503f454dbae02c3db34fc
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.81.0 (2026-03-11)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Today, Amazon Connect is announcing the ability to filter (include or exclude) recommendations based on properties of items and interactions.
|
|
8
|
+
|
|
9
|
+
1.80.0 (2026-02-27)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - This release introduces an optional SourcePriority parameter to the ProfileObjectType APIs, allowing you to control the precedence of object types when ingesting data from multiple sources. Additionally, WebAnalytics and Device have been added as new StandardIdentifier values.
|
|
13
|
+
|
|
4
14
|
1.79.0 (2026-01-16)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.81.0
|
|
@@ -1697,17 +1697,21 @@ module Aws::CustomerProfiles
|
|
|
1697
1697
|
# resp = client.create_recommender({
|
|
1698
1698
|
# domain_name: "name", # required
|
|
1699
1699
|
# recommender_name: "name", # required
|
|
1700
|
-
# recommender_recipe_name: "recommended-for-you", # required, accepts recommended-for-you, similar-items, frequently-paired-items, popular-items, trending-now
|
|
1700
|
+
# recommender_recipe_name: "recommended-for-you", # required, accepts recommended-for-you, similar-items, frequently-paired-items, popular-items, trending-now, personalized-ranking
|
|
1701
1701
|
# recommender_config: {
|
|
1702
|
-
# events_config: {
|
|
1702
|
+
# events_config: {
|
|
1703
1703
|
# event_parameters_list: [ # required
|
|
1704
1704
|
# {
|
|
1705
1705
|
# event_type: "EventParametersEventTypeString", # required
|
|
1706
1706
|
# event_value_threshold: 1.0,
|
|
1707
|
+
# event_weight: 1.0,
|
|
1707
1708
|
# },
|
|
1708
1709
|
# ],
|
|
1709
1710
|
# },
|
|
1710
1711
|
# training_frequency: 1,
|
|
1712
|
+
# inference_config: {
|
|
1713
|
+
# min_provisioned_tps: 1,
|
|
1714
|
+
# },
|
|
1711
1715
|
# },
|
|
1712
1716
|
# description: "sensitiveText",
|
|
1713
1717
|
# tags: {
|
|
@@ -1730,6 +1734,58 @@ module Aws::CustomerProfiles
|
|
|
1730
1734
|
req.send_request(options)
|
|
1731
1735
|
end
|
|
1732
1736
|
|
|
1737
|
+
# Creates a recommender filter. A recommender filter specifies which
|
|
1738
|
+
# items to include or exclude from recommendations.
|
|
1739
|
+
#
|
|
1740
|
+
# @option params [required, String] :domain_name
|
|
1741
|
+
# The unique name of the domain.
|
|
1742
|
+
#
|
|
1743
|
+
# @option params [required, String] :recommender_filter_name
|
|
1744
|
+
# The name of the recommender filter. The name must be unique within the
|
|
1745
|
+
# domain.
|
|
1746
|
+
#
|
|
1747
|
+
# @option params [required, String] :recommender_filter_expression
|
|
1748
|
+
# The filter expression that defines which items to include or exclude
|
|
1749
|
+
# from recommendations.
|
|
1750
|
+
#
|
|
1751
|
+
# @option params [String] :description
|
|
1752
|
+
# A description of the recommender filter.
|
|
1753
|
+
#
|
|
1754
|
+
# @option params [Hash<String,String>] :tags
|
|
1755
|
+
# The tags used to organize, track, or control access for this resource.
|
|
1756
|
+
#
|
|
1757
|
+
# @return [Types::CreateRecommenderFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1758
|
+
#
|
|
1759
|
+
# * {Types::CreateRecommenderFilterResponse#recommender_filter_arn #recommender_filter_arn} => String
|
|
1760
|
+
# * {Types::CreateRecommenderFilterResponse#tags #tags} => Hash<String,String>
|
|
1761
|
+
#
|
|
1762
|
+
# @example Request syntax with placeholder values
|
|
1763
|
+
#
|
|
1764
|
+
# resp = client.create_recommender_filter({
|
|
1765
|
+
# domain_name: "name", # required
|
|
1766
|
+
# recommender_filter_name: "RecommenderFilterName", # required
|
|
1767
|
+
# recommender_filter_expression: "RecommenderFilterExpression", # required
|
|
1768
|
+
# description: "sensitiveText",
|
|
1769
|
+
# tags: {
|
|
1770
|
+
# "TagKey" => "TagValue",
|
|
1771
|
+
# },
|
|
1772
|
+
# })
|
|
1773
|
+
#
|
|
1774
|
+
# @example Response structure
|
|
1775
|
+
#
|
|
1776
|
+
# resp.recommender_filter_arn #=> String
|
|
1777
|
+
# resp.tags #=> Hash
|
|
1778
|
+
# resp.tags["TagKey"] #=> String
|
|
1779
|
+
#
|
|
1780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateRecommenderFilter AWS API Documentation
|
|
1781
|
+
#
|
|
1782
|
+
# @overload create_recommender_filter(params = {})
|
|
1783
|
+
# @param [Hash] params ({})
|
|
1784
|
+
def create_recommender_filter(params = {}, options = {})
|
|
1785
|
+
req = build_request(:create_recommender_filter, params)
|
|
1786
|
+
req.send_request(options)
|
|
1787
|
+
end
|
|
1788
|
+
|
|
1733
1789
|
# Creates a segment definition associated to the given domain.
|
|
1734
1790
|
#
|
|
1735
1791
|
# @option params [required, String] :domain_name
|
|
@@ -2754,6 +2810,38 @@ module Aws::CustomerProfiles
|
|
|
2754
2810
|
req.send_request(options)
|
|
2755
2811
|
end
|
|
2756
2812
|
|
|
2813
|
+
# Deletes a recommender filter from a domain.
|
|
2814
|
+
#
|
|
2815
|
+
# @option params [required, String] :domain_name
|
|
2816
|
+
# The unique name of the domain.
|
|
2817
|
+
#
|
|
2818
|
+
# @option params [required, String] :recommender_filter_name
|
|
2819
|
+
# The name of the recommender filter to delete.
|
|
2820
|
+
#
|
|
2821
|
+
# @return [Types::DeleteRecommenderFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2822
|
+
#
|
|
2823
|
+
# * {Types::DeleteRecommenderFilterResponse#message #message} => String
|
|
2824
|
+
#
|
|
2825
|
+
# @example Request syntax with placeholder values
|
|
2826
|
+
#
|
|
2827
|
+
# resp = client.delete_recommender_filter({
|
|
2828
|
+
# domain_name: "name", # required
|
|
2829
|
+
# recommender_filter_name: "RecommenderFilterName", # required
|
|
2830
|
+
# })
|
|
2831
|
+
#
|
|
2832
|
+
# @example Response structure
|
|
2833
|
+
#
|
|
2834
|
+
# resp.message #=> String
|
|
2835
|
+
#
|
|
2836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteRecommenderFilter AWS API Documentation
|
|
2837
|
+
#
|
|
2838
|
+
# @overload delete_recommender_filter(params = {})
|
|
2839
|
+
# @param [Hash] params ({})
|
|
2840
|
+
def delete_recommender_filter(params = {}, options = {})
|
|
2841
|
+
req = build_request(:delete_recommender_filter, params)
|
|
2842
|
+
req.send_request(options)
|
|
2843
|
+
end
|
|
2844
|
+
|
|
2757
2845
|
# Deletes a segment definition from the domain.
|
|
2758
2846
|
#
|
|
2759
2847
|
# @option params [required, String] :domain_name
|
|
@@ -2844,7 +2932,7 @@ module Aws::CustomerProfiles
|
|
|
2844
2932
|
# resp.detected_profile_object_types[0].keys #=> Hash
|
|
2845
2933
|
# resp.detected_profile_object_types[0].keys["name"] #=> Array
|
|
2846
2934
|
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers #=> Array
|
|
2847
|
-
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
2935
|
+
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "DEVICE", "WEB_ANALYTICS", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
2848
2936
|
# resp.detected_profile_object_types[0].keys["name"][0].field_names #=> Array
|
|
2849
2937
|
# resp.detected_profile_object_types[0].keys["name"][0].field_names[0] #=> String
|
|
2850
2938
|
#
|
|
@@ -3696,6 +3784,7 @@ module Aws::CustomerProfiles
|
|
|
3696
3784
|
# * {Types::GetProfileObjectTypeResponse#source_last_updated_timestamp_format #source_last_updated_timestamp_format} => String
|
|
3697
3785
|
# * {Types::GetProfileObjectTypeResponse#max_available_profile_object_count #max_available_profile_object_count} => Integer
|
|
3698
3786
|
# * {Types::GetProfileObjectTypeResponse#max_profile_object_count #max_profile_object_count} => Integer
|
|
3787
|
+
# * {Types::GetProfileObjectTypeResponse#source_priority #source_priority} => Integer
|
|
3699
3788
|
# * {Types::GetProfileObjectTypeResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
|
3700
3789
|
# * {Types::GetProfileObjectTypeResponse#keys #keys} => Hash<String,Array<Types::ObjectTypeKey>>
|
|
3701
3790
|
# * {Types::GetProfileObjectTypeResponse#created_at #created_at} => Time
|
|
@@ -3720,6 +3809,7 @@ module Aws::CustomerProfiles
|
|
|
3720
3809
|
# resp.source_last_updated_timestamp_format #=> String
|
|
3721
3810
|
# resp.max_available_profile_object_count #=> Integer
|
|
3722
3811
|
# resp.max_profile_object_count #=> Integer
|
|
3812
|
+
# resp.source_priority #=> Integer
|
|
3723
3813
|
# resp.fields #=> Hash
|
|
3724
3814
|
# resp.fields["fieldName"].source #=> String
|
|
3725
3815
|
# resp.fields["fieldName"].target #=> String
|
|
@@ -3727,7 +3817,7 @@ module Aws::CustomerProfiles
|
|
|
3727
3817
|
# resp.keys #=> Hash
|
|
3728
3818
|
# resp.keys["name"] #=> Array
|
|
3729
3819
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
|
3730
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
3820
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "DEVICE", "WEB_ANALYTICS", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
3731
3821
|
# resp.keys["name"][0].field_names #=> Array
|
|
3732
3822
|
# resp.keys["name"][0].field_names[0] #=> String
|
|
3733
3823
|
# resp.created_at #=> Time
|
|
@@ -3785,7 +3875,7 @@ module Aws::CustomerProfiles
|
|
|
3785
3875
|
# resp.keys #=> Hash
|
|
3786
3876
|
# resp.keys["name"] #=> Array
|
|
3787
3877
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
|
3788
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
3878
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "DEVICE", "WEB_ANALYTICS", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
3789
3879
|
# resp.keys["name"][0].field_names #=> Array
|
|
3790
3880
|
# resp.keys["name"][0].field_names[0] #=> String
|
|
3791
3881
|
#
|
|
@@ -3815,10 +3905,31 @@ module Aws::CustomerProfiles
|
|
|
3815
3905
|
# The contextual metadata used to provide dynamic runtime information to
|
|
3816
3906
|
# tailor recommendations.
|
|
3817
3907
|
#
|
|
3908
|
+
# @option params [Array<Types::RecommenderFilter>] :recommender_filters
|
|
3909
|
+
# A list of filters to apply to the returned recommendations. Filters
|
|
3910
|
+
# define criteria for including or excluding items from the
|
|
3911
|
+
# recommendation results.
|
|
3912
|
+
#
|
|
3913
|
+
# @option params [Array<Types::RecommenderPromotionalFilter>] :recommender_promotional_filters
|
|
3914
|
+
# A list of promotional filters to apply to the recommendations.
|
|
3915
|
+
# Promotional filters allow you to promote specific items within a
|
|
3916
|
+
# configurable subset of recommendation results.
|
|
3917
|
+
#
|
|
3918
|
+
# @option params [Array<String>] :candidate_ids
|
|
3919
|
+
# A list of item IDs to rank for the user. Use this when you want to
|
|
3920
|
+
# re-rank a specific set of items rather than getting recommendations
|
|
3921
|
+
# from the full item catalog. Required for personalized-ranking use
|
|
3922
|
+
# cases.
|
|
3923
|
+
#
|
|
3818
3924
|
# @option params [Integer] :max_results
|
|
3819
3925
|
# The maximum number of recommendations to return. The default value is
|
|
3820
3926
|
# 10.
|
|
3821
3927
|
#
|
|
3928
|
+
# @option params [Types::MetadataConfig] :metadata_config
|
|
3929
|
+
# Configuration for including item metadata in the recommendation
|
|
3930
|
+
# response. Use this to specify which metadata columns to return
|
|
3931
|
+
# alongside recommended items.
|
|
3932
|
+
#
|
|
3822
3933
|
# @return [Types::GetProfileRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3823
3934
|
#
|
|
3824
3935
|
# * {Types::GetProfileRecommendationsResponse#recommendations #recommendations} => Array<Types::Recommendation>
|
|
@@ -3832,7 +3943,29 @@ module Aws::CustomerProfiles
|
|
|
3832
3943
|
# context: {
|
|
3833
3944
|
# "ContextKey" => "string1To255",
|
|
3834
3945
|
# },
|
|
3946
|
+
# recommender_filters: [
|
|
3947
|
+
# {
|
|
3948
|
+
# name: "name",
|
|
3949
|
+
# values: {
|
|
3950
|
+
# "RecommenderFilterAttributeName" => "RecommenderFilterAttributeValue",
|
|
3951
|
+
# },
|
|
3952
|
+
# },
|
|
3953
|
+
# ],
|
|
3954
|
+
# recommender_promotional_filters: [
|
|
3955
|
+
# {
|
|
3956
|
+
# name: "name",
|
|
3957
|
+
# values: {
|
|
3958
|
+
# "RecommenderFilterAttributeName" => "RecommenderFilterAttributeValue",
|
|
3959
|
+
# },
|
|
3960
|
+
# promotion_name: "name",
|
|
3961
|
+
# percent_promoted_items: 1,
|
|
3962
|
+
# },
|
|
3963
|
+
# ],
|
|
3964
|
+
# candidate_ids: ["string1To255"],
|
|
3835
3965
|
# max_results: 1,
|
|
3966
|
+
# metadata_config: {
|
|
3967
|
+
# metadata_columns: ["MetadataColumnName"],
|
|
3968
|
+
# },
|
|
3836
3969
|
# })
|
|
3837
3970
|
#
|
|
3838
3971
|
# @example Response structure
|
|
@@ -3899,11 +4032,13 @@ module Aws::CustomerProfiles
|
|
|
3899
4032
|
# @example Response structure
|
|
3900
4033
|
#
|
|
3901
4034
|
# resp.recommender_name #=> String
|
|
3902
|
-
# resp.recommender_recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now"
|
|
4035
|
+
# resp.recommender_recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now", "personalized-ranking"
|
|
3903
4036
|
# resp.recommender_config.events_config.event_parameters_list #=> Array
|
|
3904
4037
|
# resp.recommender_config.events_config.event_parameters_list[0].event_type #=> String
|
|
3905
4038
|
# resp.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
|
|
4039
|
+
# resp.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
|
|
3906
4040
|
# resp.recommender_config.training_frequency #=> Integer
|
|
4041
|
+
# resp.recommender_config.inference_config.min_provisioned_tps #=> Integer
|
|
3907
4042
|
# resp.description #=> String
|
|
3908
4043
|
# resp.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
|
|
3909
4044
|
# resp.last_updated_at #=> Time
|
|
@@ -3912,7 +4047,9 @@ module Aws::CustomerProfiles
|
|
|
3912
4047
|
# resp.latest_recommender_update.recommender_config.events_config.event_parameters_list #=> Array
|
|
3913
4048
|
# resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_type #=> String
|
|
3914
4049
|
# resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
|
|
4050
|
+
# resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
|
|
3915
4051
|
# resp.latest_recommender_update.recommender_config.training_frequency #=> Integer
|
|
4052
|
+
# resp.latest_recommender_update.recommender_config.inference_config.min_provisioned_tps #=> Integer
|
|
3916
4053
|
# resp.latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
|
|
3917
4054
|
# resp.latest_recommender_update.created_at #=> Time
|
|
3918
4055
|
# resp.latest_recommender_update.last_updated_at #=> Time
|
|
@@ -3933,6 +4070,51 @@ module Aws::CustomerProfiles
|
|
|
3933
4070
|
req.send_request(options)
|
|
3934
4071
|
end
|
|
3935
4072
|
|
|
4073
|
+
# Retrieves information about a specific recommender filter in a domain.
|
|
4074
|
+
#
|
|
4075
|
+
# @option params [required, String] :domain_name
|
|
4076
|
+
# The unique name of the domain.
|
|
4077
|
+
#
|
|
4078
|
+
# @option params [required, String] :recommender_filter_name
|
|
4079
|
+
# The name of the recommender filter to retrieve.
|
|
4080
|
+
#
|
|
4081
|
+
# @return [Types::GetRecommenderFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4082
|
+
#
|
|
4083
|
+
# * {Types::GetRecommenderFilterResponse#recommender_filter_name #recommender_filter_name} => String
|
|
4084
|
+
# * {Types::GetRecommenderFilterResponse#recommender_filter_expression #recommender_filter_expression} => String
|
|
4085
|
+
# * {Types::GetRecommenderFilterResponse#created_at #created_at} => Time
|
|
4086
|
+
# * {Types::GetRecommenderFilterResponse#status #status} => String
|
|
4087
|
+
# * {Types::GetRecommenderFilterResponse#description #description} => String
|
|
4088
|
+
# * {Types::GetRecommenderFilterResponse#failure_reason #failure_reason} => String
|
|
4089
|
+
# * {Types::GetRecommenderFilterResponse#tags #tags} => Hash<String,String>
|
|
4090
|
+
#
|
|
4091
|
+
# @example Request syntax with placeholder values
|
|
4092
|
+
#
|
|
4093
|
+
# resp = client.get_recommender_filter({
|
|
4094
|
+
# domain_name: "name", # required
|
|
4095
|
+
# recommender_filter_name: "RecommenderFilterName", # required
|
|
4096
|
+
# })
|
|
4097
|
+
#
|
|
4098
|
+
# @example Response structure
|
|
4099
|
+
#
|
|
4100
|
+
# resp.recommender_filter_name #=> String
|
|
4101
|
+
# resp.recommender_filter_expression #=> String
|
|
4102
|
+
# resp.created_at #=> Time
|
|
4103
|
+
# resp.status #=> String, one of "ACTIVE", "PENDING", "IN_PROGRESS", "FAILED", "DELETING"
|
|
4104
|
+
# resp.description #=> String
|
|
4105
|
+
# resp.failure_reason #=> String
|
|
4106
|
+
# resp.tags #=> Hash
|
|
4107
|
+
# resp.tags["TagKey"] #=> String
|
|
4108
|
+
#
|
|
4109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetRecommenderFilter AWS API Documentation
|
|
4110
|
+
#
|
|
4111
|
+
# @overload get_recommender_filter(params = {})
|
|
4112
|
+
# @param [Hash] params ({})
|
|
4113
|
+
def get_recommender_filter(params = {}, options = {})
|
|
4114
|
+
req = build_request(:get_recommender_filter, params)
|
|
4115
|
+
req.send_request(options)
|
|
4116
|
+
end
|
|
4117
|
+
|
|
3936
4118
|
# Gets a segment definition from the domain.
|
|
3937
4119
|
#
|
|
3938
4120
|
# @option params [required, String] :domain_name
|
|
@@ -5381,6 +5563,7 @@ module Aws::CustomerProfiles
|
|
|
5381
5563
|
# resp.items[0].last_updated_at #=> Time
|
|
5382
5564
|
# resp.items[0].max_profile_object_count #=> Integer
|
|
5383
5565
|
# resp.items[0].max_available_profile_object_count #=> Integer
|
|
5566
|
+
# resp.items[0].source_priority #=> Integer
|
|
5384
5567
|
# resp.items[0].tags #=> Hash
|
|
5385
5568
|
# resp.items[0].tags["TagKey"] #=> String
|
|
5386
5569
|
# resp.next_token #=> String
|
|
@@ -5452,6 +5635,56 @@ module Aws::CustomerProfiles
|
|
|
5452
5635
|
req.send_request(options)
|
|
5453
5636
|
end
|
|
5454
5637
|
|
|
5638
|
+
# Returns a list of recommender filters in the specified domain.
|
|
5639
|
+
#
|
|
5640
|
+
# @option params [required, String] :domain_name
|
|
5641
|
+
# The unique name of the domain.
|
|
5642
|
+
#
|
|
5643
|
+
# @option params [Integer] :max_results
|
|
5644
|
+
# The maximum number of recommender filters to return in the response.
|
|
5645
|
+
# The default value is 100.
|
|
5646
|
+
#
|
|
5647
|
+
# @option params [String] :next_token
|
|
5648
|
+
# A token received from a previous ListRecommenderFilters call to
|
|
5649
|
+
# retrieve the next page of results.
|
|
5650
|
+
#
|
|
5651
|
+
# @return [Types::ListRecommenderFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5652
|
+
#
|
|
5653
|
+
# * {Types::ListRecommenderFiltersResponse#next_token #next_token} => String
|
|
5654
|
+
# * {Types::ListRecommenderFiltersResponse#recommender_filters #recommender_filters} => Array<Types::RecommenderFilterSummary>
|
|
5655
|
+
#
|
|
5656
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5657
|
+
#
|
|
5658
|
+
# @example Request syntax with placeholder values
|
|
5659
|
+
#
|
|
5660
|
+
# resp = client.list_recommender_filters({
|
|
5661
|
+
# domain_name: "name", # required
|
|
5662
|
+
# max_results: 1,
|
|
5663
|
+
# next_token: "token",
|
|
5664
|
+
# })
|
|
5665
|
+
#
|
|
5666
|
+
# @example Response structure
|
|
5667
|
+
#
|
|
5668
|
+
# resp.next_token #=> String
|
|
5669
|
+
# resp.recommender_filters #=> Array
|
|
5670
|
+
# resp.recommender_filters[0].recommender_filter_name #=> String
|
|
5671
|
+
# resp.recommender_filters[0].recommender_filter_expression #=> String
|
|
5672
|
+
# resp.recommender_filters[0].created_at #=> Time
|
|
5673
|
+
# resp.recommender_filters[0].description #=> String
|
|
5674
|
+
# resp.recommender_filters[0].status #=> String, one of "ACTIVE", "PENDING", "IN_PROGRESS", "FAILED", "DELETING"
|
|
5675
|
+
# resp.recommender_filters[0].failure_reason #=> String
|
|
5676
|
+
# resp.recommender_filters[0].tags #=> Hash
|
|
5677
|
+
# resp.recommender_filters[0].tags["TagKey"] #=> String
|
|
5678
|
+
#
|
|
5679
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenderFilters AWS API Documentation
|
|
5680
|
+
#
|
|
5681
|
+
# @overload list_recommender_filters(params = {})
|
|
5682
|
+
# @param [Hash] params ({})
|
|
5683
|
+
def list_recommender_filters(params = {}, options = {})
|
|
5684
|
+
req = build_request(:list_recommender_filters, params)
|
|
5685
|
+
req.send_request(options)
|
|
5686
|
+
end
|
|
5687
|
+
|
|
5455
5688
|
# Returns a list of available recommender recipes that can be used to
|
|
5456
5689
|
# create recommenders.
|
|
5457
5690
|
#
|
|
@@ -5481,7 +5714,7 @@ module Aws::CustomerProfiles
|
|
|
5481
5714
|
#
|
|
5482
5715
|
# resp.next_token #=> String
|
|
5483
5716
|
# resp.recommender_recipes #=> Array
|
|
5484
|
-
# resp.recommender_recipes[0].name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now"
|
|
5717
|
+
# resp.recommender_recipes[0].name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now", "personalized-ranking"
|
|
5485
5718
|
# resp.recommender_recipes[0].description #=> String
|
|
5486
5719
|
#
|
|
5487
5720
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenderRecipes AWS API Documentation
|
|
@@ -5526,11 +5759,13 @@ module Aws::CustomerProfiles
|
|
|
5526
5759
|
# resp.next_token #=> String
|
|
5527
5760
|
# resp.recommenders #=> Array
|
|
5528
5761
|
# resp.recommenders[0].recommender_name #=> String
|
|
5529
|
-
# resp.recommenders[0].recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now"
|
|
5762
|
+
# resp.recommenders[0].recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now", "personalized-ranking"
|
|
5530
5763
|
# resp.recommenders[0].recommender_config.events_config.event_parameters_list #=> Array
|
|
5531
5764
|
# resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_type #=> String
|
|
5532
5765
|
# resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
|
|
5766
|
+
# resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
|
|
5533
5767
|
# resp.recommenders[0].recommender_config.training_frequency #=> Integer
|
|
5768
|
+
# resp.recommenders[0].recommender_config.inference_config.min_provisioned_tps #=> Integer
|
|
5534
5769
|
# resp.recommenders[0].created_at #=> Time
|
|
5535
5770
|
# resp.recommenders[0].description #=> String
|
|
5536
5771
|
# resp.recommenders[0].status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
|
|
@@ -5541,7 +5776,9 @@ module Aws::CustomerProfiles
|
|
|
5541
5776
|
# resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list #=> Array
|
|
5542
5777
|
# resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_type #=> String
|
|
5543
5778
|
# resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
|
|
5779
|
+
# resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
|
|
5544
5780
|
# resp.recommenders[0].latest_recommender_update.recommender_config.training_frequency #=> Integer
|
|
5781
|
+
# resp.recommenders[0].latest_recommender_update.recommender_config.inference_config.min_provisioned_tps #=> Integer
|
|
5545
5782
|
# resp.recommenders[0].latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
|
|
5546
5783
|
# resp.recommenders[0].latest_recommender_update.created_at #=> Time
|
|
5547
5784
|
# resp.recommenders[0].latest_recommender_update.last_updated_at #=> Time
|
|
@@ -6241,6 +6478,12 @@ module Aws::CustomerProfiles
|
|
|
6241
6478
|
# @option params [Integer] :max_profile_object_count
|
|
6242
6479
|
# The amount of profile object max count assigned to the object type
|
|
6243
6480
|
#
|
|
6481
|
+
# @option params [Integer] :source_priority
|
|
6482
|
+
# An integer that determines the priority of this object type when data
|
|
6483
|
+
# from multiple sources is ingested. Lower values take priority. Object
|
|
6484
|
+
# types without a specified source priority default to the lowest
|
|
6485
|
+
# priority.
|
|
6486
|
+
#
|
|
6244
6487
|
# @option params [Hash<String,Types::ObjectTypeField>] :fields
|
|
6245
6488
|
# A map of the name and ObjectType field.
|
|
6246
6489
|
#
|
|
@@ -6261,6 +6504,7 @@ module Aws::CustomerProfiles
|
|
|
6261
6504
|
# * {Types::PutProfileObjectTypeResponse#source_last_updated_timestamp_format #source_last_updated_timestamp_format} => String
|
|
6262
6505
|
# * {Types::PutProfileObjectTypeResponse#max_profile_object_count #max_profile_object_count} => Integer
|
|
6263
6506
|
# * {Types::PutProfileObjectTypeResponse#max_available_profile_object_count #max_available_profile_object_count} => Integer
|
|
6507
|
+
# * {Types::PutProfileObjectTypeResponse#source_priority #source_priority} => Integer
|
|
6264
6508
|
# * {Types::PutProfileObjectTypeResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
|
6265
6509
|
# * {Types::PutProfileObjectTypeResponse#keys #keys} => Hash<String,Array<Types::ObjectTypeKey>>
|
|
6266
6510
|
# * {Types::PutProfileObjectTypeResponse#created_at #created_at} => Time
|
|
@@ -6279,6 +6523,7 @@ module Aws::CustomerProfiles
|
|
|
6279
6523
|
# allow_profile_creation: false,
|
|
6280
6524
|
# source_last_updated_timestamp_format: "string1To255",
|
|
6281
6525
|
# max_profile_object_count: 1,
|
|
6526
|
+
# source_priority: 1,
|
|
6282
6527
|
# fields: {
|
|
6283
6528
|
# "fieldName" => {
|
|
6284
6529
|
# source: "text",
|
|
@@ -6289,7 +6534,7 @@ module Aws::CustomerProfiles
|
|
|
6289
6534
|
# keys: {
|
|
6290
6535
|
# "name" => [
|
|
6291
6536
|
# {
|
|
6292
|
-
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, ORDER, COMMUNICATION_RECORD, AIR_PREFERENCE, HOTEL_PREFERENCE, AIR_BOOKING, AIR_SEGMENT, HOTEL_RESERVATION, HOTEL_STAY_REVENUE, LOYALTY, LOYALTY_TRANSACTION, LOYALTY_PROMOTION, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
|
6537
|
+
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, DEVICE, WEB_ANALYTICS, ORDER, COMMUNICATION_RECORD, AIR_PREFERENCE, HOTEL_PREFERENCE, AIR_BOOKING, AIR_SEGMENT, HOTEL_RESERVATION, HOTEL_STAY_REVENUE, LOYALTY, LOYALTY_TRANSACTION, LOYALTY_PROMOTION, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
|
6293
6538
|
# field_names: ["name"],
|
|
6294
6539
|
# },
|
|
6295
6540
|
# ],
|
|
@@ -6310,6 +6555,7 @@ module Aws::CustomerProfiles
|
|
|
6310
6555
|
# resp.source_last_updated_timestamp_format #=> String
|
|
6311
6556
|
# resp.max_profile_object_count #=> Integer
|
|
6312
6557
|
# resp.max_available_profile_object_count #=> Integer
|
|
6558
|
+
# resp.source_priority #=> Integer
|
|
6313
6559
|
# resp.fields #=> Hash
|
|
6314
6560
|
# resp.fields["fieldName"].source #=> String
|
|
6315
6561
|
# resp.fields["fieldName"].target #=> String
|
|
@@ -6317,7 +6563,7 @@ module Aws::CustomerProfiles
|
|
|
6317
6563
|
# resp.keys #=> Hash
|
|
6318
6564
|
# resp.keys["name"] #=> Array
|
|
6319
6565
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
|
6320
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
6566
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "DEVICE", "WEB_ANALYTICS", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
6321
6567
|
# resp.keys["name"][0].field_names #=> Array
|
|
6322
6568
|
# resp.keys["name"][0].field_names[0] #=> String
|
|
6323
6569
|
# resp.created_at #=> Time
|
|
@@ -7409,15 +7655,19 @@ module Aws::CustomerProfiles
|
|
|
7409
7655
|
# recommender_name: "name", # required
|
|
7410
7656
|
# description: "sensitiveText",
|
|
7411
7657
|
# recommender_config: {
|
|
7412
|
-
# events_config: {
|
|
7658
|
+
# events_config: {
|
|
7413
7659
|
# event_parameters_list: [ # required
|
|
7414
7660
|
# {
|
|
7415
7661
|
# event_type: "EventParametersEventTypeString", # required
|
|
7416
7662
|
# event_value_threshold: 1.0,
|
|
7663
|
+
# event_weight: 1.0,
|
|
7417
7664
|
# },
|
|
7418
7665
|
# ],
|
|
7419
7666
|
# },
|
|
7420
7667
|
# training_frequency: 1,
|
|
7668
|
+
# inference_config: {
|
|
7669
|
+
# min_provisioned_tps: 1,
|
|
7670
|
+
# },
|
|
7421
7671
|
# },
|
|
7422
7672
|
# })
|
|
7423
7673
|
#
|
|
@@ -7452,7 +7702,7 @@ module Aws::CustomerProfiles
|
|
|
7452
7702
|
tracer: tracer
|
|
7453
7703
|
)
|
|
7454
7704
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
|
7455
|
-
context[:gem_version] = '1.
|
|
7705
|
+
context[:gem_version] = '1.81.0'
|
|
7456
7706
|
Seahorse::Client::Request.new(handlers, context)
|
|
7457
7707
|
end
|
|
7458
7708
|
|