aws-sdk-customerprofiles 1.83.0 → 1.85.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '098ee60b649bbecf6ccd20738d91dc32d4e847fc396e48d785994b47a196108b'
4
- data.tar.gz: 4ff1a09307e275a40ed7f6a954db82ccafcda349f4625dce16a1d342178bedce
3
+ metadata.gz: 1180ff282aefd5695a3b87ca8eb8cfe75eea06717bc043e20f8e4862ca016932
4
+ data.tar.gz: 35a9f849bf5fa0a05b714f132f912433160ee91111c32b7e022d696124f9ef1a
5
5
  SHA512:
6
- metadata.gz: 0d0b4024a098428ae397529af1a57c7bb99644946edfb87dc58e9743c2ca405a317186d4828102fe9ff8383384ee1cbf4c03d71218f5efb6639d8d3bf1447535
7
- data.tar.gz: '09ae9e681e41d68c47d045b61cfea40361765789e5785e9b7ae7791a1550271e9a8487be4a625b49e56a906dda9a3e63342176a3810127cbd0d16e86af83ed58'
6
+ metadata.gz: '09618dbe37255a79b6b5f2dec79811b90cff1dd775fd7254da7af71cc94ae1370cf45c8cf8c7a55240b2d7c291ea202e54d47db1532c0dd0190c6c4d78f06ca0'
7
+ data.tar.gz: 603277939e172fb077bdba972f4f41a806a66347e40a370d88462ac0a558c0a3f6a5cbb11a63f41c47c45f91b05c2da4466d4102222cbc3ebb17f5b7e2c98a8a
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.85.0 (2026-05-13)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.84.0 (2026-04-16)
10
+ ------------------
11
+
12
+ * Feature - Amazon Connect Customer Profiles adds RecommenderSchema CRUD APIs for custom ML training columns. CreateRecommender and CreateRecommenderFilter now accept optional RecommenderSchemaName.
13
+
4
14
  1.83.0 (2026-04-13)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.83.0
1
+ 1.85.0
@@ -1684,6 +1684,10 @@ module Aws::CustomerProfiles
1684
1684
  # @option params [String] :description
1685
1685
  # The description of the domain object type.
1686
1686
  #
1687
+ # @option params [String] :recommender_schema_name
1688
+ # The name of the recommender schema to use for this recommender. If not
1689
+ # specified, the default schema is used.
1690
+ #
1687
1691
  # @option params [Hash<String,String>] :tags
1688
1692
  # The tags used to organize, track, or control access for this resource.
1689
1693
  #
@@ -1712,8 +1716,12 @@ module Aws::CustomerProfiles
1712
1716
  # inference_config: {
1713
1717
  # min_provisioned_tps: 1,
1714
1718
  # },
1719
+ # included_columns: {
1720
+ # "String" => ["text"],
1721
+ # },
1715
1722
  # },
1716
1723
  # description: "sensitiveText",
1724
+ # recommender_schema_name: "name",
1717
1725
  # tags: {
1718
1726
  # "TagKey" => "TagValue",
1719
1727
  # },
@@ -1748,6 +1756,10 @@ module Aws::CustomerProfiles
1748
1756
  # The filter expression that defines which items to include or exclude
1749
1757
  # from recommendations.
1750
1758
  #
1759
+ # @option params [String] :recommender_schema_name
1760
+ # The name of the recommender schema to use for this recommender filter.
1761
+ # If not specified, the default schema is used.
1762
+ #
1751
1763
  # @option params [String] :description
1752
1764
  # A description of the recommender filter.
1753
1765
  #
@@ -1765,6 +1777,7 @@ module Aws::CustomerProfiles
1765
1777
  # domain_name: "name", # required
1766
1778
  # recommender_filter_name: "RecommenderFilterName", # required
1767
1779
  # recommender_filter_expression: "RecommenderFilterExpression", # required
1780
+ # recommender_schema_name: "name",
1768
1781
  # description: "sensitiveText",
1769
1782
  # tags: {
1770
1783
  # "TagKey" => "TagValue",
@@ -1786,6 +1799,76 @@ module Aws::CustomerProfiles
1786
1799
  req.send_request(options)
1787
1800
  end
1788
1801
 
