aws-sdk-customerprofiles 1.75.0 → 1.76.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.
@@ -944,6 +944,9 @@ module Aws::CustomerProfiles
944
944
  # review the results. Also, if you have configured `ExportingConfig` in
945
945
  # the `RuleBasedMatchingRequest`, you can download the results from S3.
946
946
  #
947
+ # @option params [Types::DataStoreRequest] :data_store
948
+ # Set to true to enabled data store for this domain.
949
+ #
947
950
  # @option params [Hash<String,String>] :tags
948
951
  # The tags used to organize, track, or control access for this resource.
949
952
  #
@@ -955,6 +958,7 @@ module Aws::CustomerProfiles
955
958
  # * {Types::CreateDomainResponse#dead_letter_queue_url #dead_letter_queue_url} => String
956
959
  # * {Types::CreateDomainResponse#matching #matching} => Types::MatchingResponse
957
960
  # * {Types::CreateDomainResponse#rule_based_matching #rule_based_matching} => Types::RuleBasedMatchingResponse
961
+ # * {Types::CreateDomainResponse#data_store #data_store} => Types::DataStoreResponse
958
962
  # * {Types::CreateDomainResponse#created_at #created_at} => Time
959
963
  # * {Types::CreateDomainResponse#last_updated_at #last_updated_at} => Time
960
964
  # * {Types::CreateDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -1018,6 +1022,9 @@ module Aws::CustomerProfiles
1018
1022
  # },
1019
1023
  # },
1020
1024
  # },
1025
+ # data_store: {
1026
+ # enabled: false,
1027
+ # },
1021
1028
  # tags: {
1022
1029
  # "TagKey" => "TagValue",
1023
1030
  # },
@@ -1059,6 +1066,9 @@ module Aws::CustomerProfiles
1059
1066
  # resp.rule_based_matching.conflict_resolution.source_name #=> String
1060
1067
  # resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
1061
1068
  # resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
1069
+ # resp.data_store.enabled #=> Boolean
1070
+ # resp.data_store.readiness.progress_percentage #=> Integer
1071
+ # resp.data_store.readiness.message #=> String
1062
1072
  # resp.created_at #=> Time
1063
1073
  # resp.last_updated_at #=> Time
1064
1074
  # resp.tags #=> Hash
@@ -1657,6 +1667,69 @@ module Aws::CustomerProfiles
1657
1667
  req.send_request(options)
1658
1668
  end
1659
1669
 
1670
+ # Creates a recommender
1671
+ #
1672
+ # @option params [required, String] :domain_name
1673
+ # The unique name of the domain.
1674
+ #
1675
+ # @option params [required, String] :recommender_name
1676
+ # The name of the recommender.
1677
+ #
1678
+ # @option params [required, String] :recommender_recipe_name
1679
+ # The name of the recommeder recipe.
1680
+ #
1681
+ # @option params [Types::RecommenderConfig] :recommender_config
1682
+ # The recommender configuration.
1683
+ #
1684
+ # @option params [String] :description
1685
+ # The description of the domain object type.
1686
+ #
1687
+ # @option params [Hash<String,String>] :tags
1688
+ # The tags used to organize, track, or control access for this resource.
1689
+ #
1690
+ # @return [Types::CreateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1691
+ #
1692
+ # * {Types::CreateRecommenderResponse#recommender_arn #recommender_arn} => String
1693
+ # * {Types::CreateRecommenderResponse#tags #tags} => Hash&lt;String,String&gt;
1694
+ #
1695
+ # @example Request syntax with placeholder values
1696
+ #
1697
+ # resp = client.create_recommender({
1698
+ # domain_name: "name", # required
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
1701
+ # recommender_config: {
1702
+ # events_config: { # required
1703
+ # event_parameters_list: [ # required
1704
+ # {
1705
+ # event_type: "EventParametersEventTypeString", # required
1706
+ # event_value_threshold: 1.0,
1707
+ # },
1708
+ # ],
1709
+ # },
1710
+ # training_frequency: 1,
1711
+ # },
1712
+ # description: "sensitiveText",
1713
+ # tags: {
1714
+ # "TagKey" => "TagValue",
1715
+ # },
1716
+ # })
1717
+ #
1718
+ # @example Response structure
1719
+ #
1720
+ # resp.recommender_arn #=> String
1721
+ # resp.tags #=> Hash
1722
+ # resp.tags["TagKey"] #=> String
1723
+ #
1724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateRecommender AWS API Documentation
1725
+ #
1726
+ # @overload create_recommender(params = {})
1727
+ # @param [Hash] params ({})
1728
+ def create_recommender(params = {}, options = {})
1729
+ req = build_request(:create_recommender, params)
1730
+ req.send_request(options)
1731
+ end
1732
+
1660
1733
  # Creates a segment definition associated to the given domain.
1661
1734
  #
1662
1735
  # @option params [required, String] :domain_name
@@ -1671,10 +1744,13 @@ module Aws::CustomerProfiles
1671
1744
  # @option params [String] :description
1672
1745
  # The description of the segment definition.
1673
1746
  #
1674
- # @option params [required, Types::SegmentGroup] :segment_groups
1747
+ # @option params [Types::SegmentGroup] :segment_groups
1675
1748
  # Specifies the base segments and dimensions for a segment definition
1676
1749
  # along with their respective relationship.
1677
1750
  #
1751
+ # @option params [String] :segment_sql_query
1752
+ # The segment SQL query.
1753
+ #
1678
1754
  # @option params [Hash<String,String>] :tags
1679
1755
  # The tags used to organize, track, or control access for this resource.
1680
1756
  #
@@ -1693,8 +1769,8 @@ module Aws::CustomerProfiles
1693
1769
  # domain_name: "name", # required
1694
1770
  # segment_definition_name: "name", # required
1695
1771
  # display_name: "string1To255", # required
1696
- # description: "sensitiveText",
1697
- # segment_groups: { # required
1772
+ # description: "sensitiveString1To4000",
1773
+ # segment_groups: {
1698
1774
  # groups: [
1699
1775
  # {
1700
1776
  # dimensions: [
@@ -1905,6 +1981,7 @@ module Aws::CustomerProfiles
1905
1981
  # ],
1906
1982
  # include: "ALL", # accepts ALL, ANY, NONE
1907
1983
  # },
1984
+ # segment_sql_query: "sensitiveString1To50000",
1908
1985
  # tags: {
1909
1986
  # "TagKey" => "TagValue",
1910
1987
  # },
@@ -1934,9 +2011,12 @@ module Aws::CustomerProfiles
1934
2011
  # @option params [required, String] :domain_name
1935
2012
  # The unique name of the domain.
1936
2013
  #
1937
- # @option params [required, Types::SegmentGroupStructure] :segment_query
2014
+ # @option params [Types::SegmentGroupStructure] :segment_query
1938
2015
  # The segment query for calculating a segment estimate.
