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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +817 -16
- data/lib/aws-sdk-customerprofiles/client_api.rb +576 -7
- data/lib/aws-sdk-customerprofiles/types.rb +1322 -62
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- data/sig/client.rbs +256 -5
- data/sig/types.rbs +351 -4
- metadata +1 -1
|
@@ -766,6 +766,83 @@ module Aws::CustomerProfiles
|
|
|
766
766
|
include Aws::Structure
|
|
767
767
|
end
|
|
768
768
|
|
|
769
|
+
# Represents an item in the catalog with its complete set of attributes
|
|
770
|
+
# and metadata.
|
|
771
|
+
#
|
|
772
|
+
# @!attribute [rw] id
|
|
773
|
+
# The unique identifier for the catalog item.
|
|
774
|
+
# @return [String]
|
|
775
|
+
#
|
|
776
|
+
# @!attribute [rw] name
|
|
777
|
+
# The display name of the catalog item.
|
|
778
|
+
# @return [String]
|
|
779
|
+
#
|
|
780
|
+
# @!attribute [rw] code
|
|
781
|
+
# The product code or SKU of the catalog item.
|
|
782
|
+
# @return [String]
|
|
783
|
+
#
|
|
784
|
+
# @!attribute [rw] type
|
|
785
|
+
# The type classification of the catalog item.
|
|
786
|
+
# @return [String]
|
|
787
|
+
#
|
|
788
|
+
# @!attribute [rw] category
|
|
789
|
+
# The category to which the catalog item belongs.
|
|
790
|
+
# @return [String]
|
|
791
|
+
#
|
|
792
|
+
# @!attribute [rw] description
|
|
793
|
+
# A detailed description of the catalog item.
|
|
794
|
+
# @return [String]
|
|
795
|
+
#
|
|
796
|
+
# @!attribute [rw] additional_information
|
|
797
|
+
# Supplementary information about the catalog item beyond the basic
|
|
798
|
+
# description.
|
|
799
|
+
# @return [String]
|
|
800
|
+
#
|
|
801
|
+
# @!attribute [rw] image_link
|
|
802
|
+
# The URL link to the item's image.
|
|
803
|
+
# @return [String]
|
|
804
|
+
#
|
|
805
|
+
# @!attribute [rw] link
|
|
806
|
+
# The URL link to the item's detailed page or external resource.
|
|
807
|
+
# @return [String]
|
|
808
|
+
#
|
|
809
|
+
# @!attribute [rw] created_at
|
|
810
|
+
# The timestamp when the catalog item was created.
|
|
811
|
+
# @return [Time]
|
|
812
|
+
#
|
|
813
|
+
# @!attribute [rw] updated_at
|
|
814
|
+
# The timestamp when the catalog item was last updated.
|
|
815
|
+
# @return [Time]
|
|
816
|
+
#
|
|
817
|
+
# @!attribute [rw] price
|
|
818
|
+
# The price of the catalog item.
|
|
819
|
+
# @return [String]
|
|
820
|
+
#
|
|
821
|
+
# @!attribute [rw] attributes
|
|
822
|
+
# Additional attributes or properties associated with the catalog item
|
|
823
|
+
# stored as key-value pairs.
|
|
824
|
+
# @return [Hash<String,String>]
|
|
825
|
+
#
|
|
826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CatalogItem AWS API Documentation
|
|
827
|
+
#
|
|
828
|
+
class CatalogItem < Struct.new(
|
|
829
|
+
:id,
|
|
830
|
+
:name,
|
|
831
|
+
:code,
|
|
832
|
+
:type,
|
|
833
|
+
:category,
|
|
834
|
+
:description,
|
|
835
|
+
:additional_information,
|
|
836
|
+
:image_link,
|
|
837
|
+
:link,
|
|
838
|
+
:created_at,
|
|
839
|
+
:updated_at,
|
|
840
|
+
:price,
|
|
841
|
+
:attributes)
|
|
842
|
+
SENSITIVE = [:id, :name, :code, :type, :category, :description, :additional_information, :image_link, :link, :price, :attributes]
|
|
843
|
+
include Aws::Structure
|
|
844
|
+
end
|
|
845
|
+
|
|
769
846
|
# An object to override the original condition block of a calculated
|
|
770
847
|
# attribute.
|
|
771
848
|
#
|
|
@@ -1227,6 +1304,10 @@ module Aws::CustomerProfiles
|
|
|
1227
1304
|
# download the results from S3.
|
|
1228
1305
|
# @return [Types::RuleBasedMatchingRequest]
|
|
1229
1306
|
#
|
|
1307
|
+
# @!attribute [rw] data_store
|
|
1308
|
+
# Set to true to enabled data store for this domain.
|
|
1309
|
+
# @return [Types::DataStoreRequest]
|
|
1310
|
+
#
|
|
1230
1311
|
# @!attribute [rw] tags
|
|
1231
1312
|
# The tags used to organize, track, or control access for this
|
|
1232
1313
|
# resource.
|
|
@@ -1241,6 +1322,7 @@ module Aws::CustomerProfiles
|
|
|
1241
1322
|
:dead_letter_queue_url,
|
|
1242
1323
|
:matching,
|
|
1243
1324
|
:rule_based_matching,
|
|
1325
|
+
:data_store,
|
|
1244
1326
|
:tags)
|
|
1245
1327
|
SENSITIVE = []
|
|
1246
1328
|
include Aws::Structure
|
|
@@ -1294,6 +1376,10 @@ module Aws::CustomerProfiles
|
|
|
1294
1376
|
# download the results from S3.
|
|
1295
1377
|
# @return [Types::RuleBasedMatchingResponse]
|
|
1296
1378
|
#
|
|
1379
|
+
# @!attribute [rw] data_store
|
|
1380
|
+
# The data store.
|
|
1381
|
+
# @return [Types::DataStoreResponse]
|
|
1382
|
+
#
|
|
1297
1383
|
# @!attribute [rw] created_at
|
|
1298
1384
|
# The timestamp of when the domain was created.
|
|
1299
1385
|
# @return [Time]
|
|
@@ -1316,6 +1402,7 @@ module Aws::CustomerProfiles
|
|
|
1316
1402
|
:dead_letter_queue_url,
|
|
1317
1403
|
:matching,
|
|
1318
1404
|
:rule_based_matching,
|
|
1405
|
+
:data_store,
|
|
1319
1406
|
:created_at,
|
|
1320
1407
|
:last_updated_at,
|
|
1321
1408
|
:tags)
|
|
@@ -1688,6 +1775,62 @@ module Aws::CustomerProfiles
|
|
|
1688
1775
|
include Aws::Structure
|
|
1689
1776
|
end
|
|
1690
1777
|
|
|
1778
|
+
# @!attribute [rw] domain_name
|
|
1779
|
+
# The unique name of the domain.
|
|
1780
|
+
# @return [String]
|
|
1781
|
+
#
|
|
1782
|
+
# @!attribute [rw] recommender_name
|
|
1783
|
+
# The name of the recommender.
|
|
1784
|
+
# @return [String]
|
|
1785
|
+
#
|
|
1786
|
+
# @!attribute [rw] recommender_recipe_name
|
|
1787
|
+
# The name of the recommeder recipe.
|
|
1788
|
+
# @return [String]
|
|
1789
|
+
#
|
|
1790
|
+
# @!attribute [rw] recommender_config
|
|
1791
|
+
# The recommender configuration.
|
|
1792
|
+
# @return [Types::RecommenderConfig]
|
|
1793
|
+
#
|
|
1794
|
+
# @!attribute [rw] description
|
|
1795
|
+
# The description of the domain object type.
|
|
1796
|
+
# @return [String]
|
|
1797
|
+
#
|
|
1798
|
+
# @!attribute [rw] tags
|
|
1799
|
+
# The tags used to organize, track, or control access for this
|
|
1800
|
+
# resource.
|
|
1801
|
+
# @return [Hash<String,String>]
|
|
1802
|
+
#
|
|
1803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateRecommenderRequest AWS API Documentation
|
|
1804
|
+
#
|
|
1805
|
+
class CreateRecommenderRequest < Struct.new(
|
|
1806
|
+
:domain_name,
|
|
1807
|
+
:recommender_name,
|
|
1808
|
+
:recommender_recipe_name,
|
|
1809
|
+
:recommender_config,
|
|
1810
|
+
:description,
|
|
1811
|
+
:tags)
|
|
1812
|
+
SENSITIVE = [:description]
|
|
1813
|
+
include Aws::Structure
|
|
1814
|
+
end
|
|
1815
|
+
|
|
1816
|
+
# @!attribute [rw] recommender_arn
|
|
1817
|
+
# The ARN of the recommender
|
|
1818
|
+
# @return [String]
|
|
1819
|
+
#
|
|
1820
|
+
# @!attribute [rw] tags
|
|
1821
|
+
# The tags used to organize, track, or control access for this
|
|
1822
|
+
# resource.
|
|
1823
|
+
# @return [Hash<String,String>]
|
|
1824
|
+
#
|
|
1825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateRecommenderResponse AWS API Documentation
|
|
1826
|
+
#
|
|
1827
|
+
class CreateRecommenderResponse < Struct.new(
|
|
1828
|
+
:recommender_arn,
|
|
1829
|
+
:tags)
|
|
1830
|
+
SENSITIVE = []
|
|
1831
|
+
include Aws::Structure
|
|
1832
|
+
end
|
|
1833
|
+
|
|
1691
1834
|
# @!attribute [rw] domain_name
|
|
1692
1835
|
# The unique name of the domain.
|
|
1693
1836
|
# @return [String]
|
|
@@ -1709,6 +1852,10 @@ module Aws::CustomerProfiles
|
|
|
1709
1852
|
# along with their respective relationship.
|
|
1710
1853
|
# @return [Types::SegmentGroup]
|
|
1711
1854
|
#
|
|
1855
|
+
# @!attribute [rw] segment_sql_query
|
|
1856
|
+
# The segment SQL query.
|
|
1857
|
+
# @return [String]
|
|
1858
|
+
#
|
|
1712
1859
|
# @!attribute [rw] tags
|
|
1713
1860
|
# The tags used to organize, track, or control access for this
|
|
1714
1861
|
# resource.
|
|
@@ -1722,8 +1869,9 @@ module Aws::CustomerProfiles
|
|
|
1722
1869
|
:display_name,
|
|
1723
1870
|
:description,
|
|
1724
1871
|
:segment_groups,
|
|
1872
|
+
:segment_sql_query,
|
|
1725
1873
|
:tags)
|
|
1726
|
-
SENSITIVE = [:description, :segment_groups]
|
|
1874
|
+
SENSITIVE = [:description, :segment_groups, :segment_sql_query]
|
|
1727
1875
|
include Aws::Structure
|
|
1728
1876
|
end
|
|
1729
1877
|
|
|
@@ -1773,12 +1921,17 @@ module Aws::CustomerProfiles
|
|
|
1773
1921
|
# The segment query for calculating a segment estimate.
|
|
1774
1922
|
# @return [Types::SegmentGroupStructure]
|
|
1775
1923
|
#
|
|
1924
|
+
# @!attribute [rw] segment_sql_query
|
|
1925
|
+
# The segment SQL query.
|
|
1926
|
+
# @return [String]
|
|
1927
|
+
#
|
|
1776
1928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentEstimateRequest AWS API Documentation
|
|
1777
1929
|
#
|
|
1778
1930
|
class CreateSegmentEstimateRequest < Struct.new(
|
|
1779
1931
|
:domain_name,
|
|
1780
|
-
:segment_query
|
|
1781
|
-
|
|
1932
|
+
:segment_query,
|
|
1933
|
+
:segment_sql_query)
|
|
1934
|
+
SENSITIVE = [:segment_sql_query]
|
|
1782
1935
|
include Aws::Structure
|
|
1783
1936
|
end
|
|
1784
1937
|
|
|
@@ -1909,6 +2062,40 @@ module Aws::CustomerProfiles
|
|
|
1909
2062
|
include Aws::Structure
|
|
1910
2063
|
end
|
|
1911
2064
|
|
|
2065
|
+
# The data store request.
|
|
2066
|
+
#
|
|
2067
|
+
# @!attribute [rw] enabled
|
|
2068
|
+
# Enabled: Set to true to enabled data store for this domain.
|
|
2069
|
+
# @return [Boolean]
|
|
2070
|
+
#
|
|
2071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DataStoreRequest AWS API Documentation
|
|
2072
|
+
#
|
|
2073
|
+
class DataStoreRequest < Struct.new(
|
|
2074
|
+
:enabled)
|
|
2075
|
+
SENSITIVE = []
|
|
2076
|
+
include Aws::Structure
|
|
2077
|
+
end
|
|
2078
|
+
|
|
2079
|
+
# The data store response.
|
|
2080
|
+
#
|
|
2081
|
+
# @!attribute [rw] enabled
|
|
2082
|
+
# True if data store is enabled for this domain
|
|
2083
|
+
# @return [Boolean]
|
|
2084
|
+
#
|
|
2085
|
+
# @!attribute [rw] readiness
|
|
2086
|
+
# Information indicating if the Calculated Attribute is ready for use
|
|
2087
|
+
# by confirming all historical data has been processed and reflected.
|
|
2088
|
+
# @return [Types::Readiness]
|
|
2089
|
+
#
|
|
2090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DataStoreResponse AWS API Documentation
|
|
2091
|
+
#
|
|
2092
|
+
class DataStoreResponse < Struct.new(
|
|
2093
|
+
:enabled,
|
|
2094
|
+
:readiness)
|
|
2095
|
+
SENSITIVE = []
|
|
2096
|
+
include Aws::Structure
|
|
2097
|
+
end
|
|
2098
|
+
|
|
1912
2099
|
# Object that segments on various Customer Profile's date fields.
|
|
1913
2100
|
#
|
|
1914
2101
|
# @!attribute [rw] dimension_type
|
|
@@ -1978,6 +2165,27 @@ module Aws::CustomerProfiles
|
|
|
1978
2165
|
include Aws::Structure
|
|
1979
2166
|
end
|
|
1980
2167
|
|
|
2168
|
+
# @!attribute [rw] domain_name
|
|
2169
|
+
# The unique name of the domain.
|
|
2170
|
+
# @return [String]
|
|
2171
|
+
#
|
|
2172
|
+
# @!attribute [rw] object_type_name
|
|
2173
|
+
# The unique name of the domain object type.
|
|
2174
|
+
# @return [String]
|
|
2175
|
+
#
|
|
2176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainObjectTypeRequest AWS API Documentation
|
|
2177
|
+
#
|
|
2178
|
+
class DeleteDomainObjectTypeRequest < Struct.new(
|
|
2179
|
+
:domain_name,
|
|
2180
|
+
:object_type_name)
|
|
2181
|
+
SENSITIVE = []
|
|
2182
|
+
include Aws::Structure
|
|
2183
|
+
end
|
|
2184
|
+
|
|
2185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainObjectTypeResponse AWS API Documentation
|
|
2186
|
+
#
|
|
2187
|
+
class DeleteDomainObjectTypeResponse < Aws::EmptyStructure; end
|
|
2188
|
+
|
|
1981
2189
|
# @!attribute [rw] domain_name
|
|
1982
2190
|
# The unique name of the domain.
|
|
1983
2191
|
# @return [String]
|
|
@@ -2218,6 +2426,27 @@ module Aws::CustomerProfiles
|
|
|
2218
2426
|
include Aws::Structure
|
|
2219
2427
|
end
|
|
2220
2428
|
|
|
2429
|
+
# @!attribute [rw] domain_name
|
|
2430
|
+
# The unique name of the domain.
|
|
2431
|
+
# @return [String]
|
|
2432
|
+
#
|
|
2433
|
+
# @!attribute [rw] recommender_name
|
|
2434
|
+
# The recommender name.
|
|
2435
|
+
# @return [String]
|
|
2436
|
+
#
|
|
2437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteRecommenderRequest AWS API Documentation
|
|
2438
|
+
#
|
|
2439
|
+
class DeleteRecommenderRequest < Struct.new(
|
|
2440
|
+
:domain_name,
|
|
2441
|
+
:recommender_name)
|
|
2442
|
+
SENSITIVE = []
|
|
2443
|
+
include Aws::Structure
|
|
2444
|
+
end
|
|
2445
|
+
|
|
2446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteRecommenderResponse AWS API Documentation
|
|
2447
|
+
#
|
|
2448
|
+
class DeleteRecommenderResponse < Aws::EmptyStructure; end
|
|
2449
|
+
|
|
2221
2450
|
# @!attribute [rw] domain_name
|
|
2222
2451
|
# The unique name of the domain.
|
|
2223
2452
|
# @return [String]
|
|
@@ -2379,6 +2608,75 @@ module Aws::CustomerProfiles
|
|
|
2379
2608
|
class Unknown < Dimension; end
|
|
2380
2609
|
end
|
|
2381
2610
|
|
|
2611
|
+
# The standard domain object type.
|
|
2612
|
+
#
|
|
2613
|
+
# @!attribute [rw] source
|
|
2614
|
+
# The expression that defines how to extract the field value from the
|
|
2615
|
+
# source object.>
|
|
2616
|
+
# @return [String]
|
|
2617
|
+
#
|
|
2618
|
+
# @!attribute [rw] target
|
|
2619
|
+
# The expression that defines where the field value should be placed
|
|
2620
|
+
# in the standard domain object.
|
|
2621
|
+
# @return [String]
|
|
2622
|
+
#
|
|
2623
|
+
# @!attribute [rw] content_type
|
|
2624
|
+
# The content type of the field.
|
|
2625
|
+
# @return [String]
|
|
2626
|
+
#
|
|
2627
|
+
# @!attribute [rw] feature_type
|
|
2628
|
+
# The semantic meaning of the field.
|
|
2629
|
+
# @return [String]
|
|
2630
|
+
#
|
|
2631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DomainObjectTypeField AWS API Documentation
|
|
2632
|
+
#
|
|
2633
|
+
class DomainObjectTypeField < Struct.new(
|
|
2634
|
+
:source,
|
|
2635
|
+
:target,
|
|
2636
|
+
:content_type,
|
|
2637
|
+
:feature_type)
|
|
2638
|
+
SENSITIVE = []
|
|
2639
|
+
include Aws::Structure
|
|
2640
|
+
end
|
|
2641
|
+
|
|
2642
|
+
# Represents an item in the list of domain object types, containing
|
|
2643
|
+
# basic information about a specific object type within a domain.
|
|
2644
|
+
#
|
|
2645
|
+
# @!attribute [rw] object_type_name
|
|
2646
|
+
# The name that identifies the object type within the domain.
|
|
2647
|
+
# @return [String]
|
|
2648
|
+
#
|
|
2649
|
+
# @!attribute [rw] description
|
|
2650
|
+
# A description explaining the purpose and characteristics of this
|
|
2651
|
+
# object type.
|
|
2652
|
+
# @return [String]
|
|
2653
|
+
#
|
|
2654
|
+
# @!attribute [rw] created_at
|
|
2655
|
+
# The timestamp of when the domain object type was created.
|
|
2656
|
+
# @return [Time]
|
|
2657
|
+
#
|
|
2658
|
+
# @!attribute [rw] last_updated_at
|
|
2659
|
+
# The timestamp of when the domain object type was most recently
|
|
2660
|
+
# edited.
|
|
2661
|
+
# @return [Time]
|
|
2662
|
+
#
|
|
2663
|
+
# @!attribute [rw] tags
|
|
2664
|
+
# The tags used to organize, track, or control access for this
|
|
2665
|
+
# resource.
|
|
2666
|
+
# @return [Hash<String,String>]
|
|
2667
|
+
#
|
|
2668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DomainObjectTypesListItem AWS API Documentation
|
|
2669
|
+
#
|
|
2670
|
+
class DomainObjectTypesListItem < Struct.new(
|
|
2671
|
+
:object_type_name,
|
|
2672
|
+
:description,
|
|
2673
|
+
:created_at,
|
|
2674
|
+
:last_updated_at,
|
|
2675
|
+
:tags)
|
|
2676
|
+
SENSITIVE = [:description]
|
|
2677
|
+
include Aws::Structure
|
|
2678
|
+
end
|
|
2679
|
+
|
|
2382
2680
|
# Usage-specific statistics about the domain.
|
|
2383
2681
|
#
|
|
2384
2682
|
# @!attribute [rw] profile_count
|
|
@@ -2430,6 +2728,27 @@ module Aws::CustomerProfiles
|
|
|
2430
2728
|
include Aws::Structure
|
|
2431
2729
|
end
|
|
2432
2730
|
|
|
2731
|
+
# Configuration parameters for events in the personalization system.
|
|
2732
|
+
#
|
|
2733
|
+
# @!attribute [rw] event_type
|
|
2734
|
+
# The type of event being tracked (e.g., 'click', 'purchase',
|
|
2735
|
+
# 'view').
|
|
2736
|
+
# @return [String]
|
|
2737
|
+
#
|
|
2738
|
+
# @!attribute [rw] event_value_threshold
|
|
2739
|
+
# The minimum value threshold that an event must meet to be considered
|
|
2740
|
+
# valid.
|
|
2741
|
+
# @return [Float]
|
|
2742
|
+
#
|
|
2743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/EventParameters AWS API Documentation
|
|
2744
|
+
#
|
|
2745
|
+
class EventParameters < Struct.new(
|
|
2746
|
+
:event_type,
|
|
2747
|
+
:event_value_threshold)
|
|
2748
|
+
SENSITIVE = []
|
|
2749
|
+
include Aws::Structure
|
|
2750
|
+
end
|
|
2751
|
+
|
|
2433
2752
|
# Details of the destination being used for the EventStream.
|
|
2434
2753
|
#
|
|
2435
2754
|
# @!attribute [rw] uri
|
|
@@ -2602,6 +2921,22 @@ module Aws::CustomerProfiles
|
|
|
2602
2921
|
include Aws::Structure
|
|
2603
2922
|
end
|
|
2604
2923
|
|
|
2924
|
+
# Configuration settings that define how events are processed and
|
|
2925
|
+
# tracked.
|
|
2926
|
+
#
|
|
2927
|
+
# @!attribute [rw] event_parameters_list
|
|
2928
|
+
# A list of event parameters configurations that specify how different
|
|
2929
|
+
# event types should be handled.
|
|
2930
|
+
# @return [Array<Types::EventParameters>]
|
|
2931
|
+
#
|
|
2932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/EventsConfig AWS API Documentation
|
|
2933
|
+
#
|
|
2934
|
+
class EventsConfig < Struct.new(
|
|
2935
|
+
:event_parameters_list)
|
|
2936
|
+
SENSITIVE = []
|
|
2937
|
+
include Aws::Structure
|
|
2938
|
+
end
|
|
2939
|
+
|
|
2605
2940
|
# Configuration information about the S3 bucket where Identity
|
|
2606
2941
|
# Resolution Jobs writes result files.
|
|
2607
2942
|
#
|
|
@@ -3230,49 +3565,112 @@ module Aws::CustomerProfiles
|
|
|
3230
3565
|
# The unique name of the domain.
|
|
3231
3566
|
# @return [String]
|
|
3232
3567
|
#
|
|
3233
|
-
#
|
|
3568
|
+
# @!attribute [rw] object_type_name
|
|
3569
|
+
# The unique name of the domain object type.
|
|
3570
|
+
# @return [String]
|
|
3234
3571
|
#
|
|
3235
|
-
|
|
3236
|
-
|
|
3572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainObjectTypeRequest AWS API Documentation
|
|
3573
|
+
#
|
|
3574
|
+
class GetDomainObjectTypeRequest < Struct.new(
|
|
3575
|
+
:domain_name,
|
|
3576
|
+
:object_type_name)
|
|
3237
3577
|
SENSITIVE = []
|
|
3238
3578
|
include Aws::Structure
|
|
3239
3579
|
end
|
|
3240
3580
|
|
|
3241
|
-
# @!attribute [rw]
|
|
3242
|
-
# The unique name of the domain.
|
|
3581
|
+
# @!attribute [rw] object_type_name
|
|
3582
|
+
# The unique name of the domain object type.
|
|
3243
3583
|
# @return [String]
|
|
3244
3584
|
#
|
|
3245
|
-
# @!attribute [rw]
|
|
3246
|
-
# The
|
|
3247
|
-
# @return [Integer]
|
|
3248
|
-
#
|
|
3249
|
-
# @!attribute [rw] default_encryption_key
|
|
3250
|
-
# The default encryption key, which is an AWS managed key, is used
|
|
3251
|
-
# when no specific type of encryption key is specified. It is used to
|
|
3252
|
-
# encrypt all data before it is placed in permanent or semi-permanent
|
|
3253
|
-
# storage.
|
|
3585
|
+
# @!attribute [rw] description
|
|
3586
|
+
# The description of the domain object type.
|
|
3254
3587
|
# @return [String]
|
|
3255
3588
|
#
|
|
3256
|
-
# @!attribute [rw]
|
|
3257
|
-
# The
|
|
3258
|
-
#
|
|
3589
|
+
# @!attribute [rw] encryption_key
|
|
3590
|
+
# The customer provided KMS key used to encrypt this type of domain
|
|
3591
|
+
# object.
|
|
3259
3592
|
# @return [String]
|
|
3260
3593
|
#
|
|
3261
|
-
# @!attribute [rw]
|
|
3262
|
-
#
|
|
3263
|
-
#
|
|
3264
|
-
#
|
|
3265
|
-
#
|
|
3266
|
-
#
|
|
3267
|
-
#
|
|
3268
|
-
#
|
|
3269
|
-
#
|
|
3270
|
-
#
|
|
3271
|
-
#
|
|
3272
|
-
#
|
|
3273
|
-
#
|
|
3274
|
-
#
|
|
3275
|
-
#
|
|
3594
|
+
# @!attribute [rw] fields
|
|
3595
|
+
# A map of field names to their corresponding domain object type field
|
|
3596
|
+
# definitions.
|
|
3597
|
+
# @return [Hash<String,Types::DomainObjectTypeField>]
|
|
3598
|
+
#
|
|
3599
|
+
# @!attribute [rw] created_at
|
|
3600
|
+
# The timestamp of when the domain object type was created.
|
|
3601
|
+
# @return [Time]
|
|
3602
|
+
#
|
|
3603
|
+
# @!attribute [rw] last_updated_at
|
|
3604
|
+
# The timestamp of when the domain object type was most recently
|
|
3605
|
+
# edited.
|
|
3606
|
+
# @return [Time]
|
|
3607
|
+
#
|
|
3608
|
+
# @!attribute [rw] tags
|
|
3609
|
+
# The tags used to organize, track, or control access for this
|
|
3610
|
+
# resource.
|
|
3611
|
+
# @return [Hash<String,String>]
|
|
3612
|
+
#
|
|
3613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainObjectTypeResponse AWS API Documentation
|
|
3614
|
+
#
|
|
3615
|
+
class GetDomainObjectTypeResponse < Struct.new(
|
|
3616
|
+
:object_type_name,
|
|
3617
|
+
:description,
|
|
3618
|
+
:encryption_key,
|
|
3619
|
+
:fields,
|
|
3620
|
+
:created_at,
|
|
3621
|
+
:last_updated_at,
|
|
3622
|
+
:tags)
|
|
3623
|
+
SENSITIVE = [:description]
|
|
3624
|
+
include Aws::Structure
|
|
3625
|
+
end
|
|
3626
|
+
|
|
3627
|
+
# @!attribute [rw] domain_name
|
|
3628
|
+
# The unique name of the domain.
|
|
3629
|
+
# @return [String]
|
|
3630
|
+
#
|
|
3631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainRequest AWS API Documentation
|
|
3632
|
+
#
|
|
3633
|
+
class GetDomainRequest < Struct.new(
|
|
3634
|
+
:domain_name)
|
|
3635
|
+
SENSITIVE = []
|
|
3636
|
+
include Aws::Structure
|
|
3637
|
+
end
|
|
3638
|
+
|
|
3639
|
+
# @!attribute [rw] domain_name
|
|
3640
|
+
# The unique name of the domain.
|
|
3641
|
+
# @return [String]
|
|
3642
|
+
#
|
|
3643
|
+
# @!attribute [rw] default_expiration_days
|
|
3644
|
+
# The default number of days until the data within the domain expires.
|
|
3645
|
+
# @return [Integer]
|
|
3646
|
+
#
|
|
3647
|
+
# @!attribute [rw] default_encryption_key
|
|
3648
|
+
# The default encryption key, which is an AWS managed key, is used
|
|
3649
|
+
# when no specific type of encryption key is specified. It is used to
|
|
3650
|
+
# encrypt all data before it is placed in permanent or semi-permanent
|
|
3651
|
+
# storage.
|
|
3652
|
+
# @return [String]
|
|
3653
|
+
#
|
|
3654
|
+
# @!attribute [rw] dead_letter_queue_url
|
|
3655
|
+
# The URL of the SQS dead letter queue, which is used for reporting
|
|
3656
|
+
# errors associated with ingesting data from third party applications.
|
|
3657
|
+
# @return [String]
|
|
3658
|
+
#
|
|
3659
|
+
# @!attribute [rw] stats
|
|
3660
|
+
# Usage-specific statistics about the domain.
|
|
3661
|
+
# @return [Types::DomainStats]
|
|
3662
|
+
#
|
|
3663
|
+
# @!attribute [rw] matching
|
|
3664
|
+
# The process of matching duplicate profiles. If `Matching` = `true`,
|
|
3665
|
+
# Amazon Connect Customer Profiles starts a weekly batch process
|
|
3666
|
+
# called Identity Resolution Job. If you do not specify a date and
|
|
3667
|
+
# time for Identity Resolution Job to run, by default it runs every
|
|
3668
|
+
# Saturday at 12AM UTC to detect duplicate profiles in your domains.
|
|
3669
|
+
#
|
|
3670
|
+
# After the Identity Resolution Job completes, use the [GetMatches][1]
|
|
3671
|
+
# API to return and review the results. Or, if you have configured
|
|
3672
|
+
# `ExportingConfig` in the `MatchingRequest`, you can download the
|
|
3673
|
+
# results from S3.
|
|
3276
3674
|
#
|
|
3277
3675
|
#
|
|
3278
3676
|
#
|
|
@@ -3290,6 +3688,10 @@ module Aws::CustomerProfiles
|
|
|
3290
3688
|
# download the results from S3.
|
|
3291
3689
|
# @return [Types::RuleBasedMatchingResponse]
|
|
3292
3690
|
#
|
|
3691
|
+
# @!attribute [rw] data_store
|
|
3692
|
+
# True if data store is enabled for this domain.
|
|
3693
|
+
# @return [Types::DataStoreResponse]
|
|
3694
|
+
#
|
|
3293
3695
|
# @!attribute [rw] created_at
|
|
3294
3696
|
# The timestamp of when the domain was created.
|
|
3295
3697
|
# @return [Time]
|
|
@@ -3313,6 +3715,7 @@ module Aws::CustomerProfiles
|
|
|
3313
3715
|
:stats,
|
|
3314
3716
|
:matching,
|
|
3315
3717
|
:rule_based_matching,
|
|
3718
|
+
:data_store,
|
|
3316
3719
|
:created_at,
|
|
3317
3720
|
:last_updated_at,
|
|
3318
3721
|
:tags)
|
|
@@ -3632,6 +4035,12 @@ module Aws::CustomerProfiles
|
|
|
3632
4035
|
# associated with the integration.
|
|
3633
4036
|
# @return [Array<String>]
|
|
3634
4037
|
#
|
|
4038
|
+
# @!attribute [rw] scope
|
|
4039
|
+
# Specifies whether the integration applies to profile level data
|
|
4040
|
+
# (associated with profiles) or domain level data (not associated with
|
|
4041
|
+
# any specific profile). The default value is PROFILE.
|
|
4042
|
+
# @return [String]
|
|
4043
|
+
#
|
|
3635
4044
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegrationResponse AWS API Documentation
|
|
3636
4045
|
#
|
|
3637
4046
|
class GetIntegrationResponse < Struct.new(
|
|
@@ -3645,7 +4054,8 @@ module Aws::CustomerProfiles
|
|
|
3645
4054
|
:workflow_id,
|
|
3646
4055
|
:is_unstructured,
|
|
3647
4056
|
:role_arn,
|
|
3648
|
-
:event_trigger_names
|
|
4057
|
+
:event_trigger_names,
|
|
4058
|
+
:scope)
|
|
3649
4059
|
SENSITIVE = []
|
|
3650
4060
|
include Aws::Structure
|
|
3651
4061
|
end
|
|
@@ -3702,6 +4112,115 @@ module Aws::CustomerProfiles
|
|
|
3702
4112
|
include Aws::Structure
|
|
3703
4113
|
end
|
|
3704
4114
|
|
|
4115
|
+
# Contains percentile statistics for object type attributes.
|
|
4116
|
+
#
|
|
4117
|
+
# @!attribute [rw] p5
|
|
4118
|
+
# The 5th percentile value of the attribute.
|
|
4119
|
+
# @return [Float]
|
|
4120
|
+
#
|
|
4121
|
+
# @!attribute [rw] p25
|
|
4122
|
+
# The 25th percentile value of the attribute.
|
|
4123
|
+
# @return [Float]
|
|
4124
|
+
#
|
|
4125
|
+
# @!attribute [rw] p50
|
|
4126
|
+
# The 50th percentile (median) value of the attribute.
|
|
4127
|
+
# @return [Float]
|
|
4128
|
+
#
|
|
4129
|
+
# @!attribute [rw] p75
|
|
4130
|
+
# The 75th percentile value of the attribute.
|
|
4131
|
+
# @return [Float]
|
|
4132
|
+
#
|
|
4133
|
+
# @!attribute [rw] p95
|
|
4134
|
+
# The 95th percentile value of the attribute.
|
|
4135
|
+
# @return [Float]
|
|
4136
|
+
#
|
|
4137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetObjectTypeAttributeStatisticsPercentiles AWS API Documentation
|
|
4138
|
+
#
|
|
4139
|
+
class GetObjectTypeAttributeStatisticsPercentiles < Struct.new(
|
|
4140
|
+
:p5,
|
|
4141
|
+
:p25,
|
|
4142
|
+
:p50,
|
|
4143
|
+
:p75,
|
|
4144
|
+
:p95)
|
|
4145
|
+
SENSITIVE = []
|
|
4146
|
+
include Aws::Structure
|
|
4147
|
+
end
|
|
4148
|
+
|
|
4149
|
+
# @!attribute [rw] domain_name
|
|
4150
|
+
# The unique name of the domain.
|
|
4151
|
+
# @return [String]
|
|
4152
|
+
#
|
|
4153
|
+
# @!attribute [rw] object_type_name
|
|
4154
|
+
# The unique name of the domain object type.
|
|
4155
|
+
# @return [String]
|
|
4156
|
+
#
|
|
4157
|
+
# @!attribute [rw] attribute_name
|
|
4158
|
+
# The attribute name.
|
|
4159
|
+
# @return [String]
|
|
4160
|
+
#
|
|
4161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetObjectTypeAttributeStatisticsRequest AWS API Documentation
|
|
4162
|
+
#
|
|
4163
|
+
class GetObjectTypeAttributeStatisticsRequest < Struct.new(
|
|
4164
|
+
:domain_name,
|
|
4165
|
+
:object_type_name,
|
|
4166
|
+
:attribute_name)
|
|
4167
|
+
SENSITIVE = []
|
|
4168
|
+
include Aws::Structure
|
|
4169
|
+
end
|
|
4170
|
+
|
|
4171
|
+
# @!attribute [rw] statistics
|
|
4172
|
+
# The statistics.
|
|
4173
|
+
# @return [Types::GetObjectTypeAttributeStatisticsStats]
|
|
4174
|
+
#
|
|
4175
|
+
# @!attribute [rw] calculated_at
|
|
4176
|
+
# Time when this statistics was calculated.
|
|
4177
|
+
# @return [Time]
|
|
4178
|
+
#
|
|
4179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetObjectTypeAttributeStatisticsResponse AWS API Documentation
|
|
4180
|
+
#
|
|
4181
|
+
class GetObjectTypeAttributeStatisticsResponse < Struct.new(
|
|
4182
|
+
:statistics,
|
|
4183
|
+
:calculated_at)
|
|
4184
|
+
SENSITIVE = []
|
|
4185
|
+
include Aws::Structure
|
|
4186
|
+
end
|
|
4187
|
+
|
|
4188
|
+
# Statistical measurements for object type attributes including basic
|
|
4189
|
+
# statistics and percentiles.
|
|
4190
|
+
#
|
|
4191
|
+
# @!attribute [rw] maximum
|
|
4192
|
+
# The maximum value found in the attribute dataset.
|
|
4193
|
+
# @return [Float]
|
|
4194
|
+
#
|
|
4195
|
+
# @!attribute [rw] minimum
|
|
4196
|
+
# The minimum value found in the attribute dataset.
|
|
4197
|
+
# @return [Float]
|
|
4198
|
+
#
|
|
4199
|
+
# @!attribute [rw] average
|
|
4200
|
+
# The arithmetic mean of the attribute values.
|
|
4201
|
+
# @return [Float]
|
|
4202
|
+
#
|
|
4203
|
+
# @!attribute [rw] standard_deviation
|
|
4204
|
+
# The standard deviation of the attribute values, measuring their
|
|
4205
|
+
# spread around the mean.
|
|
4206
|
+
# @return [Float]
|
|
4207
|
+
#
|
|
4208
|
+
# @!attribute [rw] percentiles
|
|
4209
|
+
# Percentile distribution statistics for the attribute values.
|
|
4210
|
+
# @return [Types::GetObjectTypeAttributeStatisticsPercentiles]
|
|
4211
|
+
#
|
|
4212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetObjectTypeAttributeStatisticsStats AWS API Documentation
|
|
4213
|
+
#
|
|
4214
|
+
class GetObjectTypeAttributeStatisticsStats < Struct.new(
|
|
4215
|
+
:maximum,
|
|
4216
|
+
:minimum,
|
|
4217
|
+
:average,
|
|
4218
|
+
:standard_deviation,
|
|
4219
|
+
:percentiles)
|
|
4220
|
+
SENSITIVE = []
|
|
4221
|
+
include Aws::Structure
|
|
4222
|
+
end
|
|
4223
|
+
|
|
3705
4224
|
# @!attribute [rw] domain_name
|
|
3706
4225
|
# The unique name of the domain for which to return a profile history
|
|
3707
4226
|
# record.
|
|
@@ -3938,6 +4457,144 @@ module Aws::CustomerProfiles
|
|
|
3938
4457
|
include Aws::Structure
|
|
3939
4458
|
end
|
|
3940
4459
|
|
|
4460
|
+
# @!attribute [rw] domain_name
|
|
4461
|
+
# The unique name of the domain.
|
|
4462
|
+
# @return [String]
|
|
4463
|
+
#
|
|
4464
|
+
# @!attribute [rw] profile_id
|
|
4465
|
+
# The unique identifier of the profile for which to retrieve
|
|
4466
|
+
# recommendations.
|
|
4467
|
+
# @return [String]
|
|
4468
|
+
#
|
|
4469
|
+
# @!attribute [rw] recommender_name
|
|
4470
|
+
# The unique name of the recommender.
|
|
4471
|
+
# @return [String]
|
|
4472
|
+
#
|
|
4473
|
+
# @!attribute [rw] context
|
|
4474
|
+
# The contextual metadata used to provide dynamic runtime information
|
|
4475
|
+
# to tailor recommendations.
|
|
4476
|
+
# @return [Hash<String,String>]
|
|
4477
|
+
#
|
|
4478
|
+
# @!attribute [rw] max_results
|
|
4479
|
+
# The maximum number of recommendations to return. The default value
|
|
4480
|
+
# is 10.
|
|
4481
|
+
# @return [Integer]
|
|
4482
|
+
#
|
|
4483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileRecommendationsRequest AWS API Documentation
|
|
4484
|
+
#
|
|
4485
|
+
class GetProfileRecommendationsRequest < Struct.new(
|
|
4486
|
+
:domain_name,
|
|
4487
|
+
:profile_id,
|
|
4488
|
+
:recommender_name,
|
|
4489
|
+
:context,
|
|
4490
|
+
:max_results)
|
|
4491
|
+
SENSITIVE = [:context]
|
|
4492
|
+
include Aws::Structure
|
|
4493
|
+
end
|
|
4494
|
+
|
|
4495
|
+
# @!attribute [rw] recommendations
|
|
4496
|
+
# List of recommendations generated by the recommender.
|
|
4497
|
+
# @return [Array<Types::Recommendation>]
|
|
4498
|
+
#
|
|
4499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileRecommendationsResponse AWS API Documentation
|
|
4500
|
+
#
|
|
4501
|
+
class GetProfileRecommendationsResponse < Struct.new(
|
|
4502
|
+
:recommendations)
|
|
4503
|
+
SENSITIVE = [:recommendations]
|
|
4504
|
+
include Aws::Structure
|
|
4505
|
+
end
|
|
4506
|
+
|
|
4507
|
+
# @!attribute [rw] domain_name
|
|
4508
|
+
# The unique name of the domain.
|
|
4509
|
+
# @return [String]
|
|
4510
|
+
#
|
|
4511
|
+
# @!attribute [rw] recommender_name
|
|
4512
|
+
# The name of the recommender.
|
|
4513
|
+
# @return [String]
|
|
4514
|
+
#
|
|
4515
|
+
# @!attribute [rw] training_metrics_count
|
|
4516
|
+
# The number of training metrics to retrieve for the recommender.
|
|
4517
|
+
# @return [Integer]
|
|
4518
|
+
#
|
|
4519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetRecommenderRequest AWS API Documentation
|
|
4520
|
+
#
|
|
4521
|
+
class GetRecommenderRequest < Struct.new(
|
|
4522
|
+
:domain_name,
|
|
4523
|
+
:recommender_name,
|
|
4524
|
+
:training_metrics_count)
|
|
4525
|
+
SENSITIVE = []
|
|
4526
|
+
include Aws::Structure
|
|
4527
|
+
end
|
|
4528
|
+
|
|
4529
|
+
# @!attribute [rw] recommender_name
|
|
4530
|
+
# The name of the recommender.
|
|
4531
|
+
# @return [String]
|
|
4532
|
+
#
|
|
4533
|
+
# @!attribute [rw] recommender_recipe_name
|
|
4534
|
+
# The name of the recipe used by the recommender to generate
|
|
4535
|
+
# recommendations.
|
|
4536
|
+
# @return [String]
|
|
4537
|
+
#
|
|
4538
|
+
# @!attribute [rw] recommender_config
|
|
4539
|
+
# The configuration settings for the recommender, including parameters
|
|
4540
|
+
# and settings that define its behavior.
|
|
4541
|
+
# @return [Types::RecommenderConfig]
|
|
4542
|
+
#
|
|
4543
|
+
# @!attribute [rw] description
|
|
4544
|
+
# A detailed description of the recommender providing information
|
|
4545
|
+
# about its purpose and functionality.
|
|
4546
|
+
# @return [String]
|
|
4547
|
+
#
|
|
4548
|
+
# @!attribute [rw] status
|
|
4549
|
+
# The current status of the recommender, indicating whether it is
|
|
4550
|
+
# active, creating, updating, or in another state.
|
|
4551
|
+
# @return [String]
|
|
4552
|
+
#
|
|
4553
|
+
# @!attribute [rw] last_updated_at
|
|
4554
|
+
# The timestamp of when the recommender was edited.
|
|
4555
|
+
# @return [Time]
|
|
4556
|
+
#
|
|
4557
|
+
# @!attribute [rw] created_at
|
|
4558
|
+
# The timestamp of when the recommender was created.
|
|
4559
|
+
# @return [Time]
|
|
4560
|
+
#
|
|
4561
|
+
# @!attribute [rw] failure_reason
|
|
4562
|
+
# If the recommender fails, provides the reason for the failure.
|
|
4563
|
+
# @return [String]
|
|
4564
|
+
#
|
|
4565
|
+
# @!attribute [rw] latest_recommender_update
|
|
4566
|
+
# Information about the most recent update performed on the
|
|
4567
|
+
# recommender, including status and timestamp.
|
|
4568
|
+
# @return [Types::RecommenderUpdate]
|
|
4569
|
+
#
|
|
4570
|
+
# @!attribute [rw] training_metrics
|
|
4571
|
+
# A set of metrics that provide information about the recommender's
|
|
4572
|
+
# training performance and accuracy.
|
|
4573
|
+
# @return [Array<Types::TrainingMetrics>]
|
|
4574
|
+
#
|
|
4575
|
+
# @!attribute [rw] tags
|
|
4576
|
+
# The tags used to organize, track, or control access for this
|
|
4577
|
+
# resource.
|
|
4578
|
+
# @return [Hash<String,String>]
|
|
4579
|
+
#
|
|
4580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetRecommenderResponse AWS API Documentation
|
|
4581
|
+
#
|
|
4582
|
+
class GetRecommenderResponse < Struct.new(
|
|
4583
|
+
:recommender_name,
|
|
4584
|
+
:recommender_recipe_name,
|
|
4585
|
+
:recommender_config,
|
|
4586
|
+
:description,
|
|
4587
|
+
:status,
|
|
4588
|
+
:last_updated_at,
|
|
4589
|
+
:created_at,
|
|
4590
|
+
:failure_reason,
|
|
4591
|
+
:latest_recommender_update,
|
|
4592
|
+
:training_metrics,
|
|
4593
|
+
:tags)
|
|
4594
|
+
SENSITIVE = [:description]
|
|
4595
|
+
include Aws::Structure
|
|
4596
|
+
end
|
|
4597
|
+
|
|
3941
4598
|
# @!attribute [rw] domain_name
|
|
3942
4599
|
# The unique name of the domain.
|
|
3943
4600
|
# @return [String]
|
|
@@ -3984,6 +4641,18 @@ module Aws::CustomerProfiles
|
|
|
3984
4641
|
# resource.
|
|
3985
4642
|
# @return [Hash<String,String>]
|
|
3986
4643
|
#
|
|
4644
|
+
# @!attribute [rw] segment_sql_query
|
|
4645
|
+
# The segment SQL query.
|
|
4646
|
+
# @return [String]
|
|
4647
|
+
#
|
|
4648
|
+
# @!attribute [rw] segment_type
|
|
4649
|
+
# The segment type.
|
|
4650
|
+
#
|
|
4651
|
+
# Classic : Segments created using traditional SegmentGroup structure
|
|
4652
|
+
#
|
|
4653
|
+
# Enhanced : Segments created using SQL queries
|
|
4654
|
+
# @return [String]
|
|
4655
|
+
#
|
|
3987
4656
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentDefinitionResponse AWS API Documentation
|
|
3988
4657
|
#
|
|
3989
4658
|
class GetSegmentDefinitionResponse < Struct.new(
|
|
@@ -3993,8 +4662,10 @@ module Aws::CustomerProfiles
|
|
|
3993
4662
|
:segment_groups,
|
|
3994
4663
|
:segment_definition_arn,
|
|
3995
4664
|
:created_at,
|
|
3996
|
-
:tags
|
|
3997
|
-
|
|
4665
|
+
:tags,
|
|
4666
|
+
:segment_sql_query,
|
|
4667
|
+
:segment_type)
|
|
4668
|
+
SENSITIVE = [:description, :segment_groups, :segment_sql_query]
|
|
3998
4669
|
include Aws::Structure
|
|
3999
4670
|
end
|
|
4000
4671
|
|
|
@@ -4089,12 +4760,18 @@ module Aws::CustomerProfiles
|
|
|
4089
4760
|
# for the request.
|
|
4090
4761
|
# @return [Array<Types::ProfileQueryFailures>]
|
|
4091
4762
|
#
|
|
4763
|
+
# @!attribute [rw] last_computed_at
|
|
4764
|
+
# The timestamp indicating when the segment membership was last
|
|
4765
|
+
# computed or updated.
|
|
4766
|
+
# @return [Time]
|
|
4767
|
+
#
|
|
4092
4768
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentMembershipResponse AWS API Documentation
|
|
4093
4769
|
#
|
|
4094
4770
|
class GetSegmentMembershipResponse < Struct.new(
|
|
4095
4771
|
:segment_definition_name,
|
|
4096
4772
|
:profiles,
|
|
4097
|
-
:failures
|
|
4773
|
+
:failures,
|
|
4774
|
+
:last_computed_at)
|
|
4098
4775
|
SENSITIVE = []
|
|
4099
4776
|
include Aws::Structure
|
|
4100
4777
|
end
|
|
@@ -5068,6 +5745,47 @@ module Aws::CustomerProfiles
|
|
|
5068
5745
|
include Aws::Structure
|
|
5069
5746
|
end
|
|
5070
5747
|
|
|
5748
|
+
# @!attribute [rw] domain_name
|
|
5749
|
+
# The unique name of the domain.
|
|
5750
|
+
# @return [String]
|
|
5751
|
+
#
|
|
5752
|
+
# @!attribute [rw] max_results
|
|
5753
|
+
# The maximum number of domain object types returned per page.
|
|
5754
|
+
# @return [Integer]
|
|
5755
|
+
#
|
|
5756
|
+
# @!attribute [rw] next_token
|
|
5757
|
+
# The pagination token from the previous call to
|
|
5758
|
+
# ListDomainObjectTypes.
|
|
5759
|
+
# @return [String]
|
|
5760
|
+
#
|
|
5761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainObjectTypesRequest AWS API Documentation
|
|
5762
|
+
#
|
|
5763
|
+
class ListDomainObjectTypesRequest < Struct.new(
|
|
5764
|
+
:domain_name,
|
|
5765
|
+
:max_results,
|
|
5766
|
+
:next_token)
|
|
5767
|
+
SENSITIVE = []
|
|
5768
|
+
include Aws::Structure
|
|
5769
|
+
end
|
|
5770
|
+
|
|
5771
|
+
# @!attribute [rw] items
|
|
5772
|
+
# The list of domain object types.
|
|
5773
|
+
# @return [Array<Types::DomainObjectTypesListItem>]
|
|
5774
|
+
#
|
|
5775
|
+
# @!attribute [rw] next_token
|
|
5776
|
+
# The pagination token from the previous call to
|
|
5777
|
+
# ListDomainObjectTypes.
|
|
5778
|
+
# @return [String]
|
|
5779
|
+
#
|
|
5780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainObjectTypesResponse AWS API Documentation
|
|
5781
|
+
#
|
|
5782
|
+
class ListDomainObjectTypesResponse < Struct.new(
|
|
5783
|
+
:items,
|
|
5784
|
+
:next_token)
|
|
5785
|
+
SENSITIVE = [:items]
|
|
5786
|
+
include Aws::Structure
|
|
5787
|
+
end
|
|
5788
|
+
|
|
5071
5789
|
# @!attribute [rw] next_token
|
|
5072
5790
|
# The pagination token from the previous ListDomain API call.
|
|
5073
5791
|
# @return [String]
|
|
@@ -5241,7 +5959,7 @@ module Aws::CustomerProfiles
|
|
|
5241
5959
|
# @return [Time]
|
|
5242
5960
|
#
|
|
5243
5961
|
# @!attribute [rw] last_updated_at
|
|
5244
|
-
# The timestamp of when the
|
|
5962
|
+
# The timestamp of when the integration was most recently edited.
|
|
5245
5963
|
# @return [Time]
|
|
5246
5964
|
#
|
|
5247
5965
|
# @!attribute [rw] tags
|
|
@@ -5279,6 +5997,10 @@ module Aws::CustomerProfiles
|
|
|
5279
5997
|
# integration.
|
|
5280
5998
|
# @return [Array<String>]
|
|
5281
5999
|
#
|
|
6000
|
+
# @!attribute [rw] scope
|
|
6001
|
+
# The scope or boundary of the integration item's applicability.
|
|
6002
|
+
# @return [String]
|
|
6003
|
+
#
|
|
5282
6004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationItem AWS API Documentation
|
|
5283
6005
|
#
|
|
5284
6006
|
class ListIntegrationItem < Struct.new(
|
|
@@ -5292,7 +6014,8 @@ module Aws::CustomerProfiles
|
|
|
5292
6014
|
:workflow_id,
|
|
5293
6015
|
:is_unstructured,
|
|
5294
6016
|
:role_arn,
|
|
5295
|
-
:event_trigger_names
|
|
6017
|
+
:event_trigger_names,
|
|
6018
|
+
:scope)
|
|
5296
6019
|
SENSITIVE = []
|
|
5297
6020
|
include Aws::Structure
|
|
5298
6021
|
end
|
|
@@ -5361,6 +6084,80 @@ module Aws::CustomerProfiles
|
|
|
5361
6084
|
include Aws::Structure
|
|
5362
6085
|
end
|
|
5363
6086
|
|
|
6087
|
+
# Represents an item in the list of object type attribute values with
|
|
6088
|
+
# its associated metadata.
|
|
6089
|
+
#
|
|
6090
|
+
# @!attribute [rw] value
|
|
6091
|
+
# The actual value of the object type attribute.
|
|
6092
|
+
# @return [String]
|
|
6093
|
+
#
|
|
6094
|
+
# @!attribute [rw] last_updated_at
|
|
6095
|
+
# The timestamp of when the object type attribute value was most
|
|
6096
|
+
# recently updated.
|
|
6097
|
+
# @return [Time]
|
|
6098
|
+
#
|
|
6099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributeValuesItem AWS API Documentation
|
|
6100
|
+
#
|
|
6101
|
+
class ListObjectTypeAttributeValuesItem < Struct.new(
|
|
6102
|
+
:value,
|
|
6103
|
+
:last_updated_at)
|
|
6104
|
+
SENSITIVE = [:value]
|
|
6105
|
+
include Aws::Structure
|
|
6106
|
+
end
|
|
6107
|
+
|
|
6108
|
+
# @!attribute [rw] next_token
|
|
6109
|
+
# The pagination token from the previous call.
|
|
6110
|
+
# @return [String]
|
|
6111
|
+
#
|
|
6112
|
+
# @!attribute [rw] max_results
|
|
6113
|
+
# The maximum number of objects returned per page. Valid Range:
|
|
6114
|
+
# Minimum value of 1. Maximum value of 100. If not provided default as
|
|
6115
|
+
# 100.
|
|
6116
|
+
# @return [Integer]
|
|
6117
|
+
#
|
|
6118
|
+
# @!attribute [rw] domain_name
|
|
6119
|
+
# The unique name of the domain.
|
|
6120
|
+
# @return [String]
|
|
6121
|
+
#
|
|
6122
|
+
# @!attribute [rw] object_type_name
|
|
6123
|
+
# The unique name of the domain object type.
|
|
6124
|
+
# @return [String]
|
|
6125
|
+
#
|
|
6126
|
+
# @!attribute [rw] attribute_name
|
|
6127
|
+
# The attribute name.
|
|
6128
|
+
# @return [String]
|
|
6129
|
+
#
|
|
6130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributeValuesRequest AWS API Documentation
|
|
6131
|
+
#
|
|
6132
|
+
class ListObjectTypeAttributeValuesRequest < Struct.new(
|
|
6133
|
+
:next_token,
|
|
6134
|
+
:max_results,
|
|
6135
|
+
:domain_name,
|
|
6136
|
+
:object_type_name,
|
|
6137
|
+
:attribute_name)
|
|
6138
|
+
SENSITIVE = []
|
|
6139
|
+
include Aws::Structure
|
|
6140
|
+
end
|
|
6141
|
+
|
|
6142
|
+
# @!attribute [rw] items
|
|
6143
|
+
# A list of unique attribute values sorted on the basis of
|
|
6144
|
+
# LastUpdatedAt.
|
|
6145
|
+
# @return [Array<Types::ListObjectTypeAttributeValuesItem>]
|
|
6146
|
+
#
|
|
6147
|
+
# @!attribute [rw] next_token
|
|
6148
|
+
# The pagination token from the previous call to call
|
|
6149
|
+
# ListObjectTypeAttributeValues.
|
|
6150
|
+
# @return [String]
|
|
6151
|
+
#
|
|
6152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributeValuesResponse AWS API Documentation
|
|
6153
|
+
#
|
|
6154
|
+
class ListObjectTypeAttributeValuesResponse < Struct.new(
|
|
6155
|
+
:items,
|
|
6156
|
+
:next_token)
|
|
6157
|
+
SENSITIVE = []
|
|
6158
|
+
include Aws::Structure
|
|
6159
|
+
end
|
|
6160
|
+
|
|
5364
6161
|
# @!attribute [rw] next_token
|
|
5365
6162
|
# The pagination token from the previous call.
|
|
5366
6163
|
# @return [String]
|
|
@@ -5488,7 +6285,8 @@ module Aws::CustomerProfiles
|
|
|
5488
6285
|
# @return [Time]
|
|
5489
6286
|
#
|
|
5490
6287
|
# @!attribute [rw] last_updated_at
|
|
5491
|
-
# The timestamp of when the
|
|
6288
|
+
# The timestamp of when the profile object type was most recently
|
|
6289
|
+
# edited.
|
|
5492
6290
|
# @return [Time]
|
|
5493
6291
|
#
|
|
5494
6292
|
# @!attribute [rw] max_profile_object_count
|
|
@@ -5680,19 +6478,98 @@ module Aws::CustomerProfiles
|
|
|
5680
6478
|
include Aws::Structure
|
|
5681
6479
|
end
|
|
5682
6480
|
|
|
5683
|
-
# @!attribute [rw] items
|
|
5684
|
-
# The list of ListProfileObject instances.
|
|
5685
|
-
# @return [Array<Types::ListProfileObjectsItem>]
|
|
5686
|
-
#
|
|
6481
|
+
# @!attribute [rw] items
|
|
6482
|
+
# The list of ListProfileObject instances.
|
|
6483
|
+
# @return [Array<Types::ListProfileObjectsItem>]
|
|
6484
|
+
#
|
|
6485
|
+
# @!attribute [rw] next_token
|
|
6486
|
+
# The pagination token from the previous call to ListProfileObjects.
|
|
6487
|
+
# @return [String]
|
|
6488
|
+
#
|
|
6489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectsResponse AWS API Documentation
|
|
6490
|
+
#
|
|
6491
|
+
class ListProfileObjectsResponse < Struct.new(
|
|
6492
|
+
:items,
|
|
6493
|
+
:next_token)
|
|
6494
|
+
SENSITIVE = []
|
|
6495
|
+
include Aws::Structure
|
|
6496
|
+
end
|
|
6497
|
+
|
|
6498
|
+
# @!attribute [rw] max_results
|
|
6499
|
+
# The maximum number of recommender recipes to return in the response.
|
|
6500
|
+
# The default value is 100.
|
|
6501
|
+
# @return [Integer]
|
|
6502
|
+
#
|
|
6503
|
+
# @!attribute [rw] next_token
|
|
6504
|
+
# A token received from a previous ListRecommenderRecipes call to
|
|
6505
|
+
# retrieve the next page of results.
|
|
6506
|
+
# @return [String]
|
|
6507
|
+
#
|
|
6508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenderRecipesRequest AWS API Documentation
|
|
6509
|
+
#
|
|
6510
|
+
class ListRecommenderRecipesRequest < Struct.new(
|
|
6511
|
+
:max_results,
|
|
6512
|
+
:next_token)
|
|
6513
|
+
SENSITIVE = []
|
|
6514
|
+
include Aws::Structure
|
|
6515
|
+
end
|
|
6516
|
+
|
|
6517
|
+
# @!attribute [rw] next_token
|
|
6518
|
+
# A token to retrieve the next page of results. Null if there are no
|
|
6519
|
+
# more results to retrieve.
|
|
6520
|
+
# @return [String]
|
|
6521
|
+
#
|
|
6522
|
+
# @!attribute [rw] recommender_recipes
|
|
6523
|
+
# A list of available recommender recipes and their properties.
|
|
6524
|
+
# @return [Array<Types::RecommenderRecipe>]
|
|
6525
|
+
#
|
|
6526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenderRecipesResponse AWS API Documentation
|
|
6527
|
+
#
|
|
6528
|
+
class ListRecommenderRecipesResponse < Struct.new(
|
|
6529
|
+
:next_token,
|
|
6530
|
+
:recommender_recipes)
|
|
6531
|
+
SENSITIVE = []
|
|
6532
|
+
include Aws::Structure
|
|
6533
|
+
end
|
|
6534
|
+
|
|
6535
|
+
# @!attribute [rw] domain_name
|
|
6536
|
+
# The unique name of the domain.
|
|
6537
|
+
# @return [String]
|
|
6538
|
+
#
|
|
6539
|
+
# @!attribute [rw] max_results
|
|
6540
|
+
# The maximum number of recommenders to return in the response. The
|
|
6541
|
+
# default value is 100.
|
|
6542
|
+
# @return [Integer]
|
|
6543
|
+
#
|
|
6544
|
+
# @!attribute [rw] next_token
|
|
6545
|
+
# A token received from a previous ListRecommenders call to retrieve
|
|
6546
|
+
# the next page of results.
|
|
6547
|
+
# @return [String]
|
|
6548
|
+
#
|
|
6549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommendersRequest AWS API Documentation
|
|
6550
|
+
#
|
|
6551
|
+
class ListRecommendersRequest < Struct.new(
|
|
6552
|
+
:domain_name,
|
|
6553
|
+
:max_results,
|
|
6554
|
+
:next_token)
|
|
6555
|
+
SENSITIVE = []
|
|
6556
|
+
include Aws::Structure
|
|
6557
|
+
end
|
|
6558
|
+
|
|
5687
6559
|
# @!attribute [rw] next_token
|
|
5688
|
-
#
|
|
6560
|
+
# A token to retrieve the next page of results. Null if there are no
|
|
6561
|
+
# more results to retrieve.
|
|
5689
6562
|
# @return [String]
|
|
5690
6563
|
#
|
|
5691
|
-
#
|
|
6564
|
+
# @!attribute [rw] recommenders
|
|
6565
|
+
# A list of recommenders and their properties in the specified domain.
|
|
6566
|
+
# @return [Array<Types::RecommenderSummary>]
|
|
5692
6567
|
#
|
|
5693
|
-
|
|
5694
|
-
|
|
5695
|
-
|
|
6568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommendersResponse AWS API Documentation
|
|
6569
|
+
#
|
|
6570
|
+
class ListRecommendersResponse < Struct.new(
|
|
6571
|
+
:next_token,
|
|
6572
|
+
:recommenders)
|
|
5696
6573
|
SENSITIVE = []
|
|
5697
6574
|
include Aws::Structure
|
|
5698
6575
|
end
|
|
@@ -6763,23 +7640,99 @@ module Aws::CustomerProfiles
|
|
|
6763
7640
|
# The unique name of the domain.
|
|
6764
7641
|
# @return [String]
|
|
6765
7642
|
#
|
|
6766
|
-
# @!attribute [rw]
|
|
6767
|
-
# The
|
|
7643
|
+
# @!attribute [rw] object_type_name
|
|
7644
|
+
# The unique name of the domain object type.
|
|
7645
|
+
# @return [String]
|
|
7646
|
+
#
|
|
7647
|
+
# @!attribute [rw] description
|
|
7648
|
+
# The description of the domain object type.
|
|
7649
|
+
# @return [String]
|
|
7650
|
+
#
|
|
7651
|
+
# @!attribute [rw] encryption_key
|
|
7652
|
+
# The customer provided KMS key used to encrypt this type of domain
|
|
7653
|
+
# object.
|
|
6768
7654
|
# @return [String]
|
|
6769
7655
|
#
|
|
7656
|
+
# @!attribute [rw] fields
|
|
7657
|
+
# A map of field names to their corresponding domain object type field
|
|
7658
|
+
# definitions.
|
|
7659
|
+
# @return [Hash<String,Types::DomainObjectTypeField>]
|
|
7660
|
+
#
|
|
7661
|
+
# @!attribute [rw] tags
|
|
7662
|
+
# The tags used to organize, track, or control access for this
|
|
7663
|
+
# resource.
|
|
7664
|
+
# @return [Hash<String,String>]
|
|
7665
|
+
#
|
|
7666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutDomainObjectTypeRequest AWS API Documentation
|
|
7667
|
+
#
|
|
7668
|
+
class PutDomainObjectTypeRequest < Struct.new(
|
|
7669
|
+
:domain_name,
|
|
7670
|
+
:object_type_name,
|
|
7671
|
+
:description,
|
|
7672
|
+
:encryption_key,
|
|
7673
|
+
:fields,
|
|
7674
|
+
:tags)
|
|
7675
|
+
SENSITIVE = [:description]
|
|
7676
|
+
include Aws::Structure
|
|
7677
|
+
end
|
|
7678
|
+
|
|
6770
7679
|
# @!attribute [rw] object_type_name
|
|
6771
|
-
# The name of the
|
|
7680
|
+
# The unique name of the domain object type.
|
|
7681
|
+
# @return [String]
|
|
7682
|
+
#
|
|
7683
|
+
# @!attribute [rw] description
|
|
7684
|
+
# The description of the domain object type.
|
|
7685
|
+
# @return [String]
|
|
7686
|
+
#
|
|
7687
|
+
# @!attribute [rw] encryption_key
|
|
7688
|
+
# The customer provided KMS key used to encrypt this type of domain
|
|
7689
|
+
# object.
|
|
6772
7690
|
# @return [String]
|
|
6773
7691
|
#
|
|
7692
|
+
# @!attribute [rw] fields
|
|
7693
|
+
# A map of field names to their corresponding domain object type field
|
|
7694
|
+
# definitions.
|
|
7695
|
+
# @return [Hash<String,Types::DomainObjectTypeField>]
|
|
7696
|
+
#
|
|
7697
|
+
# @!attribute [rw] created_at
|
|
7698
|
+
# The timestamp of when the domain object type was created.
|
|
7699
|
+
# @return [Time]
|
|
7700
|
+
#
|
|
7701
|
+
# @!attribute [rw] last_updated_at
|
|
7702
|
+
# The timestamp of when the domain object type was most recently
|
|
7703
|
+
# edited.
|
|
7704
|
+
# @return [Time]
|
|
7705
|
+
#
|
|
6774
7706
|
# @!attribute [rw] tags
|
|
6775
7707
|
# The tags used to organize, track, or control access for this
|
|
6776
7708
|
# resource.
|
|
6777
7709
|
# @return [Hash<String,String>]
|
|
6778
7710
|
#
|
|
6779
|
-
#
|
|
6780
|
-
#
|
|
6781
|
-
|
|
6782
|
-
|
|
7711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutDomainObjectTypeResponse AWS API Documentation
|
|
7712
|
+
#
|
|
7713
|
+
class PutDomainObjectTypeResponse < Struct.new(
|
|
7714
|
+
:object_type_name,
|
|
7715
|
+
:description,
|
|
7716
|
+
:encryption_key,
|
|
7717
|
+
:fields,
|
|
7718
|
+
:created_at,
|
|
7719
|
+
:last_updated_at,
|
|
7720
|
+
:tags)
|
|
7721
|
+
SENSITIVE = [:description]
|
|
7722
|
+
include Aws::Structure
|
|
7723
|
+
end
|
|
7724
|
+
|
|
7725
|
+
# @!attribute [rw] domain_name
|
|
7726
|
+
# The unique name of the domain.
|
|
7727
|
+
# @return [String]
|
|
7728
|
+
#
|
|
7729
|
+
# @!attribute [rw] uri
|
|
7730
|
+
# The URI of the S3 bucket or any other type of data source.
|
|
7731
|
+
# @return [String]
|
|
7732
|
+
#
|
|
7733
|
+
# @!attribute [rw] object_type_name
|
|
7734
|
+
# The name of the profile object type.
|
|
7735
|
+
# @return [String]
|
|
6783
7736
|
#
|
|
6784
7737
|
# @!attribute [rw] object_type_names
|
|
6785
7738
|
# A map in which each key is an event type from an external
|
|
@@ -6791,6 +7744,16 @@ module Aws::CustomerProfiles
|
|
|
6791
7744
|
# `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`.
|
|
6792
7745
|
# @return [Hash<String,String>]
|
|
6793
7746
|
#
|
|
7747
|
+
# @!attribute [rw] tags
|
|
7748
|
+
# The tags used to organize, track, or control access for this
|
|
7749
|
+
# resource.
|
|
7750
|
+
# @return [Hash<String,String>]
|
|
7751
|
+
#
|
|
7752
|
+
# @!attribute [rw] flow_definition
|
|
7753
|
+
# The configuration that controls how Customer Profiles retrieves data
|
|
7754
|
+
# from the source.
|
|
7755
|
+
# @return [Types::FlowDefinition]
|
|
7756
|
+
#
|
|
6794
7757
|
# @!attribute [rw] role_arn
|
|
6795
7758
|
# The Amazon Resource Name (ARN) of the IAM role. The Integration uses
|
|
6796
7759
|
# this role to make Customer Profiles requests on your behalf.
|
|
@@ -6801,17 +7764,24 @@ module Aws::CustomerProfiles
|
|
|
6801
7764
|
# integration.
|
|
6802
7765
|
# @return [Array<String>]
|
|
6803
7766
|
#
|
|
7767
|
+
# @!attribute [rw] scope
|
|
7768
|
+
# Specifies whether the integration applies to profile level data
|
|
7769
|
+
# (associated with profiles) or domain level data (not associated with
|
|
7770
|
+
# any specific profile). The default value is PROFILE.
|
|
7771
|
+
# @return [String]
|
|
7772
|
+
#
|
|
6804
7773
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegrationRequest AWS API Documentation
|
|
6805
7774
|
#
|
|
6806
7775
|
class PutIntegrationRequest < Struct.new(
|
|
6807
7776
|
:domain_name,
|
|
6808
7777
|
:uri,
|
|
6809
7778
|
:object_type_name,
|
|
7779
|
+
:object_type_names,
|
|
6810
7780
|
:tags,
|
|
6811
7781
|
:flow_definition,
|
|
6812
|
-
:object_type_names,
|
|
6813
7782
|
:role_arn,
|
|
6814
|
-
:event_trigger_names
|
|
7783
|
+
:event_trigger_names,
|
|
7784
|
+
:scope)
|
|
6815
7785
|
SENSITIVE = [:flow_definition]
|
|
6816
7786
|
include Aws::Structure
|
|
6817
7787
|
end
|
|
@@ -6872,6 +7842,12 @@ module Aws::CustomerProfiles
|
|
|
6872
7842
|
# associated with the integration.
|
|
6873
7843
|
# @return [Array<String>]
|
|
6874
7844
|
#
|
|
7845
|
+
# @!attribute [rw] scope
|
|
7846
|
+
# Specifies whether the integration applies to profile level data
|
|
7847
|
+
# (associated with profiles) or domain level data (not associated with
|
|
7848
|
+
# any specific profile). The default value is PROFILE.
|
|
7849
|
+
# @return [String]
|
|
7850
|
+
#
|
|
6875
7851
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegrationResponse AWS API Documentation
|
|
6876
7852
|
#
|
|
6877
7853
|
class PutIntegrationResponse < Struct.new(
|
|
@@ -6885,7 +7861,8 @@ module Aws::CustomerProfiles
|
|
|
6885
7861
|
:workflow_id,
|
|
6886
7862
|
:is_unstructured,
|
|
6887
7863
|
:role_arn,
|
|
6888
|
-
:event_trigger_names
|
|
7864
|
+
:event_trigger_names,
|
|
7865
|
+
:scope)
|
|
6889
7866
|
SENSITIVE = []
|
|
6890
7867
|
include Aws::Structure
|
|
6891
7868
|
end
|
|
@@ -7195,6 +8172,167 @@ module Aws::CustomerProfiles
|
|
|
7195
8172
|
include Aws::Structure
|
|
7196
8173
|
end
|
|
7197
8174
|
|
|
8175
|
+
# Represents a single recommendation generated by the recommender
|
|
8176
|
+
# system.
|
|
8177
|
+
#
|
|
8178
|
+
# @!attribute [rw] catalog_item
|
|
8179
|
+
# The catalog item being recommended, including its complete details
|
|
8180
|
+
# and attributes.
|
|
8181
|
+
# @return [Types::CatalogItem]
|
|
8182
|
+
#
|
|
8183
|
+
# @!attribute [rw] score
|
|
8184
|
+
# Recommendation Score between 0 and 1.
|
|
8185
|
+
# @return [Float]
|
|
8186
|
+
#
|
|
8187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Recommendation AWS API Documentation
|
|
8188
|
+
#
|
|
8189
|
+
class Recommendation < Struct.new(
|
|
8190
|
+
:catalog_item,
|
|
8191
|
+
:score)
|
|
8192
|
+
SENSITIVE = []
|
|
8193
|
+
include Aws::Structure
|
|
8194
|
+
end
|
|
8195
|
+
|
|
8196
|
+
# Configuration settings that define the behavior and parameters of a
|
|
8197
|
+
# recommender.
|
|
8198
|
+
#
|
|
8199
|
+
# @!attribute [rw] events_config
|
|
8200
|
+
# Configuration settings for how the recommender processes and uses
|
|
8201
|
+
# events.
|
|
8202
|
+
# @return [Types::EventsConfig]
|
|
8203
|
+
#
|
|
8204
|
+
# @!attribute [rw] training_frequency
|
|
8205
|
+
# How often the recommender should retrain its model with new data.
|
|
8206
|
+
# @return [Integer]
|
|
8207
|
+
#
|
|
8208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RecommenderConfig AWS API Documentation
|
|
8209
|
+
#
|
|
8210
|
+
class RecommenderConfig < Struct.new(
|
|
8211
|
+
:events_config,
|
|
8212
|
+
:training_frequency)
|
|
8213
|
+
SENSITIVE = []
|
|
8214
|
+
include Aws::Structure
|
|
8215
|
+
end
|
|
8216
|
+
|
|
8217
|
+
# Defines the algorithm and approach used to generate recommendations.
|
|
8218
|
+
#
|
|
8219
|
+
# @!attribute [rw] name
|
|
8220
|
+
# The name of the recommender recipe.
|
|
8221
|
+
# @return [String]
|
|
8222
|
+
#
|
|
8223
|
+
# @!attribute [rw] description
|
|
8224
|
+
# A description of the recommender recipe's purpose and
|
|
8225
|
+
# functionality.
|
|
8226
|
+
# @return [String]
|
|
8227
|
+
#
|
|
8228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RecommenderRecipe AWS API Documentation
|
|
8229
|
+
#
|
|
8230
|
+
class RecommenderRecipe < Struct.new(
|
|
8231
|
+
:name,
|
|
8232
|
+
:description)
|
|
8233
|
+
SENSITIVE = []
|
|
8234
|
+
include Aws::Structure
|
|
8235
|
+
end
|
|
8236
|
+
|
|
8237
|
+
# Provides a summary of a recommender's configuration and current
|
|
8238
|
+
# state.
|
|
8239
|
+
#
|
|
8240
|
+
# @!attribute [rw] recommender_name
|
|
8241
|
+
# The name of the recommender.
|
|
8242
|
+
# @return [String]
|
|
8243
|
+
#
|
|
8244
|
+
# @!attribute [rw] recipe_name
|
|
8245
|
+
# The name of the recipe used by this recommender.
|
|
8246
|
+
# @return [String]
|
|
8247
|
+
#
|
|
8248
|
+
# @!attribute [rw] recommender_config
|
|
8249
|
+
# The configuration settings applied to this recommender.
|
|
8250
|
+
# @return [Types::RecommenderConfig]
|
|
8251
|
+
#
|
|
8252
|
+
# @!attribute [rw] created_at
|
|
8253
|
+
# The timestamp when the recommender was created.
|
|
8254
|
+
# @return [Time]
|
|
8255
|
+
#
|
|
8256
|
+
# @!attribute [rw] description
|
|
8257
|
+
# A description of the recommender's purpose and characteristics.
|
|
8258
|
+
# @return [String]
|
|
8259
|
+
#
|
|
8260
|
+
# @!attribute [rw] status
|
|
8261
|
+
# The current operational status of the recommender.
|
|
8262
|
+
# @return [String]
|
|
8263
|
+
#
|
|
8264
|
+
# @!attribute [rw] last_updated_at
|
|
8265
|
+
# The timestamp of when the recommender was edited.
|
|
8266
|
+
# @return [Time]
|
|
8267
|
+
#
|
|
8268
|
+
# @!attribute [rw] tags
|
|
8269
|
+
# The tags used to organize, track, or control access for this
|
|
8270
|
+
# resource.
|
|
8271
|
+
# @return [Hash<String,String>]
|
|
8272
|
+
#
|
|
8273
|
+
# @!attribute [rw] failure_reason
|
|
8274
|
+
# If the recommender is in a failed state, provides the reason for the
|
|
8275
|
+
# failure.
|
|
8276
|
+
# @return [String]
|
|
8277
|
+
#
|
|
8278
|
+
# @!attribute [rw] latest_recommender_update
|
|
8279
|
+
# Information about the most recent update performed on the
|
|
8280
|
+
# recommender, including its status and timing.
|
|
8281
|
+
# @return [Types::RecommenderUpdate]
|
|
8282
|
+
#
|
|
8283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RecommenderSummary AWS API Documentation
|
|
8284
|
+
#
|
|
8285
|
+
class RecommenderSummary < Struct.new(
|
|
8286
|
+
:recommender_name,
|
|
8287
|
+
:recipe_name,
|
|
8288
|
+
:recommender_config,
|
|
8289
|
+
:created_at,
|
|
8290
|
+
:description,
|
|
8291
|
+
:status,
|
|
8292
|
+
:last_updated_at,
|
|
8293
|
+
:tags,
|
|
8294
|
+
:failure_reason,
|
|
8295
|
+
:latest_recommender_update)
|
|
8296
|
+
SENSITIVE = [:description]
|
|
8297
|
+
include Aws::Structure
|
|
8298
|
+
end
|
|
8299
|
+
|
|
8300
|
+
# Contains information about an update operation performed on a
|
|
8301
|
+
# recommender.
|
|
8302
|
+
#
|
|
8303
|
+
# @!attribute [rw] recommender_config
|
|
8304
|
+
# The updated configuration settings applied to the recommender during
|
|
8305
|
+
# this update.
|
|
8306
|
+
# @return [Types::RecommenderConfig]
|
|
8307
|
+
#
|
|
8308
|
+
# @!attribute [rw] status
|
|
8309
|
+
# The current status of the recommender update operation.
|
|
8310
|
+
# @return [String]
|
|
8311
|
+
#
|
|
8312
|
+
# @!attribute [rw] created_at
|
|
8313
|
+
# The timestamp when this recommender update was initiated.
|
|
8314
|
+
# @return [Time]
|
|
8315
|
+
#
|
|
8316
|
+
# @!attribute [rw] last_updated_at
|
|
8317
|
+
# The timestamp of when the recommender was edited.
|
|
8318
|
+
# @return [Time]
|
|
8319
|
+
#
|
|
8320
|
+
# @!attribute [rw] failure_reason
|
|
8321
|
+
# If the update operation failed, provides the reason for the failure.
|
|
8322
|
+
# @return [String]
|
|
8323
|
+
#
|
|
8324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RecommenderUpdate AWS API Documentation
|
|
8325
|
+
#
|
|
8326
|
+
class RecommenderUpdate < Struct.new(
|
|
8327
|
+
:recommender_config,
|
|
8328
|
+
:status,
|
|
8329
|
+
:created_at,
|
|
8330
|
+
:last_updated_at,
|
|
8331
|
+
:failure_reason)
|
|
8332
|
+
SENSITIVE = []
|
|
8333
|
+
include Aws::Structure
|
|
8334
|
+
end
|
|
8335
|
+
|
|
7198
8336
|
# The requested resource does not exist, or access was denied.
|
|
7199
8337
|
#
|
|
7200
8338
|
# @!attribute [rw] message
|
|
@@ -7647,6 +8785,14 @@ module Aws::CustomerProfiles
|
|
|
7647
8785
|
# The tags belonging to the segment definition.
|
|
7648
8786
|
# @return [Hash<String,String>]
|
|
7649
8787
|
#
|
|
8788
|
+
# @!attribute [rw] segment_type
|
|
8789
|
+
# The segment type.
|
|
8790
|
+
#
|
|
8791
|
+
# Classic : Segments created using traditional SegmentGroup structure
|
|
8792
|
+
#
|
|
8793
|
+
# Enhanced : Segments created using SQL queries
|
|
8794
|
+
# @return [String]
|
|
8795
|
+
#
|
|
7650
8796
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SegmentDefinitionItem AWS API Documentation
|
|
7651
8797
|
#
|
|
7652
8798
|
class SegmentDefinitionItem < Struct.new(
|
|
@@ -7655,7 +8801,8 @@ module Aws::CustomerProfiles
|
|
|
7655
8801
|
:description,
|
|
7656
8802
|
:segment_definition_arn,
|
|
7657
8803
|
:created_at,
|
|
7658
|
-
:tags
|
|
8804
|
+
:tags,
|
|
8805
|
+
:segment_type)
|
|
7659
8806
|
SENSITIVE = [:description]
|
|
7660
8807
|
include Aws::Structure
|
|
7661
8808
|
end
|
|
@@ -7803,6 +8950,27 @@ module Aws::CustomerProfiles
|
|
|
7803
8950
|
include Aws::Structure
|
|
7804
8951
|
end
|
|
7805
8952
|
|
|
8953
|
+
# @!attribute [rw] domain_name
|
|
8954
|
+
# The unique name of the domain.
|
|
8955
|
+
# @return [String]
|
|
8956
|
+
#
|
|
8957
|
+
# @!attribute [rw] recommender_name
|
|
8958
|
+
# The name of the recommender to start.
|
|
8959
|
+
# @return [String]
|
|
8960
|
+
#
|
|
8961
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StartRecommenderRequest AWS API Documentation
|
|
8962
|
+
#
|
|
8963
|
+
class StartRecommenderRequest < Struct.new(
|
|
8964
|
+
:domain_name,
|
|
8965
|
+
:recommender_name)
|
|
8966
|
+
SENSITIVE = []
|
|
8967
|
+
include Aws::Structure
|
|
8968
|
+
end
|
|
8969
|
+
|
|
8970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StartRecommenderResponse AWS API Documentation
|
|
8971
|
+
#
|
|
8972
|
+
class StartRecommenderResponse < Aws::EmptyStructure; end
|
|
8973
|
+
|
|
7806
8974
|
# @!attribute [rw] domain_name
|
|
7807
8975
|
# The unique name of the domain containing the upload job to start.
|
|
7808
8976
|
# @return [String]
|
|
@@ -7824,6 +8992,27 @@ module Aws::CustomerProfiles
|
|
|
7824
8992
|
#
|
|
7825
8993
|
class StartUploadJobResponse < Aws::EmptyStructure; end
|
|
7826
8994
|
|
|
8995
|
+
# @!attribute [rw] domain_name
|
|
8996
|
+
# The unique name of the domain.
|
|
8997
|
+
# @return [String]
|
|
8998
|
+
#
|
|
8999
|
+
# @!attribute [rw] recommender_name
|
|
9000
|
+
# The name of the recommender to stop.
|
|
9001
|
+
# @return [String]
|
|
9002
|
+
#
|
|
9003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StopRecommenderRequest AWS API Documentation
|
|
9004
|
+
#
|
|
9005
|
+
class StopRecommenderRequest < Struct.new(
|
|
9006
|
+
:domain_name,
|
|
9007
|
+
:recommender_name)
|
|
9008
|
+
SENSITIVE = []
|
|
9009
|
+
include Aws::Structure
|
|
9010
|
+
end
|
|
9011
|
+
|
|
9012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StopRecommenderResponse AWS API Documentation
|
|
9013
|
+
#
|
|
9014
|
+
class StopRecommenderResponse < Aws::EmptyStructure; end
|
|
9015
|
+
|
|
7827
9016
|
# @!attribute [rw] domain_name
|
|
7828
9017
|
# The unique name of the domain containing the upload job to stop.
|
|
7829
9018
|
# @return [String]
|
|
@@ -7937,6 +9126,27 @@ module Aws::CustomerProfiles
|
|
|
7937
9126
|
include Aws::Structure
|
|
7938
9127
|
end
|
|
7939
9128
|
|
|
9129
|
+
# Contains metrics and performance indicators from the training of a
|
|
9130
|
+
# recommender model.
|
|
9131
|
+
#
|
|
9132
|
+
# @!attribute [rw] time
|
|
9133
|
+
# The timestamp when these training metrics were recorded.
|
|
9134
|
+
# @return [Time]
|
|
9135
|
+
#
|
|
9136
|
+
# @!attribute [rw] metrics
|
|
9137
|
+
# A collection of performance metrics and statistics from the training
|
|
9138
|
+
# process.
|
|
9139
|
+
# @return [Hash<String,Float>]
|
|
9140
|
+
#
|
|
9141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/TrainingMetrics AWS API Documentation
|
|
9142
|
+
#
|
|
9143
|
+
class TrainingMetrics < Struct.new(
|
|
9144
|
+
:time,
|
|
9145
|
+
:metrics)
|
|
9146
|
+
SENSITIVE = []
|
|
9147
|
+
include Aws::Structure
|
|
9148
|
+
end
|
|
9149
|
+
|
|
7940
9150
|
# The trigger settings that determine how and when Amazon AppFlow runs
|
|
7941
9151
|
# the specified flow.
|
|
7942
9152
|
#
|
|
@@ -8328,6 +9538,10 @@ module Aws::CustomerProfiles
|
|
|
8328
9538
|
# download the results from S3.
|
|
8329
9539
|
# @return [Types::RuleBasedMatchingRequest]
|
|
8330
9540
|
#
|
|
9541
|
+
# @!attribute [rw] data_store
|
|
9542
|
+
# Set to true to enabled data store for this domain.
|
|
9543
|
+
# @return [Types::DataStoreRequest]
|
|
9544
|
+
#
|
|
8331
9545
|
# @!attribute [rw] tags
|
|
8332
9546
|
# The tags used to organize, track, or control access for this
|
|
8333
9547
|
# resource.
|
|
@@ -8342,6 +9556,7 @@ module Aws::CustomerProfiles
|
|
|
8342
9556
|
:dead_letter_queue_url,
|
|
8343
9557
|
:matching,
|
|
8344
9558
|
:rule_based_matching,
|
|
9559
|
+
:data_store,
|
|
8345
9560
|
:tags)
|
|
8346
9561
|
SENSITIVE = []
|
|
8347
9562
|
include Aws::Structure
|
|
@@ -8395,6 +9610,10 @@ module Aws::CustomerProfiles
|
|
|
8395
9610
|
# download the results from S3.
|
|
8396
9611
|
# @return [Types::RuleBasedMatchingResponse]
|
|
8397
9612
|
#
|
|
9613
|
+
# @!attribute [rw] data_store
|
|
9614
|
+
# The data store.
|
|
9615
|
+
# @return [Types::DataStoreResponse]
|
|
9616
|
+
#
|
|
8398
9617
|
# @!attribute [rw] created_at
|
|
8399
9618
|
# The timestamp of when the domain was created.
|
|
8400
9619
|
# @return [Time]
|
|
@@ -8417,6 +9636,7 @@ module Aws::CustomerProfiles
|
|
|
8417
9636
|
:dead_letter_queue_url,
|
|
8418
9637
|
:matching,
|
|
8419
9638
|
:rule_based_matching,
|
|
9639
|
+
:data_store,
|
|
8420
9640
|
:created_at,
|
|
8421
9641
|
:last_updated_at,
|
|
8422
9642
|
:tags)
|
|
@@ -8683,6 +9903,46 @@ module Aws::CustomerProfiles
|
|
|
8683
9903
|
include Aws::Structure
|
|
8684
9904
|
end
|
|
8685
9905
|
|
|
9906
|
+
# @!attribute [rw] domain_name
|
|
9907
|
+
# The unique name of the domain.
|
|
9908
|
+
# @return [String]
|
|
9909
|
+
#
|
|
9910
|
+
# @!attribute [rw] recommender_name
|
|
9911
|
+
# The name of the recommender to update.
|
|
9912
|
+
# @return [String]
|
|
9913
|
+
#
|
|
9914
|
+
# @!attribute [rw] description
|
|
9915
|
+
# The new description to assign to the recommender.
|
|
9916
|
+
# @return [String]
|
|
9917
|
+
#
|
|
9918
|
+
# @!attribute [rw] recommender_config
|
|
9919
|
+
# The new configuration settings to apply to the recommender,
|
|
9920
|
+
# including updated parameters and settings that define its behavior.
|
|
9921
|
+
# @return [Types::RecommenderConfig]
|
|
9922
|
+
#
|
|
9923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateRecommenderRequest AWS API Documentation
|
|
9924
|
+
#
|
|
9925
|
+
class UpdateRecommenderRequest < Struct.new(
|
|
9926
|
+
:domain_name,
|
|
9927
|
+
:recommender_name,
|
|
9928
|
+
:description,
|
|
9929
|
+
:recommender_config)
|
|
9930
|
+
SENSITIVE = [:description]
|
|
9931
|
+
include Aws::Structure
|
|
9932
|
+
end
|
|
9933
|
+
|
|
9934
|
+
# @!attribute [rw] recommender_name
|
|
9935
|
+
# The name of the recommender that was updated.
|
|
9936
|
+
# @return [String]
|
|
9937
|
+
#
|
|
9938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateRecommenderResponse AWS API Documentation
|
|
9939
|
+
#
|
|
9940
|
+
class UpdateRecommenderResponse < Struct.new(
|
|
9941
|
+
:recommender_name)
|
|
9942
|
+
SENSITIVE = []
|
|
9943
|
+
include Aws::Structure
|
|
9944
|
+
end
|
|
9945
|
+
|
|
8686
9946
|
# The summary information for an individual upload job.
|
|
8687
9947
|
#
|
|
8688
9948
|
# @!attribute [rw] job_id
|