1802
+ # Creates a recommender schema. A recommender schema defines the set of
1803
+ # data columns available for training recommenders and filters under a
1804
+ # domain.
1805
+ #
1806
+ # @option params [required, String] :domain_name
1807
+ # The unique name of the domain.
1808
+ #
1809
+ # @option params [required, String] :recommender_schema_name
1810
+ # The name of the recommender schema. The name must be unique within the
1811
+ # domain.
1812
+ #
1813
+ # @option params [required, Hash<String,Array>] :fields
1814
+ # A map of dataset type to column definitions that specifies which data
1815
+ # columns to include in the schema. Currently only the `_webAnalytics`
1816
+ # key is supported.
1817
+ #
1818
+ # @option params [Hash<String,String>] :tags
1819
+ # The tags used to organize, track, or control access for this resource.
1820
+ #
1821
+ # @return [Types::CreateRecommenderSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1822
+ #
1823
+ # * {Types::CreateRecommenderSchemaResponse#recommender_schema_arn #recommender_schema_arn} => String
1824
+ # * {Types::CreateRecommenderSchemaResponse#recommender_schema_name #recommender_schema_name} => String
1825
+ # * {Types::CreateRecommenderSchemaResponse#fields #fields} => Hash&lt;String,Array&lt;Types::RecommenderSchemaField&gt;&gt;
1826
+ # * {Types::CreateRecommenderSchemaResponse#created_at #created_at} => Time
1827
+ # * {Types::CreateRecommenderSchemaResponse#status #status} => String
1828
+ # * {Types::CreateRecommenderSchemaResponse#tags #tags} => Hash&lt;String,String&gt;
1829
+ #
1830
+ # @example Request syntax with placeholder values
1831
+ #
1832
+ # resp = client.create_recommender_schema({
1833
+ # domain_name: "name", # required
1834
+ # recommender_schema_name: "name", # required
1835
+ # fields: { # required
1836
+ # "String" => [
1837
+ # {
1838
+ # target_field_name: "text", # required
1839
+ # content_type: "STRING", # accepts STRING, NUMBER
1840
+ # feature_type: "TEXTUAL", # accepts TEXTUAL, CATEGORICAL
1841
+ # },
1842
+ # ],
1843
+ # },
1844
+ # tags: {
1845
+ # "TagKey" => "TagValue",
1846
+ # },
1847
+ # })
1848
+ #
1849
+ # @example Response structure
1850
+ #
1851
+ # resp.recommender_schema_arn #=> String
1852
+ # resp.recommender_schema_name #=> String
1853
+ # resp.fields #=> Hash
1854
+ # resp.fields["String"] #=> Array
1855
+ # resp.fields["String"][0].target_field_name #=> String
1856
+ # resp.fields["String"][0].content_type #=> String, one of "STRING", "NUMBER"
1857
+ # resp.fields["String"][0].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
1858
+ # resp.created_at #=> Time
1859
+ # resp.status #=> String, one of "ACTIVE", "DELETING"
1860
+ # resp.tags #=> Hash
1861
+ # resp.tags["TagKey"] #=> String
1862
+ #
1863
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateRecommenderSchema AWS API Documentation
1864
+ #
1865
+ # @overload create_recommender_schema(params = {})
1866
+ # @param [Hash] params ({})
1867
+ def create_recommender_schema(params = {}, options = {})
1868
+ req = build_request(:create_recommender_schema, params)
1869
+ req.send_request(options)
1870
+ end
1871
+
1789
1872
  # Creates a segment definition associated to the given domain.
1790
1873
  #
1791
1874
  # @option params [required, String] :domain_name
@@ -2855,6 +2938,32 @@ module Aws::CustomerProfiles
2855
2938
  req.send_request(options)
2856
2939
  end
2857
2940
 
2941
+ # Deletes a recommender schema from a domain.
2942
+ #
2943
+ # @option params [required, String] :domain_name
2944
+ # The unique name of the domain.
2945
+ #
2946
+ # @option params [required, String] :recommender_schema_name
2947
+ # The name of the recommender schema to delete.
2948
+ #
2949
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2950
+ #
2951
+ # @example Request syntax with placeholder values
2952
+ #
2953
+ # resp = client.delete_recommender_schema({
2954
+ # domain_name: "name", # required
2955
+ # recommender_schema_name: "name", # required
2956
+ # })
2957
+ #
2958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteRecommenderSchema AWS API Documentation
2959
+ #
2960
+ # @overload delete_recommender_schema(params = {})
2961
+ # @param [Hash] params ({})
2962
+ def delete_recommender_schema(params = {}, options = {})
2963
+ req = build_request(:delete_recommender_schema, params)
2964
+ req.send_request(options)
2965
+ end
2966
+
2858
2967
  # Deletes a segment definition from the domain.