1939
2016
  #
2017
+ # @option params [String] :segment_sql_query
2018
+ # The segment SQL query.
2019
+ #
1940
2020
  # @return [Types::CreateSegmentEstimateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1941
2021
  #
1942
2022
  # * {Types::CreateSegmentEstimateResponse#domain_name #domain_name} => String
@@ -1947,7 +2027,7 @@ module Aws::CustomerProfiles
1947
2027
  #
1948
2028
  # resp = client.create_segment_estimate({
1949
2029
  # domain_name: "name", # required
1950
- # segment_query: { # required
2030
+ # segment_query: {
1951
2031
  # groups: [
1952
2032
  # {
1953
2033
  # dimensions: [
@@ -2158,6 +2238,7 @@ module Aws::CustomerProfiles
2158
2238
  # ],
2159
2239
  # include: "ALL", # accepts ALL, ANY, NONE
2160
2240
  # },
2241
+ # segment_sql_query: "sensitiveString1To50000",
2161
2242
  # })
2162
2243
  #
2163
2244
  # @example Response structure
@@ -2376,6 +2457,32 @@ module Aws::CustomerProfiles
2376
2457
  req.send_request(options)
2377
2458
  end
2378
2459
 
2460
+ # Delete a DomainObjectType for the given Domain and ObjectType name.
2461
+ #
2462
+ # @option params [required, String] :domain_name
2463
+ # The unique name of the domain.
2464
+ #
2465
+ # @option params [required, String] :object_type_name
2466
+ # The unique name of the domain object type.
2467
+ #
2468
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2469
+ #
2470
+ # @example Request syntax with placeholder values
2471
+ #
2472
+ # resp = client.delete_domain_object_type({
2473
+ # domain_name: "name", # required
2474
+ # object_type_name: "typeName", # required
2475
+ # })
2476
+ #
2477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainObjectType AWS API Documentation
2478
+ #
2479
+ # @overload delete_domain_object_type(params = {})
2480
+ # @param [Hash] params ({})
2481
+ def delete_domain_object_type(params = {}, options = {})
2482
+ req = build_request(:delete_domain_object_type, params)
2483
+ req.send_request(options)
2484
+ end
2485
+
2379
2486
  # Disables and deletes the specified event stream.
2380
2487
  #
2381
2488
  # @option params [required, String] :domain_name
@@ -2621,6 +2728,32 @@ module Aws::CustomerProfiles
2621
2728
  req.send_request(options)
2622
2729
  end
2623
2730
 
2731
+ # Deletes a recommender.
2732
+ #
2733
+ # @option params [required, String] :domain_name
2734
+ # The unique name of the domain.
2735
+ #
2736
+ # @option params [required, String] :recommender_name
2737
+ # The recommender name.
2738
+ #
2739
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2740
+ #
2741
+ # @example Request syntax with placeholder values
2742
+ #
2743
+ # resp = client.delete_recommender({
2744
+ # domain_name: "name", # required
2745
+ # recommender_name: "name", # required
2746
+ # })
2747
+ #
2748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteRecommender AWS API Documentation
2749
+ #
2750
+ # @overload delete_recommender(params = {})
2751
+ # @param [Hash] params ({})
2752
+ def delete_recommender(params = {}, options = {})
2753
+ req = build_request(:delete_recommender, params)
2754
+ req.send_request(options)
2755
+ end
2756
+
2624
2757
  # Deletes a segment definition from the domain.
2625
2758
  #
2626
2759
  # @option params [required, String] :domain_name
@@ -2928,6 +3061,7 @@ module Aws::CustomerProfiles
2928
3061
  # * {Types::GetDomainResponse#stats #stats} => Types::DomainStats
2929
3062
  # * {Types::GetDomainResponse#matching #matching} => Types::MatchingResponse
2930
3063
  # * {Types::GetDomainResponse#rule_based_matching #rule_based_matching} => Types::RuleBasedMatchingResponse
3064
+ # * {Types::GetDomainResponse#data_store #data_store} => Types::DataStoreResponse
2931
3065
  # * {Types::GetDomainResponse#created_at #created_at} => Time
2932
3066
  # * {Types::GetDomainResponse#last_updated_at #last_updated_at} => Time
2933
3067
  # * {Types::GetDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -2978,6 +3112,9 @@ module Aws::CustomerProfiles
2978
3112
  # resp.rule_based_matching.conflict_resolution.source_name #=> String
2979
3113
  # resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
2980
3114
  # resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
3115
+ # resp.data_store.enabled #=> Boolean
3116
+ # resp.data_store.readiness.progress_percentage #=> Integer
3117
+ # resp.data_store.readiness.message #=> String
2981
3118
  # resp.created_at #=> Time
2982
3119
  # resp.last_updated_at #=> Time
2983
3120
  # resp.tags #=> Hash
@@ -3044,6 +3181,55 @@ module Aws::CustomerProfiles
3044
3181
  req.send_request(options)
3045
3182
  end
3046
3183
 
3184
+ # Return a DomainObjectType for the input Domain and ObjectType names.
3185
+ #
3186
+ # @option params [required, String] :domain_name
3187
+ # The unique name of the domain.
3188
+ #
3189
+ # @option params [required, String] :object_type_name
3190
+ # The unique name of the domain object type.
3191
+ #
3192
+ # @return [Types::GetDomainObjectTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3193
+ #
3194
+ # * {Types::GetDomainObjectTypeResponse#object_type_name #object_type_name} => String
3195
+ # * {Types::GetDomainObjectTypeResponse#description #description} => String
3196
+ # * {Types::GetDomainObjectTypeResponse#encryption_key #encryption_key} => String
3197
+ # * {Types::GetDomainObjectTypeResponse#fields #fields} => Hash&lt;String,Types::DomainObjectTypeField&gt;
3198
+ # * {Types::GetDomainObjectTypeResponse#created_at #created_at} => Time
3199
+ # * {Types::GetDomainObjectTypeResponse#last_updated_at #last_updated_at} => Time
3200
+ # * {Types::GetDomainObjectTypeResponse#tags #tags} => Hash&lt;String,String&gt;
3201
+ #
3202
+ # @example Request syntax with placeholder values
3203
+ #
3204
+ # resp = client.get_domain_object_type({
3205
+ # domain_name: "name", # required
3206
+ # object_type_name: "typeName", # required
3207
+ # })
3208
+ #
3209
+ # @example Response structure
3210
+ #
3211
+ # resp.object_type_name #=> String
3212
+ # resp.description #=> String
3213
+ # resp.encryption_key #=> String
3214
+ # resp.fields #=> Hash
3215
+ # resp.fields["DomainObjectTypeFieldName"].source #=> String
3216
+ # resp.fields["DomainObjectTypeFieldName"].target #=> String
3217
+ # resp.fields["DomainObjectTypeFieldName"].content_type #=> String, one of "STRING", "NUMBER"
3218
+ # resp.fields["DomainObjectTypeFieldName"].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
3219
+ # resp.created_at #=> Time
3220
+ # resp.last_updated_at #=> Time
3221
+ # resp.tags #=> Hash
3222
+ # resp.tags["TagKey"] #=> String
3223
+ #
3224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainObjectType AWS API Documentation
3225
+ #
3226
+ # @overload get_domain_object_type(params = {})
3227
+ # @param [Hash] params ({})
3228
+ def get_domain_object_type(params = {}, options = {})
3229
+ req = build_request(:get_domain_object_type, params)
3230
+ req.send_request(options)
3231
+ end
3232
+
3047
3233
  # Returns information about the specified event stream in a specific
3048
3234
  # domain.
3049
3235
  #
@@ -3246,6 +3432,7 @@ module Aws::CustomerProfiles
3246
3432
  # * {Types::GetIntegrationResponse#is_unstructured #is_unstructured} => Boolean
3247
3433
  # * {Types::GetIntegrationResponse#role_arn #role_arn} => String
3248
3434
  # * {Types::GetIntegrationResponse#event_trigger_names #event_trigger_names} => Array&lt;String&gt;
3435
+ # * {Types::GetIntegrationResponse#scope #scope} => String
3249
3436
  #
3250
3437
  # @example Request syntax with placeholder values
3251
3438
  #
@@ -3270,6 +3457,7 @@ module Aws::CustomerProfiles
3270
3457
  # resp.role_arn #=> String
3271
3458
  # resp.event_trigger_names #=> Array
3272
3459
  # resp.event_trigger_names[0] #=> String
3460
+ # resp.scope #=> String, one of "PROFILE", "DOMAIN"
3273
3461
  #
3274
3462
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegration AWS API Documentation
3275
3463
  #
@@ -3375,6 +3563,67 @@ module Aws::CustomerProfiles
3375
3563
  req.send_request(options)
3376
3564
  end
3377
3565
 
3566
+ # The GetObjectTypeAttributeValues API delivers statistical insights
3567
+ # about attributes within a specific object type, but is exclusively
3568
+ # available for domains with data store enabled. This API performs daily
3569
+ # calculations to provide statistical information about your attribute
3570
+ # values, helping you understand patterns and trends in your data. The
3571
+ # statistical calculations are performed once per day, providing a
3572
+ # consistent snapshot of your attribute data characteristics.
3573
+ #
3574
+ # <note markdown="1"> You'll receive null values in two scenarios:
3575
+ #
3576
+ # During the first period after enabling data vault (unless a
3577
+ # calculation cycle occurs, which happens once daily).
3578
+ #
3579
+ # For attributes that don't contain numeric values.
3580
+ #
3581
+ # </note>
3582
+ #
3583
+ # @option params [required, String] :domain_name
3584
+ # The unique name of the domain.
3585
+ #
3586
+ # @option params [required, String] :object_type_name
3587
+ # The unique name of the domain object type.
3588
+ #
3589
+ # @option params [required, String] :attribute_name
3590
+ # The attribute name.
3591
+ #
3592
+ # @return [Types::GetObjectTypeAttributeStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3593
+ #
3594
+ # * {Types::GetObjectTypeAttributeStatisticsResponse#statistics #statistics} => Types::GetObjectTypeAttributeStatisticsStats
3595
+ # * {Types::GetObjectTypeAttributeStatisticsResponse#calculated_at #calculated_at} => Time
3596
+ #
3597
+ # @example Request syntax with placeholder values
3598
+ #
3599
+ # resp = client.get_object_type_attribute_statistics({
3600
+ # domain_name: "name", # required
3601
+ # object_type_name: "typeName", # required
3602
+ # attribute_name: "string1To1000", # required
3603
+ # })
3604
+ #
3605
+ # @example Response structure
3606
+ #
3607
+ # resp.statistics.maximum #=> Float
3608
+ # resp.statistics.minimum #=> Float
3609
+ # resp.statistics.average #=> Float
3610
+ # resp.statistics.standard_deviation #=> Float
3611
+ # resp.statistics.percentiles.p5 #=> Float
3612
+ # resp.statistics.percentiles.p25 #=> Float
3613
+ # resp.statistics.percentiles.p50 #=> Float
3614
+ # resp.statistics.percentiles.p75 #=> Float
3615
+ # resp.statistics.percentiles.p95 #=> Float
3616
+ # resp.calculated_at #=> Time
3617
+ #
3618
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics AWS API Documentation
3619
+ #
3620
+ # @overload get_object_type_attribute_statistics(params = {})
3621
+ # @param [Hash] params ({})
3622
+ def get_object_type_attribute_statistics(params = {}, options = {})
3623
+ req = build_request(:get_object_type_attribute_statistics, params)
3624
+ req.send_request(options)
3625
+ end
3626
+
3378
3627
  # Returns a history record for a specific profile, for a specific
3379
3628
  # domain.
3380
3629
  #
@@ -3549,6 +3798,141 @@ module Aws::CustomerProfiles
3549
3798
  req.send_request(options)
3550
3799
  end
3551
3800
 