2859
2968
  #
2860
2969
  # @option params [required, String] :domain_name
@@ -4024,6 +4133,7 @@ module Aws::CustomerProfiles
4024
4133
  #
4025
4134
  # * {Types::GetRecommenderResponse#recommender_name #recommender_name} => String
4026
4135
  # * {Types::GetRecommenderResponse#recommender_recipe_name #recommender_recipe_name} => String
4136
+ # * {Types::GetRecommenderResponse#recommender_schema_name #recommender_schema_name} => String
4027
4137
  # * {Types::GetRecommenderResponse#recommender_config #recommender_config} => Types::RecommenderConfig
4028
4138
  # * {Types::GetRecommenderResponse#description #description} => String
4029
4139
  # * {Types::GetRecommenderResponse#status #status} => String
@@ -4046,12 +4156,16 @@ module Aws::CustomerProfiles
4046
4156
  #
4047
4157
  # resp.recommender_name #=> String
4048
4158
  # resp.recommender_recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now", "personalized-ranking"
4159
+ # resp.recommender_schema_name #=> String
4049
4160
  # resp.recommender_config.events_config.event_parameters_list #=> Array
4050
4161
  # resp.recommender_config.events_config.event_parameters_list[0].event_type #=> String
4051
4162
  # resp.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
4052
4163
  # resp.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
4053
4164
  # resp.recommender_config.training_frequency #=> Integer
4054
4165
  # resp.recommender_config.inference_config.min_provisioned_tps #=> Integer
4166
+ # resp.recommender_config.included_columns #=> Hash
4167
+ # resp.recommender_config.included_columns["String"] #=> Array
4168
+ # resp.recommender_config.included_columns["String"][0] #=> String
4055
4169
  # resp.description #=> String
4056
4170
  # resp.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
4057
4171
  # resp.last_updated_at #=> Time
@@ -4063,6 +4177,9 @@ module Aws::CustomerProfiles
4063
4177
  # resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
4064
4178
  # resp.latest_recommender_update.recommender_config.training_frequency #=> Integer
4065
4179
  # resp.latest_recommender_update.recommender_config.inference_config.min_provisioned_tps #=> Integer
4180
+ # resp.latest_recommender_update.recommender_config.included_columns #=> Hash
4181
+ # resp.latest_recommender_update.recommender_config.included_columns["String"] #=> Array
4182
+ # resp.latest_recommender_update.recommender_config.included_columns["String"][0] #=> String
4066
4183
  # resp.latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
4067
4184
  # resp.latest_recommender_update.created_at #=> Time
4068
4185
  # resp.latest_recommender_update.last_updated_at #=> Time
@@ -4095,6 +4212,7 @@ module Aws::CustomerProfiles
4095
4212
  #
4096
4213
  # * {Types::GetRecommenderFilterResponse#recommender_filter_name #recommender_filter_name} => String
4097
4214
  # * {Types::GetRecommenderFilterResponse#recommender_filter_expression #recommender_filter_expression} => String
4215
+ # * {Types::GetRecommenderFilterResponse#recommender_schema_name #recommender_schema_name} => String
4098
4216
  # * {Types::GetRecommenderFilterResponse#created_at #created_at} => Time
4099
4217
  # * {Types::GetRecommenderFilterResponse#status #status} => String
4100
4218
  # * {Types::GetRecommenderFilterResponse#description #description} => String
@@ -4112,6 +4230,7 @@ module Aws::CustomerProfiles
4112
4230
  #
4113
4231
  # resp.recommender_filter_name #=> String
4114
4232
  # resp.recommender_filter_expression #=> String
4233
+ # resp.recommender_schema_name #=> String
4115
4234
  # resp.created_at #=> Time
4116
4235
  # resp.status #=> String, one of "ACTIVE", "PENDING", "IN_PROGRESS", "FAILED", "DELETING"
4117
4236
  # resp.description #=> String
@@ -4128,6 +4247,48 @@ module Aws::CustomerProfiles
4128
4247
  req.send_request(options)
4129
4248
  end
4130
4249
 
4250
+ # Retrieves information about a specific recommender schema in a domain.
4251
+ #
4252
+ # @option params [required, String] :domain_name
4253
+ # The unique name of the domain.
4254
+ #
4255
+ # @option params [required, String] :recommender_schema_name
4256
+ # The name of the recommender schema to retrieve.
4257
+ #
4258
+ # @return [Types::GetRecommenderSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4259
+ #
4260
+ # * {Types::GetRecommenderSchemaResponse#recommender_schema_name #recommender_schema_name} => String
4261
+ # * {Types::GetRecommenderSchemaResponse#fields #fields} => Hash&lt;String,Array&lt;Types::RecommenderSchemaField&gt;&gt;
4262
+ # * {Types::GetRecommenderSchemaResponse#created_at #created_at} => Time
4263
+ # * {Types::GetRecommenderSchemaResponse#status #status} => String
4264
+ #
4265
+ # @example Request syntax with placeholder values
4266
+ #
4267
+ # resp = client.get_recommender_schema({
4268
+ # domain_name: "name", # required
4269
+ # recommender_schema_name: "name", # required
4270
+ # })
4271
+ #
4272
+ # @example Response structure
4273
+ #
4274
+ # resp.recommender_schema_name #=> String
4275
+ # resp.fields #=> Hash
4276
+ # resp.fields["String"] #=> Array
4277
+ # resp.fields["String"][0].target_field_name #=> String
4278
+ # resp.fields["String"][0].content_type #=> String, one of "STRING", "NUMBER"
4279
+ # resp.fields["String"][0].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
4280
+ # resp.created_at #=> Time
4281
+ # resp.status #=> String, one of "ACTIVE", "DELETING"
4282
+ #
4283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetRecommenderSchema AWS API Documentation
4284
+ #
4285
+ # @overload get_recommender_schema(params = {})
4286
+ # @param [Hash] params ({})
4287
+ def get_recommender_schema(params = {}, options = {})
4288
+ req = build_request(:get_recommender_schema, params)
4289
+ req.send_request(options)
4290
+ end
4291
+
4131
4292
  # Gets a segment definition from the domain.
4132
4293
  #
4133
4294
  # @option params [required, String] :domain_name
@@ -5687,6 +5848,7 @@ module Aws::CustomerProfiles
5687
5848
  # resp.next_token #=> String
5688
5849
  # resp.recommender_filters #=> Array
5689
5850
  # resp.recommender_filters[0].recommender_filter_name #=> String
5851
+ # resp.recommender_filters[0].recommender_schema_name #=> String
5690
5852
  # resp.recommender_filters[0].recommender_filter_expression #=> String
5691
5853
  # resp.recommender_filters[0].created_at #=> Time
5692
5854
  # resp.recommender_filters[0].description #=> String
@@ -5745,6 +5907,56 @@ module Aws::CustomerProfiles
5745
5907
  req.send_request(options)
5746
5908
  end
5747
5909
 