3801
+ # Fetches the recommendations for a profile in the input Customer
3802
+ # Profiles domain. Fetches all the profile recommendations
3803
+ #
3804
+ # @option params [required, String] :domain_name
3805
+ # The unique name of the domain.
3806
+ #
3807
+ # @option params [required, String] :profile_id
3808
+ # The unique identifier of the profile for which to retrieve
3809
+ # recommendations.
3810
+ #
3811
+ # @option params [required, String] :recommender_name
3812
+ # The unique name of the recommender.
3813
+ #
3814
+ # @option params [Hash<String,String>] :context
3815
+ # The contextual metadata used to provide dynamic runtime information to
3816
+ # tailor recommendations.
3817
+ #
3818
+ # @option params [Integer] :max_results
3819
+ # The maximum number of recommendations to return. The default value is
3820
+ # 10.
3821
+ #
3822
+ # @return [Types::GetProfileRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3823
+ #
3824
+ # * {Types::GetProfileRecommendationsResponse#recommendations #recommendations} => Array&lt;Types::Recommendation&gt;
3825
+ #
3826
+ # @example Request syntax with placeholder values
3827
+ #
3828
+ # resp = client.get_profile_recommendations({
3829
+ # domain_name: "name", # required
3830
+ # profile_id: "uuid", # required
3831
+ # recommender_name: "name", # required
3832
+ # context: {
3833
+ # "ContextKey" => "string1To255",
3834
+ # },
3835
+ # max_results: 1,
3836
+ # })
3837
+ #
3838
+ # @example Response structure
3839
+ #
3840
+ # resp.recommendations #=> Array
3841
+ # resp.recommendations[0].catalog_item.id #=> String
3842
+ # resp.recommendations[0].catalog_item.name #=> String
3843
+ # resp.recommendations[0].catalog_item.code #=> String
3844
+ # resp.recommendations[0].catalog_item.type #=> String
3845
+ # resp.recommendations[0].catalog_item.category #=> String
3846
+ # resp.recommendations[0].catalog_item.description #=> String
3847
+ # resp.recommendations[0].catalog_item.additional_information #=> String
3848
+ # resp.recommendations[0].catalog_item.image_link #=> String
3849
+ # resp.recommendations[0].catalog_item.link #=> String
3850
+ # resp.recommendations[0].catalog_item.created_at #=> Time
3851
+ # resp.recommendations[0].catalog_item.updated_at #=> Time
3852
+ # resp.recommendations[0].catalog_item.price #=> String
3853
+ # resp.recommendations[0].catalog_item.attributes #=> Hash
3854
+ # resp.recommendations[0].catalog_item.attributes["string1To255"] #=> String
3855
+ # resp.recommendations[0].score #=> Float
3856
+ #
3857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileRecommendations AWS API Documentation
3858
+ #
3859
+ # @overload get_profile_recommendations(params = {})
3860
+ # @param [Hash] params ({})
3861
+ def get_profile_recommendations(params = {}, options = {})
3862
+ req = build_request(:get_profile_recommendations, params)
3863
+ req.send_request(options)
3864
+ end
3865
+
3866
+ # Retrieves a recommender.
3867
+ #
3868
+ # @option params [required, String] :domain_name
3869
+ # The unique name of the domain.
3870
+ #
3871
+ # @option params [required, String] :recommender_name
3872
+ # The name of the recommender.
3873
+ #
3874
+ # @option params [Integer] :training_metrics_count
3875
+ # The number of training metrics to retrieve for the recommender.
3876
+ #
3877
+ # @return [Types::GetRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3878
+ #
3879
+ # * {Types::GetRecommenderResponse#recommender_name #recommender_name} => String
3880
+ # * {Types::GetRecommenderResponse#recommender_recipe_name #recommender_recipe_name} => String
3881
+ # * {Types::GetRecommenderResponse#recommender_config #recommender_config} => Types::RecommenderConfig
3882
+ # * {Types::GetRecommenderResponse#description #description} => String
3883
+ # * {Types::GetRecommenderResponse#status #status} => String
3884
+ # * {Types::GetRecommenderResponse#last_updated_at #last_updated_at} => Time
3885
+ # * {Types::GetRecommenderResponse#created_at #created_at} => Time
3886
+ # * {Types::GetRecommenderResponse#failure_reason #failure_reason} => String
3887
+ # * {Types::GetRecommenderResponse#latest_recommender_update #latest_recommender_update} => Types::RecommenderUpdate
3888
+ # * {Types::GetRecommenderResponse#training_metrics #training_metrics} => Array&lt;Types::TrainingMetrics&gt;
3889
+ # * {Types::GetRecommenderResponse#tags #tags} => Hash&lt;String,String&gt;
3890
+ #
3891
+ # @example Request syntax with placeholder values
3892
+ #
3893
+ # resp = client.get_recommender({
3894
+ # domain_name: "name", # required
3895
+ # recommender_name: "name", # required
3896
+ # training_metrics_count: 1,
3897
+ # })
3898
+ #
3899
+ # @example Response structure
3900
+ #
3901
+ # resp.recommender_name #=> String
3902
+ # resp.recommender_recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now"
3903
+ # resp.recommender_config.events_config.event_parameters_list #=> Array
3904
+ # resp.recommender_config.events_config.event_parameters_list[0].event_type #=> String
3905
+ # resp.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
3906
+ # resp.recommender_config.training_frequency #=> Integer
3907
+ # resp.description #=> String
3908
+ # resp.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
3909
+ # resp.last_updated_at #=> Time
3910
+ # resp.created_at #=> Time
3911
+ # resp.failure_reason #=> String
3912
+ # resp.latest_recommender_update.recommender_config.events_config.event_parameters_list #=> Array
3913
+ # resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_type #=> String
3914
+ # resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
3915
+ # resp.latest_recommender_update.recommender_config.training_frequency #=> Integer
3916
+ # resp.latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
3917
+ # resp.latest_recommender_update.created_at #=> Time
3918
+ # resp.latest_recommender_update.last_updated_at #=> Time
3919
+ # resp.latest_recommender_update.failure_reason #=> String
3920
+ # resp.training_metrics #=> Array
3921
+ # resp.training_metrics[0].time #=> Time
3922
+ # resp.training_metrics[0].metrics #=> Hash
3923
+ # resp.training_metrics[0].metrics["TrainingMetricName"] #=> Float
3924
+ # resp.tags #=> Hash
3925
+ # resp.tags["TagKey"] #=> String
3926
+ #
3927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetRecommender AWS API Documentation
3928
+ #
3929
+ # @overload get_recommender(params = {})
3930
+ # @param [Hash] params ({})
3931
+ def get_recommender(params = {}, options = {})
3932
+ req = build_request(:get_recommender, params)
3933
+ req.send_request(options)
3934
+ end
3935
+
3552
3936
  # Gets a segment definition from the domain.
3553
3937
  #
3554
3938
  # @option params [required, String] :domain_name
@@ -3566,6 +3950,8 @@ module Aws::CustomerProfiles
3566
3950
  # * {Types::GetSegmentDefinitionResponse#segment_definition_arn #segment_definition_arn} => String
3567
3951
  # * {Types::GetSegmentDefinitionResponse#created_at #created_at} => Time
3568
3952
  # * {Types::GetSegmentDefinitionResponse#tags #tags} => Hash&lt;String,String&gt;
3953
+ # * {Types::GetSegmentDefinitionResponse#segment_sql_query #segment_sql_query} => String
3954
+ # * {Types::GetSegmentDefinitionResponse#segment_type #segment_type} => String
3569
3955
  #
3570
3956
  # @example Request syntax with placeholder values
3571
3957
  #
@@ -3724,6 +4110,8 @@ module Aws::CustomerProfiles
3724
4110
  # resp.created_at #=> Time
3725
4111
  # resp.tags #=> Hash
3726
4112
  # resp.tags["TagKey"] #=> String
4113
+ # resp.segment_sql_query #=> String
4114
+ # resp.segment_type #=> String, one of "CLASSIC", "ENHANCED"
3727
4115
  #
3728
4116
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentDefinition AWS API Documentation
3729
4117
  #
@@ -3793,6 +4181,7 @@ module Aws::CustomerProfiles
3793
4181
  # * {Types::GetSegmentMembershipResponse#segment_definition_name #segment_definition_name} => String
3794
4182
  # * {Types::GetSegmentMembershipResponse#profiles #profiles} => Array&lt;Types::ProfileQueryResult&gt;
3795
4183
  # * {Types::GetSegmentMembershipResponse#failures #failures} => Array&lt;Types::ProfileQueryFailures&gt;
4184
+ # * {Types::GetSegmentMembershipResponse#last_computed_at #last_computed_at} => Time
3796
4185
  #
3797
4186
  # @example Request syntax with placeholder values
3798
4187
  #
@@ -3888,6 +4277,7 @@ module Aws::CustomerProfiles
3888
4277
  # resp.failures[0].profile_id #=> String
3889
4278
  # resp.failures[0].message #=> String
3890
4279
  # resp.failures[0].status #=> Integer
4280
+ # resp.last_computed_at #=> Time
3891
4281
  #
3892
4282
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentMembership AWS API Documentation
3893
4283
  #
@@ -4257,6 +4647,7 @@ module Aws::CustomerProfiles
4257
4647
  # resp.items[0].role_arn #=> String
4258
4648
  # resp.items[0].event_trigger_names #=> Array
4259
4649
  # resp.items[0].event_trigger_names[0] #=> String
4650
+ # resp.items[0].scope #=> String, one of "PROFILE", "DOMAIN"
4260
4651
  # resp.next_token #=> String
4261
4652
  #
4262
4653
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListAccountIntegrations AWS API Documentation
@@ -4416,6 +4807,52 @@ module Aws::CustomerProfiles
4416
4807
  req.send_request(options)
4417
4808
  end
4418
4809
 
4810
+ # List all DomainObjectType(s) in a Customer Profiles domain.
4811
+ #
4812
+ # @option params [required, String] :domain_name
4813
+ # The unique name of the domain.
4814
+ #
4815
+ # @option params [Integer] :max_results
4816
+ # The maximum number of domain object types returned per page.
4817
+ #
4818
+ # @option params [String] :next_token
4819
+ # The pagination token from the previous call to ListDomainObjectTypes.
4820
+ #
4821
+ # @return [Types::ListDomainObjectTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4822
+ #
4823
+ # * {Types::ListDomainObjectTypesResponse#items #items} => Array&lt;Types::DomainObjectTypesListItem&gt;
4824
+ # * {Types::ListDomainObjectTypesResponse#next_token #next_token} => String
4825
+ #
4826
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4827
+ #
4828
+ # @example Request syntax with placeholder values
4829
+ #
4830
+ # resp = client.list_domain_object_types({
4831
+ # domain_name: "name", # required
4832
+ # max_results: 1,
4833
+ # next_token: "token",
4834
+ # })
4835
+ #
4836
+ # @example Response structure
4837
+ #
4838
+ # resp.items #=> Array
4839
+ # resp.items[0].object_type_name #=> String
4840
+ # resp.items[0].description #=> String
4841
+ # resp.items[0].created_at #=> Time
4842
+ # resp.items[0].last_updated_at #=> Time
4843
+ # resp.items[0].tags #=> Hash
4844
+ # resp.items[0].tags["TagKey"] #=> String
4845
+ # resp.next_token #=> String
4846
+ #
4847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainObjectTypes AWS API Documentation
4848
+ #
4849
+ # @overload list_domain_object_types(params = {})
4850
+ # @param [Hash] params ({})
4851
+ def list_domain_object_types(params = {}, options = {})
4852
+ req = build_request(:list_domain_object_types, params)
4853
+ req.send_request(options)
4854
+ end
4855
+
4419
4856
  # Returns a list of all the domains for an AWS account that have been
4420
4857
  # created.
4421
4858
  #
@@ -4651,6 +5088,7 @@ module Aws::CustomerProfiles
4651
5088
  # resp.items[0].role_arn #=> String
4652
5089
  # resp.items[0].event_trigger_names #=> Array
4653
5090
  # resp.items[0].event_trigger_names[0] #=> String
5091
+ # resp.items[0].scope #=> String, one of "PROFILE", "DOMAIN"
4654
5092
  # resp.next_token #=> String
4655
5093
  #
4656
5094
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrations AWS API Documentation
@@ -4662,6 +5100,61 @@ module Aws::CustomerProfiles
4662
5100
  req.send_request(options)
4663
5101
  end
4664
5102
 
5103
+ # The ListObjectTypeAttributeValues API provides access to the most
5104
+ # recent distinct values for any specified attribute, making it valuable
5105
+ # for real-time data validation and consistency checks within your
5106
+ # object types. This API works across domain, supporting both custom and
5107
+ # standard object types. The API accepts the object type name, attribute
5108
+ # name, and domain name as input parameters and returns values up to the
5109
+ # storage limit of approximately 350KB.
5110
+ #
5111
+ # @option params [String] :next_token
5112
+ # The pagination token from the previous call.
5113
+ #
5114
+ # @option params [Integer] :max_results
5115
+ # The maximum number of objects returned per page. Valid Range: Minimum
5116
+ # value of 1. Maximum value of 100. If not provided default as 100.
5117
+ #
5118
+ # @option params [required, String] :domain_name
5119
+ # The unique name of the domain.
5120
+ #
5121
+ # @option params [required, String] :object_type_name
5122
+ # The unique name of the domain object type.
5123
+ #
5124
+ # @option params [required, String] :attribute_name
5125
+ # The attribute name.
5126
+ #
5127
+ # @return [Types::ListObjectTypeAttributeValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5128
+ #
5129
+ # * {Types::ListObjectTypeAttributeValuesResponse#items #items} => Array&lt;Types::ListObjectTypeAttributeValuesItem&gt;
5130
+ # * {Types::ListObjectTypeAttributeValuesResponse#next_token #next_token} => String
5131
+ #
5132
+ # @example Request syntax with placeholder values
5133
+ #
5134
+ # resp = client.list_object_type_attribute_values({
5135
+ # next_token: "token",
5136
+ # max_results: 1,
5137
+ # domain_name: "name", # required
5138
+ # object_type_name: "typeName", # required
5139
+ # attribute_name: "string1To1000", # required
5140
+ # })
5141
+ #
5142
+ # @example Response structure
5143
+ #
5144
+ # resp.items #=> Array
5145
+ # resp.items[0].value #=> String
5146
+ # resp.items[0].last_updated_at #=> Time
5147
+ # resp.next_token #=> String
5148
+ #
5149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributeValues AWS API Documentation
5150
+ #
5151
+ # @overload list_object_type_attribute_values(params = {})
5152
+ # @param [Hash] params ({})
5153
+ def list_object_type_attribute_values(params = {}, options = {})
5154
+ req = build_request(:list_object_type_attribute_values, params)
5155
+ req.send_request(options)
5156
+ end
5157
+
4665
5158
  # Fetch the possible attribute values given the attribute name.
4666
5159
  #
4667
5160
  # @option params [String] :next_token
@@ -4959,6 +5452,110 @@ module Aws::CustomerProfiles
4959
5452
  req.send_request(options)
4960
5453
  end
4961
5454
 