5910
+ # Returns a list of recommender schemas in the specified domain.
5911
+ #
5912
+ # @option params [required, String] :domain_name
5913
+ # The unique name of the domain.
5914
+ #
5915
+ # @option params [Integer] :max_results
5916
+ # The maximum number of recommender schemas to return in the response.
5917
+ # The default value is 100.
5918
+ #
5919
+ # @option params [String] :next_token
5920
+ # A token received from a previous ListRecommenderSchemas call to
5921
+ # retrieve the next page of results.
5922
+ #
5923
+ # @return [Types::ListRecommenderSchemasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5924
+ #
5925
+ # * {Types::ListRecommenderSchemasResponse#next_token #next_token} => String
5926
+ # * {Types::ListRecommenderSchemasResponse#recommender_schemas #recommender_schemas} => Array&lt;Types::RecommenderSchemaSummary&gt;
5927
+ #
5928
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5929
+ #
5930
+ # @example Request syntax with placeholder values
5931
+ #
5932
+ # resp = client.list_recommender_schemas({
5933
+ # domain_name: "name", # required
5934
+ # max_results: 1,
5935
+ # next_token: "token",
5936
+ # })
5937
+ #
5938
+ # @example Response structure
5939
+ #
5940
+ # resp.next_token #=> String
5941
+ # resp.recommender_schemas #=> Array
5942
+ # resp.recommender_schemas[0].recommender_schema_name #=> String
5943
+ # resp.recommender_schemas[0].fields #=> Hash
5944
+ # resp.recommender_schemas[0].fields["String"] #=> Array
5945
+ # resp.recommender_schemas[0].fields["String"][0].target_field_name #=> String
5946
+ # resp.recommender_schemas[0].fields["String"][0].content_type #=> String, one of "STRING", "NUMBER"
5947
+ # resp.recommender_schemas[0].fields["String"][0].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
5948
+ # resp.recommender_schemas[0].created_at #=> Time
5949
+ # resp.recommender_schemas[0].status #=> String, one of "ACTIVE", "DELETING"
5950
+ #
5951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenderSchemas AWS API Documentation
5952
+ #
5953
+ # @overload list_recommender_schemas(params = {})
5954
+ # @param [Hash] params ({})
5955
+ def list_recommender_schemas(params = {}, options = {})
5956
+ req = build_request(:list_recommender_schemas, params)
5957
+ req.send_request(options)
5958
+ end
5959
+
5748
5960
  # Returns a list of recommenders in the specified domain.
5749
5961
  #
5750
5962
  # @option params [required, String] :domain_name
@@ -5779,12 +5991,16 @@ module Aws::CustomerProfiles
5779
5991
  # resp.recommenders #=> Array
5780
5992
  # resp.recommenders[0].recommender_name #=> String
5781
5993
  # resp.recommenders[0].recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now", "personalized-ranking"
5994
+ # resp.recommenders[0].recommender_schema_name #=> String
5782
5995
  # resp.recommenders[0].recommender_config.events_config.event_parameters_list #=> Array
5783
5996
  # resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_type #=> String
5784
5997
  # resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
5785
5998
  # resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
5786
5999
  # resp.recommenders[0].recommender_config.training_frequency #=> Integer
5787
6000
  # resp.recommenders[0].recommender_config.inference_config.min_provisioned_tps #=> Integer
6001
+ # resp.recommenders[0].recommender_config.included_columns #=> Hash
6002
+ # resp.recommenders[0].recommender_config.included_columns["String"] #=> Array
6003
+ # resp.recommenders[0].recommender_config.included_columns["String"][0] #=> String
5788
6004
  # resp.recommenders[0].created_at #=> Time
5789
6005
  # resp.recommenders[0].description #=> String
5790
6006
  # resp.recommenders[0].status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
@@ -5798,6 +6014,9 @@ module Aws::CustomerProfiles
5798
6014
  # resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
5799
6015
  # resp.recommenders[0].latest_recommender_update.recommender_config.training_frequency #=> Integer
5800
6016
  # resp.recommenders[0].latest_recommender_update.recommender_config.inference_config.min_provisioned_tps #=> Integer
6017
+ # resp.recommenders[0].latest_recommender_update.recommender_config.included_columns #=> Hash
6018
+ # resp.recommenders[0].latest_recommender_update.recommender_config.included_columns["String"] #=> Array
6019
+ # resp.recommenders[0].latest_recommender_update.recommender_config.included_columns["String"][0] #=> String
5801
6020
  # resp.recommenders[0].latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
5802
6021
  # resp.recommenders[0].latest_recommender_update.created_at #=> Time
5803
6022
  # resp.recommenders[0].latest_recommender_update.last_updated_at #=> Time
@@ -7687,6 +7906,9 @@ module Aws::CustomerProfiles
7687
7906
  # inference_config: {
7688
7907
  # min_provisioned_tps: 1,
7689
7908
  # },
7909
+ # included_columns: {
7910
+ # "String" => ["text"],
7911
+ # },
7690
7912
  # },
7691
7913
  # })
7692
7914
  #
@@ -7721,7 +7943,7 @@ module Aws::CustomerProfiles
7721
7943
  tracer: tracer
7722
7944
  )
7723
7945
  context[:gem_name] = 'aws-sdk-customerprofiles'
7724
- context[:gem_version] = '1.83.0'
7946
+ context[:gem_version] = '1.85.0'
7725
7947
  Seahorse::Client::Request.new(handlers, context)
7726
7948
  end
7727
7949