5455
+ # Returns a list of available recommender recipes that can be used to
5456
+ # create recommenders.
5457
+ #
5458
+ # @option params [Integer] :max_results
5459
+ # The maximum number of recommender recipes to return in the response.
5460
+ # The default value is 100.
5461
+ #
5462
+ # @option params [String] :next_token
5463
+ # A token received from a previous ListRecommenderRecipes call to
5464
+ # retrieve the next page of results.
5465
+ #
5466
+ # @return [Types::ListRecommenderRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5467
+ #
5468
+ # * {Types::ListRecommenderRecipesResponse#next_token #next_token} => String
5469
+ # * {Types::ListRecommenderRecipesResponse#recommender_recipes #recommender_recipes} => Array&lt;Types::RecommenderRecipe&gt;
5470
+ #
5471
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5472
+ #
5473
+ # @example Request syntax with placeholder values
5474
+ #
5475
+ # resp = client.list_recommender_recipes({
5476
+ # max_results: 1,
5477
+ # next_token: "token",
5478
+ # })
5479
+ #
5480
+ # @example Response structure
5481
+ #
5482
+ # resp.next_token #=> String
5483
+ # 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"
5485
+ # resp.recommender_recipes[0].description #=> String
5486
+ #
5487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenderRecipes AWS API Documentation
5488
+ #
5489
+ # @overload list_recommender_recipes(params = {})
5490
+ # @param [Hash] params ({})
5491
+ def list_recommender_recipes(params = {}, options = {})
5492
+ req = build_request(:list_recommender_recipes, params)
5493
+ req.send_request(options)
5494
+ end
5495
+
5496
+ # Returns a list of recommenders in the specified domain.
5497
+ #
5498
+ # @option params [required, String] :domain_name
5499
+ # The unique name of the domain.
5500
+ #
5501
+ # @option params [Integer] :max_results
5502
+ # The maximum number of recommenders to return in the response. The
5503
+ # default value is 100.
5504
+ #
5505
+ # @option params [String] :next_token
5506
+ # A token received from a previous ListRecommenders call to retrieve the
5507
+ # next page of results.
5508
+ #
5509
+ # @return [Types::ListRecommendersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5510
+ #
5511
+ # * {Types::ListRecommendersResponse#next_token #next_token} => String
5512
+ # * {Types::ListRecommendersResponse#recommenders #recommenders} => Array&lt;Types::RecommenderSummary&gt;
5513
+ #
5514
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5515
+ #
5516
+ # @example Request syntax with placeholder values
5517
+ #
5518
+ # resp = client.list_recommenders({
5519
+ # domain_name: "name", # required
5520
+ # max_results: 1,
5521
+ # next_token: "token",
5522
+ # })
5523
+ #
5524
+ # @example Response structure
5525
+ #
5526
+ # resp.next_token #=> String
5527
+ # resp.recommenders #=> Array
5528
+ # 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"
5530
+ # resp.recommenders[0].recommender_config.events_config.event_parameters_list #=> Array
5531
+ # resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_type #=> String
5532
+ # resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
5533
+ # resp.recommenders[0].recommender_config.training_frequency #=> Integer
5534
+ # resp.recommenders[0].created_at #=> Time
5535
+ # resp.recommenders[0].description #=> String
5536
+ # resp.recommenders[0].status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
5537
+ # resp.recommenders[0].last_updated_at #=> Time
5538
+ # resp.recommenders[0].tags #=> Hash
5539
+ # resp.recommenders[0].tags["TagKey"] #=> String
5540
+ # resp.recommenders[0].failure_reason #=> String
5541
+ # resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list #=> Array
5542
+ # resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_type #=> String
5543
+ # resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
5544
+ # resp.recommenders[0].latest_recommender_update.recommender_config.training_frequency #=> Integer
5545
+ # resp.recommenders[0].latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
5546
+ # resp.recommenders[0].latest_recommender_update.created_at #=> Time
5547
+ # resp.recommenders[0].latest_recommender_update.last_updated_at #=> Time
5548
+ # resp.recommenders[0].latest_recommender_update.failure_reason #=> String
5549
+ #
5550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenders AWS API Documentation
5551
+ #
5552
+ # @overload list_recommenders(params = {})
5553
+ # @param [Hash] params ({})
5554
+ def list_recommenders(params = {}, options = {})
5555
+ req = build_request(:list_recommenders, params)
5556
+ req.send_request(options)
5557
+ end
5558
+
4962
5559
  # Returns a set of `MatchIds` that belong to the given domain.
4963
5560
  #
4964
5561
  # @option params [String] :next_token
@@ -5038,6 +5635,7 @@ module Aws::CustomerProfiles
5038
5635
  # resp.items[0].created_at #=> Time
5039
5636
  # resp.items[0].tags #=> Hash
5040
5637
  # resp.items[0].tags["TagKey"] #=> String
5638
+ # resp.items[0].segment_type #=> String, one of "CLASSIC", "ENHANCED"
5041
5639
  #
5042
5640
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListSegmentDefinitions AWS API Documentation
5043
5641
  #
@@ -5292,6 +5890,84 @@ module Aws::CustomerProfiles
5292
5890
  req.send_request(options)
5293
5891
  end
5294
5892
 
5893
+ # Create/Update a DomainObjectType in a Customer Profiles domain. To
5894
+ # create a new DomainObjectType, Data Store needs to be enabled on the
5895
+ # Domain.
5896
+ #
5897
+ # @option params [required, String] :domain_name
5898
+ # The unique name of the domain.
5899
+ #
5900
+ # @option params [required, String] :object_type_name
5901
+ # The unique name of the domain object type.
5902
+ #
5903
+ # @option params [String] :description
5904
+ # The description of the domain object type.
5905
+ #
5906
+ # @option params [String] :encryption_key
5907
+ # The customer provided KMS key used to encrypt this type of domain
5908
+ # object.
5909
+ #
5910
+ # @option params [required, Hash<String,Types::DomainObjectTypeField>] :fields
5911
+ # A map of field names to their corresponding domain object type field
5912
+ # definitions.
5913
+ #
5914
+ # @option params [Hash<String,String>] :tags
5915
+ # The tags used to organize, track, or control access for this resource.
5916
+ #
5917
+ # @return [Types::PutDomainObjectTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5918
+ #
5919
+ # * {Types::PutDomainObjectTypeResponse#object_type_name #object_type_name} => String
5920
+ # * {Types::PutDomainObjectTypeResponse#description #description} => String
5921
+ # * {Types::PutDomainObjectTypeResponse#encryption_key #encryption_key} => String
5922
+ # * {Types::PutDomainObjectTypeResponse#fields #fields} => Hash&lt;String,Types::DomainObjectTypeField&gt;
5923
+ # * {Types::PutDomainObjectTypeResponse#created_at #created_at} => Time
5924
+ # * {Types::PutDomainObjectTypeResponse#last_updated_at #last_updated_at} => Time
5925
+ # * {Types::PutDomainObjectTypeResponse#tags #tags} => Hash&lt;String,String&gt;
5926
+ #
5927
+ # @example Request syntax with placeholder values
5928
+ #
5929
+ # resp = client.put_domain_object_type({
5930
+ # domain_name: "name", # required
5931
+ # object_type_name: "typeName", # required
5932
+ # description: "sensitiveString1To10000",
5933
+ # encryption_key: "encryptionKey",
5934
+ # fields: { # required
5935
+ # "DomainObjectTypeFieldName" => {
5936
+ # source: "text", # required
5937
+ # target: "text", # required
5938
+ # content_type: "STRING", # accepts STRING, NUMBER
5939
+ # feature_type: "TEXTUAL", # accepts TEXTUAL, CATEGORICAL
5940
+ # },
5941
+ # },
5942
+ # tags: {
5943
+ # "TagKey" => "TagValue",
5944
+ # },
5945
+ # })
5946
+ #
5947
+ # @example Response structure
5948
+ #
5949
+ # resp.object_type_name #=> String
5950
+ # resp.description #=> String
5951
+ # resp.encryption_key #=> String
5952
+ # resp.fields #=> Hash
5953
+ # resp.fields["DomainObjectTypeFieldName"].source #=> String
5954
+ # resp.fields["DomainObjectTypeFieldName"].target #=> String
5955
+ # resp.fields["DomainObjectTypeFieldName"].content_type #=> String, one of "STRING", "NUMBER"
5956
+ # resp.fields["DomainObjectTypeFieldName"].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
5957
+ # resp.created_at #=> Time
5958
+ # resp.last_updated_at #=> Time
5959
+ # resp.tags #=> Hash
5960
+ # resp.tags["TagKey"] #=> String
5961
+ #
5962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutDomainObjectType AWS API Documentation
5963
+ #
5964
+ # @overload put_domain_object_type(params = {})
5965
+ # @param [Hash] params ({})
5966
+ def put_domain_object_type(params = {}, options = {})
5967
+ req = build_request(:put_domain_object_type, params)
5968
+ req.send_request(options)
5969
+ end
5970
+
5295
5971
  # Adds an integration between the service and a third-party service,
5296
5972
  # which includes Amazon AppFlow and Amazon Connect.
5297
5973
  #
@@ -5314,13 +5990,6 @@ module Aws::CustomerProfiles
5314
5990
  # @option params [String] :object_type_name
5315
5991
  # The name of the profile object type.
5316
5992
  #
5317
- # @option params [Hash<String,String>] :tags
5318
- # The tags used to organize, track, or control access for this resource.
5319
- #
5320
- # @option params [Types::FlowDefinition] :flow_definition
5321
- # The configuration that controls how Customer Profiles retrieves data
5322
- # from the source.
5323
- #
5324
5993
  # @option params [Hash<String,String>] :object_type_names
5325
5994
  # A map in which each key is an event type from an external application
5326
5995
  # such as Segment or Shopify, and each value is an `ObjectTypeName`
@@ -5330,6 +5999,13 @@ module Aws::CustomerProfiles
5330
5999
  # `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and
5331
6000
  # `ShopifyUpdatedOrders`.
5332
6001
  #
6002
+ # @option params [Hash<String,String>] :tags
6003
+ # The tags used to organize, track, or control access for this resource.
6004
+ #
6005
+ # @option params [Types::FlowDefinition] :flow_definition
6006
+ # The configuration that controls how Customer Profiles retrieves data
6007
+ # from the source.
6008
+ #
5333
6009
  # @option params [String] :role_arn
5334
6010
  # The Amazon Resource Name (ARN) of the IAM role. The Integration uses
5335
6011
  # this role to make Customer Profiles requests on your behalf.
@@ -5338,6 +6014,11 @@ module Aws::CustomerProfiles
5338
6014
  # A list of unique names for active event triggers associated with the
5339
6015
  # integration.
5340
6016
  #
6017
+ # @option params [String] :scope
6018
+ # Specifies whether the integration applies to profile level data
6019
+ # (associated with profiles) or domain level data (not associated with
6020
+ # any specific profile). The default value is PROFILE.
6021
+ #
5341
6022
  # @return [Types::PutIntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5342
6023
  #
5343
6024
  # * {Types::PutIntegrationResponse#domain_name #domain_name} => String
@@ -5351,6 +6032,7 @@ module Aws::CustomerProfiles
5351
6032
  # * {Types::PutIntegrationResponse#is_unstructured #is_unstructured} => Boolean
5352
6033
  # * {Types::PutIntegrationResponse#role_arn #role_arn} => String
5353
6034
  # * {Types::PutIntegrationResponse#event_trigger_names #event_trigger_names} => Array&lt;String&gt;
6035
+ # * {Types::PutIntegrationResponse#scope #scope} => String
5354
6036
  #
5355
6037
  # @example Request syntax with placeholder values
5356
6038
  #
@@ -5358,6 +6040,9 @@ module Aws::CustomerProfiles
5358
6040
  # domain_name: "name", # required
5359
6041
  # uri: "string1To255",
5360
6042
  # object_type_name: "typeName",
6043
+ # object_type_names: {
6044
+ # "string1To255" => "typeName",
6045
+ # },
5361
6046
  # tags: {
5362
6047
  # "TagKey" => "TagValue",
5363
6048
  # },
@@ -5424,11 +6109,9 @@ module Aws::CustomerProfiles
5424
6109
  # },
5425
6110
  # },
5426
6111
  # },
5427
- # object_type_names: {
5428
- # "string1To255" => "typeName",
5429
- # },
5430
6112
  # role_arn: "RoleArn",
5431
6113
  # event_trigger_names: ["name"],
6114
+ # scope: "PROFILE", # accepts PROFILE, DOMAIN
5432
6115
  # })
5433
6116
  #
5434
6117
  # @example Response structure
@@ -5447,6 +6130,7 @@ module Aws::CustomerProfiles
5447
6130
  # resp.role_arn #=> String
5448
6131
  # resp.event_trigger_names #=> Array
5449
6132
  # resp.event_trigger_names[0] #=> String
6133
+ # resp.scope #=> String, one of "PROFILE", "DOMAIN"
5450
6134
  #
5451
6135
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegration AWS API Documentation
5452
6136
  #
@@ -5821,6 +6505,33 @@ module Aws::CustomerProfiles
5821
6505
  req.send_request(options)
5822
6506
  end
5823
6507
 
6508
+ # Starts a recommender that was previously stopped. Starting a
6509
+ # recommender resumes its ability to generate recommendations.
6510
+ #
6511
+ # @option params [required, String] :domain_name
6512
+ # The unique name of the domain.
6513
+ #
6514
+ # @option params [required, String] :recommender_name
6515
+ # The name of the recommender to start.
6516
+ #
6517
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6518
+ #
6519
+ # @example Request syntax with placeholder values
6520
+ #
6521
+ # resp = client.start_recommender({
6522
+ # domain_name: "name", # required
6523
+ # recommender_name: "name", # required
6524
+ # })
6525
+ #
6526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StartRecommender AWS API Documentation
6527
+ #
6528
+ # @overload start_recommender(params = {})
6529
+ # @param [Hash] params ({})
6530
+ def start_recommender(params = {}, options = {})
6531
+ req = build_request(:start_recommender, params)
6532
+ req.send_request(options)
6533
+ end
6534
+
5824
6535
  # This API starts the processing of an upload job to ingest profile
5825
6536
  # data.
5826
6537
  #
@@ -5848,6 +6559,34 @@ module Aws::CustomerProfiles
5848
6559
  req.send_request(options)
5849
6560
  end
5850
6561
 
6562
+ # Stops a recommender, suspending its ability to generate
6563
+ # recommendations. The recommender can be restarted later using
6564
+ # StartRecommender.
6565
+ #
6566
+ # @option params [required, String] :domain_name
6567
+ # The unique name of the domain.
6568
+ #
6569
+ # @option params [required, String] :recommender_name
6570
+ # The name of the recommender to stop.
6571
+ #
6572
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6573
+ #
6574
+ # @example Request syntax with placeholder values
6575
+ #
6576
+ # resp = client.stop_recommender({
6577
+ # domain_name: "name", # required
6578
+ # recommender_name: "name", # required
6579
+ # })
6580
+ #
6581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StopRecommender AWS API Documentation
6582
+ #
6583
+ # @overload stop_recommender(params = {})
6584
+ # @param [Hash] params ({})
6585
+ def stop_recommender(params = {}, options = {})
6586
+ req = build_request(:stop_recommender, params)
6587
+ req.send_request(options)
6588
+ end
6589
+
5851
6590
  # This API stops the processing of an upload job.
5852
6591
  #
5853
6592
  # @option params [required, String] :domain_name
@@ -6112,6 +6851,9 @@ module Aws::CustomerProfiles
6112
6851
  # review the results. Also, if you have configured `ExportingConfig` in
6113
6852
  # the `RuleBasedMatchingRequest`, you can download the results from S3.
6114
6853
  #
6854
+ # @option params [Types::DataStoreRequest] :data_store
6855
+ # Set to true to enabled data store for this domain.
6856
+ #
6115
6857
  # @option params [Hash<String,String>] :tags
6116
6858
  # The tags used to organize, track, or control access for this resource.
6117
6859
  #
@@ -6123,6 +6865,7 @@ module Aws::CustomerProfiles
6123
6865
  # * {Types::UpdateDomainResponse#dead_letter_queue_url #dead_letter_queue_url} => String
6124
6866
  # * {Types::UpdateDomainResponse#matching #matching} => Types::MatchingResponse
6125
6867
  # * {Types::UpdateDomainResponse#rule_based_matching #rule_based_matching} => Types::RuleBasedMatchingResponse
6868
+ # * {Types::UpdateDomainResponse#data_store #data_store} => Types::DataStoreResponse
6126
6869
  # * {Types::UpdateDomainResponse#created_at #created_at} => Time
6127
6870
  # * {Types::UpdateDomainResponse#last_updated_at #last_updated_at} => Time
6128
6871
  # * {Types::UpdateDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -6186,6 +6929,9 @@ module Aws::CustomerProfiles
6186
6929
  # },
6187
6930
  # },
6188
6931
  # },
6932
+ # data_store: {
6933
+ # enabled: false,
6934
+ # },
6189
6935
  # tags: {
6190
6936
  # "TagKey" => "TagValue",
6191
6937
  # },
@@ -6227,6 +6973,9 @@ module Aws::CustomerProfiles
6227
6973
  # resp.rule_based_matching.conflict_resolution.source_name #=> String
6228
6974
  # resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
6229
6975
  # resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
6976
+ # resp.data_store.enabled #=> Boolean
6977
+ # resp.data_store.readiness.progress_percentage #=> Integer
6978
+ # resp.data_store.readiness.message #=> String
6230
6979
  # resp.created_at #=> Time
6231
6980
  # resp.last_updated_at #=> Time
6232
6981
  # resp.tags #=> Hash
@@ -6633,6 +7382,58 @@ module Aws::CustomerProfiles
6633
7382
  req.send_request(options)
6634
7383
  end
6635
7384
 
7385
+ # Updates the properties of an existing recommender, allowing you to
7386
+ # modify its configuration and description.
7387
+ #
7388
+ # @option params [required, String] :domain_name
7389
+ # The unique name of the domain.
7390
+ #
7391
+ # @option params [required, String] :recommender_name
7392
+ # The name of the recommender to update.
7393
+ #
7394
+ # @option params [String] :description
7395
+ # The new description to assign to the recommender.
7396
+ #
7397
+ # @option params [Types::RecommenderConfig] :recommender_config
7398
+ # The new configuration settings to apply to the recommender, including
7399
+ # updated parameters and settings that define its behavior.
7400
+ #
7401
+ # @return [Types::UpdateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7402
+ #
7403
+ # * {Types::UpdateRecommenderResponse#recommender_name #recommender_name} => String
7404
+ #
7405
+ # @example Request syntax with placeholder values
7406
+ #
7407
+ # resp = client.update_recommender({
7408
+ # domain_name: "name", # required
7409
+ # recommender_name: "name", # required
7410
+ # description: "sensitiveText",
7411
+ # recommender_config: {
7412
+ # events_config: { # required
7413
+ # event_parameters_list: [ # required
7414
+ # {
7415
+ # event_type: "EventParametersEventTypeString", # required
7416
+ # event_value_threshold: 1.0,
7417
+ # },
7418
+ # ],
7419
+ # },
7420
+ # training_frequency: 1,
7421
+ # },
7422
+ # })
7423
+ #
7424
+ # @example Response structure
7425
+ #
7426
+ # resp.recommender_name #=> String
7427
+ #
7428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateRecommender AWS API Documentation
7429
+ #
7430
+ # @overload update_recommender(params = {})
7431
+ # @param [Hash] params ({})
7432
+ def update_recommender(params = {}, options = {})
7433
+ req = build_request(:update_recommender, params)
7434
+ req.send_request(options)
7435
+ end
7436
+
6636
7437
  # @!endgroup
6637
7438
 
6638
7439
  # @param params ({})
@@ -6651,7 +7452,7 @@ module Aws::CustomerProfiles
6651
7452
  tracer: tracer
6652
7453
  )
6653
7454
  context[:gem_name] = 'aws-sdk-customerprofiles'
6654
- context[:gem_version] = '1.75.0'
7455
+ context[:gem_version] = '1.76.0'
6655
7456
  Seahorse::Client::Request.new(handlers, context)
6656
7457
  end
6657
7458