aws-sdk-customerprofiles 1.64.0 → 1.66.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +627 -25
- data/lib/aws-sdk-customerprofiles/client_api.rb +380 -3
- data/lib/aws-sdk-customerprofiles/types.rb +965 -13
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- data/sig/client.rbs +207 -5
- data/sig/types.rbs +234 -1
- metadata +1 -1
@@ -748,6 +748,11 @@ module Aws::CustomerProfiles
|
|
748
748
|
# The value of the calculated attribute.
|
749
749
|
# @return [String]
|
750
750
|
#
|
751
|
+
# @!attribute [rw] last_object_timestamp
|
752
|
+
# The timestamp of the newest object included in the calculated
|
753
|
+
# attribute calculation.
|
754
|
+
# @return [Time]
|
755
|
+
#
|
751
756
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CalculatedAttributeValue AWS API Documentation
|
752
757
|
#
|
753
758
|
class CalculatedAttributeValue < Struct.new(
|
@@ -755,7 +760,8 @@ module Aws::CustomerProfiles
|
|
755
760
|
:display_name,
|
756
761
|
:is_data_partial,
|
757
762
|
:profile_id,
|
758
|
-
:value
|
763
|
+
:value,
|
764
|
+
:last_object_timestamp)
|
759
765
|
SENSITIVE = []
|
760
766
|
include Aws::Structure
|
761
767
|
end
|
@@ -917,6 +923,11 @@ module Aws::CustomerProfiles
|
|
917
923
|
# The aggregation operation to perform for the calculated attribute.
|
918
924
|
# @return [String]
|
919
925
|
#
|
926
|
+
# @!attribute [rw] use_historical_data
|
927
|
+
# Whether historical data ingested before the Calculated Attribute was
|
928
|
+
# created should be included in calculations.
|
929
|
+
# @return [Boolean]
|
930
|
+
#
|
920
931
|
# @!attribute [rw] tags
|
921
932
|
# The tags used to organize, track, or control access for this
|
922
933
|
# resource.
|
@@ -933,6 +944,7 @@ module Aws::CustomerProfiles
|
|
933
944
|
:conditions,
|
934
945
|
:filter,
|
935
946
|
:statistic,
|
947
|
+
:use_historical_data,
|
936
948
|
:tags)
|
937
949
|
SENSITIVE = [:description, :attribute_details, :conditions, :statistic]
|
938
950
|
include Aws::Structure
|
@@ -978,6 +990,21 @@ module Aws::CustomerProfiles
|
|
978
990
|
# recently edited.
|
979
991
|
# @return [Time]
|
980
992
|
#
|
993
|
+
# @!attribute [rw] use_historical_data
|
994
|
+
# Whether historical data ingested before the Calculated Attribute was
|
995
|
+
# created should be included in calculations.
|
996
|
+
# @return [Boolean]
|
997
|
+
#
|
998
|
+
# @!attribute [rw] status
|
999
|
+
# Status of the Calculated Attribute creation (whether all historical
|
1000
|
+
# data has been indexed.)
|
1001
|
+
# @return [String]
|
1002
|
+
#
|
1003
|
+
# @!attribute [rw] readiness
|
1004
|
+
# Information indicating if the Calculated Attribute is ready for use
|
1005
|
+
# by confirming all historical data has been processed and reflected.
|
1006
|
+
# @return [Types::Readiness]
|
1007
|
+
#
|
981
1008
|
# @!attribute [rw] tags
|
982
1009
|
# The tags used to organize, track, or control access for this
|
983
1010
|
# resource.
|
@@ -995,11 +1022,130 @@ module Aws::CustomerProfiles
|
|
995
1022
|
:statistic,
|
996
1023
|
:created_at,
|
997
1024
|
:last_updated_at,
|
1025
|
+
:use_historical_data,
|
1026
|
+
:status,
|
1027
|
+
:readiness,
|
998
1028
|
:tags)
|
999
1029
|
SENSITIVE = [:description, :attribute_details, :conditions, :statistic]
|
1000
1030
|
include Aws::Structure
|
1001
1031
|
end
|
1002
1032
|
|
1033
|
+
# @!attribute [rw] domain_name
|
1034
|
+
# The unique name of the domain.
|
1035
|
+
# @return [String]
|
1036
|
+
#
|
1037
|
+
# @!attribute [rw] layout_definition_name
|
1038
|
+
# The unique name of the layout.
|
1039
|
+
# @return [String]
|
1040
|
+
#
|
1041
|
+
# @!attribute [rw] description
|
1042
|
+
# The description of the layout
|
1043
|
+
# @return [String]
|
1044
|
+
#
|
1045
|
+
# @!attribute [rw] display_name
|
1046
|
+
# The display name of the layout
|
1047
|
+
# @return [String]
|
1048
|
+
#
|
1049
|
+
# @!attribute [rw] is_default
|
1050
|
+
# If set to true for a layout, this layout will be used by default to
|
1051
|
+
# view data. If set to false, then the layout will not be used by
|
1052
|
+
# default, but it can be used to view data by explicitly selecting it
|
1053
|
+
# in the console.
|
1054
|
+
# @return [Boolean]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] layout_type
|
1057
|
+
# The type of layout that can be used to view data under a Customer
|
1058
|
+
# Profiles domain.
|
1059
|
+
# @return [String]
|
1060
|
+
#
|
1061
|
+
# @!attribute [rw] layout
|
1062
|
+
# A customizable layout that can be used to view data under a Customer
|
1063
|
+
# Profiles domain.
|
1064
|
+
# @return [String]
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] tags
|
1067
|
+
# The tags used to organize, track, or control access for this
|
1068
|
+
# resource.
|
1069
|
+
# @return [Hash<String,String>]
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateDomainLayoutRequest AWS API Documentation
|
1072
|
+
#
|
1073
|
+
class CreateDomainLayoutRequest < Struct.new(
|
1074
|
+
:domain_name,
|
1075
|
+
:layout_definition_name,
|
1076
|
+
:description,
|
1077
|
+
:display_name,
|
1078
|
+
:is_default,
|
1079
|
+
:layout_type,
|
1080
|
+
:layout,
|
1081
|
+
:tags)
|
1082
|
+
SENSITIVE = [:description, :layout]
|
1083
|
+
include Aws::Structure
|
1084
|
+
end
|
1085
|
+
|
1086
|
+
# @!attribute [rw] layout_definition_name
|
1087
|
+
# The unique name of the layout.
|
1088
|
+
# @return [String]
|
1089
|
+
#
|
1090
|
+
# @!attribute [rw] description
|
1091
|
+
# The description of the layout
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] display_name
|
1095
|
+
# The display name of the layout
|
1096
|
+
# @return [String]
|
1097
|
+
#
|
1098
|
+
# @!attribute [rw] is_default
|
1099
|
+
# If set to true for a layout, this layout will be used by default to
|
1100
|
+
# view data. If set to false, then the layout will not be used by
|
1101
|
+
# default, but it can be used to view data by explicitly selecting it
|
1102
|
+
# in the console.
|
1103
|
+
# @return [Boolean]
|
1104
|
+
#
|
1105
|
+
# @!attribute [rw] layout_type
|
1106
|
+
# The type of layout that can be used to view data under customer
|
1107
|
+
# profiles domain.
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] layout
|
1111
|
+
# A customizable layout that can be used to view data under Customer
|
1112
|
+
# Profiles domain.
|
1113
|
+
# @return [String]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] version
|
1116
|
+
# The version used to create layout.
|
1117
|
+
# @return [String]
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] tags
|
1120
|
+
# The tags used to organize, track, or control access for this
|
1121
|
+
# resource.
|
1122
|
+
# @return [Hash<String,String>]
|
1123
|
+
#
|
1124
|
+
# @!attribute [rw] created_at
|
1125
|
+
# The timestamp of when the layout was created.
|
1126
|
+
# @return [Time]
|
1127
|
+
#
|
1128
|
+
# @!attribute [rw] last_updated_at
|
1129
|
+
# The timestamp of when the layout was most recently updated.
|
1130
|
+
# @return [Time]
|
1131
|
+
#
|
1132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateDomainLayoutResponse AWS API Documentation
|
1133
|
+
#
|
1134
|
+
class CreateDomainLayoutResponse < Struct.new(
|
1135
|
+
:layout_definition_name,
|
1136
|
+
:description,
|
1137
|
+
:display_name,
|
1138
|
+
:is_default,
|
1139
|
+
:layout_type,
|
1140
|
+
:layout,
|
1141
|
+
:version,
|
1142
|
+
:tags,
|
1143
|
+
:created_at,
|
1144
|
+
:last_updated_at)
|
1145
|
+
SENSITIVE = [:description, :layout]
|
1146
|
+
include Aws::Structure
|
1147
|
+
end
|
1148
|
+
|
1003
1149
|
# @!attribute [rw] domain_name
|
1004
1150
|
# The unique name of the domain.
|
1005
1151
|
# @return [String]
|
@@ -1364,7 +1510,7 @@ module Aws::CustomerProfiles
|
|
1364
1510
|
# @return [String]
|
1365
1511
|
#
|
1366
1512
|
# @!attribute [rw] account_number
|
1367
|
-
# An account number that you have
|
1513
|
+
# An account number that you have assigned to the customer.
|
1368
1514
|
# @return [String]
|
1369
1515
|
#
|
1370
1516
|
# @!attribute [rw] additional_information
|
@@ -1673,6 +1819,55 @@ module Aws::CustomerProfiles
|
|
1673
1819
|
include Aws::Structure
|
1674
1820
|
end
|
1675
1821
|
|
1822
|
+
# @!attribute [rw] domain_name
|
1823
|
+
# The unique name of the domain. Domain should be exists for the
|
1824
|
+
# upload job to be created.
|
1825
|
+
# @return [String]
|
1826
|
+
#
|
1827
|
+
# @!attribute [rw] display_name
|
1828
|
+
# The unique name of the upload job. Could be a file name to identify
|
1829
|
+
# the upload job.
|
1830
|
+
# @return [String]
|
1831
|
+
#
|
1832
|
+
# @!attribute [rw] fields
|
1833
|
+
# The mapping between CSV Columns and Profile Object attributes. A map
|
1834
|
+
# of the name and ObjectType field.
|
1835
|
+
# @return [Hash<String,Types::ObjectTypeField>]
|
1836
|
+
#
|
1837
|
+
# @!attribute [rw] unique_key
|
1838
|
+
# The unique key columns for de-duping the profiles used to map data
|
1839
|
+
# to the profile.
|
1840
|
+
# @return [String]
|
1841
|
+
#
|
1842
|
+
# @!attribute [rw] data_expiry
|
1843
|
+
# The expiry duration for the profiles ingested with the job. If not
|
1844
|
+
# provided, the system default of 2 weeks is used.
|
1845
|
+
# @return [Integer]
|
1846
|
+
#
|
1847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateUploadJobRequest AWS API Documentation
|
1848
|
+
#
|
1849
|
+
class CreateUploadJobRequest < Struct.new(
|
1850
|
+
:domain_name,
|
1851
|
+
:display_name,
|
1852
|
+
:fields,
|
1853
|
+
:unique_key,
|
1854
|
+
:data_expiry)
|
1855
|
+
SENSITIVE = [:fields]
|
1856
|
+
include Aws::Structure
|
1857
|
+
end
|
1858
|
+
|
1859
|
+
# @!attribute [rw] job_id
|
1860
|
+
# The unique identifier for the created upload job.
|
1861
|
+
# @return [String]
|
1862
|
+
#
|
1863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateUploadJobResponse AWS API Documentation
|
1864
|
+
#
|
1865
|
+
class CreateUploadJobResponse < Struct.new(
|
1866
|
+
:job_id)
|
1867
|
+
SENSITIVE = []
|
1868
|
+
include Aws::Structure
|
1869
|
+
end
|
1870
|
+
|
1676
1871
|
# Object that segments on various Customer Profile's date fields.
|
1677
1872
|
#
|
1678
1873
|
# @!attribute [rw] dimension_type
|
@@ -1713,6 +1908,35 @@ module Aws::CustomerProfiles
|
|
1713
1908
|
#
|
1714
1909
|
class DeleteCalculatedAttributeDefinitionResponse < Aws::EmptyStructure; end
|
1715
1910
|
|
1911
|
+
# @!attribute [rw] domain_name
|
1912
|
+
# The unique name of the domain.
|
1913
|
+
# @return [String]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] layout_definition_name
|
1916
|
+
# The unique name of the layout.
|
1917
|
+
# @return [String]
|
1918
|
+
#
|
1919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainLayoutRequest AWS API Documentation
|
1920
|
+
#
|
1921
|
+
class DeleteDomainLayoutRequest < Struct.new(
|
1922
|
+
:domain_name,
|
1923
|
+
:layout_definition_name)
|
1924
|
+
SENSITIVE = []
|
1925
|
+
include Aws::Structure
|
1926
|
+
end
|
1927
|
+
|
1928
|
+
# @!attribute [rw] message
|
1929
|
+
# A message that indicates the delete request is done.
|
1930
|
+
# @return [String]
|
1931
|
+
#
|
1932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainLayoutResponse AWS API Documentation
|
1933
|
+
#
|
1934
|
+
class DeleteDomainLayoutResponse < Struct.new(
|
1935
|
+
:message)
|
1936
|
+
SENSITIVE = []
|
1937
|
+
include Aws::Structure
|
1938
|
+
end
|
1939
|
+
|
1716
1940
|
# @!attribute [rw] domain_name
|
1717
1941
|
# The unique name of the domain.
|
1718
1942
|
# @return [String]
|
@@ -2755,6 +2979,21 @@ module Aws::CustomerProfiles
|
|
2755
2979
|
# that expression.
|
2756
2980
|
# @return [Types::AttributeDetails]
|
2757
2981
|
#
|
2982
|
+
# @!attribute [rw] use_historical_data
|
2983
|
+
# Whether historical data ingested before the Calculated Attribute was
|
2984
|
+
# created should be included in calculations.
|
2985
|
+
# @return [Boolean]
|
2986
|
+
#
|
2987
|
+
# @!attribute [rw] status
|
2988
|
+
# Status of the Calculated Attribute creation (whether all historical
|
2989
|
+
# data has been indexed).
|
2990
|
+
# @return [String]
|
2991
|
+
#
|
2992
|
+
# @!attribute [rw] readiness
|
2993
|
+
# Information indicating if the Calculated Attribute is ready for use
|
2994
|
+
# by confirming all historical data has been processed and reflected.
|
2995
|
+
# @return [Types::Readiness]
|
2996
|
+
#
|
2758
2997
|
# @!attribute [rw] tags
|
2759
2998
|
# The tags used to organize, track, or control access for this
|
2760
2999
|
# resource.
|
@@ -2772,6 +3011,9 @@ module Aws::CustomerProfiles
|
|
2772
3011
|
:filter,
|
2773
3012
|
:conditions,
|
2774
3013
|
:attribute_details,
|
3014
|
+
:use_historical_data,
|
3015
|
+
:status,
|
3016
|
+
:readiness,
|
2775
3017
|
:tags)
|
2776
3018
|
SENSITIVE = [:description, :statistic, :conditions, :attribute_details]
|
2777
3019
|
include Aws::Structure
|
@@ -2816,17 +3058,103 @@ module Aws::CustomerProfiles
|
|
2816
3058
|
# The value of the calculated attribute.
|
2817
3059
|
# @return [String]
|
2818
3060
|
#
|
3061
|
+
# @!attribute [rw] last_object_timestamp
|
3062
|
+
# The timestamp of the newest object included in the calculated
|
3063
|
+
# attribute calculation.
|
3064
|
+
# @return [Time]
|
3065
|
+
#
|
2819
3066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeForProfileResponse AWS API Documentation
|
2820
3067
|
#
|
2821
3068
|
class GetCalculatedAttributeForProfileResponse < Struct.new(
|
2822
3069
|
:calculated_attribute_name,
|
2823
3070
|
:display_name,
|
2824
3071
|
:is_data_partial,
|
2825
|
-
:value
|
3072
|
+
:value,
|
3073
|
+
:last_object_timestamp)
|
2826
3074
|
SENSITIVE = []
|
2827
3075
|
include Aws::Structure
|
2828
3076
|
end
|
2829
3077
|
|
3078
|
+
# @!attribute [rw] domain_name
|
3079
|
+
# The unique name of the domain.
|
3080
|
+
# @return [String]
|
3081
|
+
#
|
3082
|
+
# @!attribute [rw] layout_definition_name
|
3083
|
+
# The unique name of the layout.
|
3084
|
+
# @return [String]
|
3085
|
+
#
|
3086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainLayoutRequest AWS API Documentation
|
3087
|
+
#
|
3088
|
+
class GetDomainLayoutRequest < Struct.new(
|
3089
|
+
:domain_name,
|
3090
|
+
:layout_definition_name)
|
3091
|
+
SENSITIVE = []
|
3092
|
+
include Aws::Structure
|
3093
|
+
end
|
3094
|
+
|
3095
|
+
# @!attribute [rw] layout_definition_name
|
3096
|
+
# The unique name of the layout.
|
3097
|
+
# @return [String]
|
3098
|
+
#
|
3099
|
+
# @!attribute [rw] description
|
3100
|
+
# The description of the layout
|
3101
|
+
# @return [String]
|
3102
|
+
#
|
3103
|
+
# @!attribute [rw] display_name
|
3104
|
+
# The display name of the layout
|
3105
|
+
# @return [String]
|
3106
|
+
#
|
3107
|
+
# @!attribute [rw] is_default
|
3108
|
+
# If set to true for a layout, this layout will be used by default to
|
3109
|
+
# view data. If set to false, then the layout will not be used by
|
3110
|
+
# default, but it can be used to view data by explicitly selecting it
|
3111
|
+
# in the console.
|
3112
|
+
# @return [Boolean]
|
3113
|
+
#
|
3114
|
+
# @!attribute [rw] layout_type
|
3115
|
+
# The type of layout that can be used to view data under a Customer
|
3116
|
+
# Profiles domain.
|
3117
|
+
# @return [String]
|
3118
|
+
#
|
3119
|
+
# @!attribute [rw] layout
|
3120
|
+
# A customizable layout that can be used to view data under a Customer
|
3121
|
+
# Profiles domain.
|
3122
|
+
# @return [String]
|
3123
|
+
#
|
3124
|
+
# @!attribute [rw] version
|
3125
|
+
# The version used to create layout.
|
3126
|
+
# @return [String]
|
3127
|
+
#
|
3128
|
+
# @!attribute [rw] created_at
|
3129
|
+
# The timestamp of when the layout was created.
|
3130
|
+
# @return [Time]
|
3131
|
+
#
|
3132
|
+
# @!attribute [rw] last_updated_at
|
3133
|
+
# The timestamp of when the layout was most recently updated.
|
3134
|
+
# @return [Time]
|
3135
|
+
#
|
3136
|
+
# @!attribute [rw] tags
|
3137
|
+
# The tags used to organize, track, or control access for this
|
3138
|
+
# resource.
|
3139
|
+
# @return [Hash<String,String>]
|
3140
|
+
#
|
3141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainLayoutResponse AWS API Documentation
|
3142
|
+
#
|
3143
|
+
class GetDomainLayoutResponse < Struct.new(
|
3144
|
+
:layout_definition_name,
|
3145
|
+
:description,
|
3146
|
+
:display_name,
|
3147
|
+
:is_default,
|
3148
|
+
:layout_type,
|
3149
|
+
:layout,
|
3150
|
+
:version,
|
3151
|
+
:created_at,
|
3152
|
+
:last_updated_at,
|
3153
|
+
:tags)
|
3154
|
+
SENSITIVE = [:description, :layout]
|
3155
|
+
include Aws::Structure
|
3156
|
+
end
|
3157
|
+
|
2830
3158
|
# @!attribute [rw] domain_name
|
2831
3159
|
# The unique name of the domain.
|
2832
3160
|
# @return [String]
|
@@ -3782,6 +4110,159 @@ module Aws::CustomerProfiles
|
|
3782
4110
|
include Aws::Structure
|
3783
4111
|
end
|
3784
4112
|
|
4113
|
+
# @!attribute [rw] domain_name
|
4114
|
+
# The unique name of the domain containing the upload job.
|
4115
|
+
# @return [String]
|
4116
|
+
#
|
4117
|
+
# @!attribute [rw] job_id
|
4118
|
+
# The unique identifier of the upload job to retrieve the upload path
|
4119
|
+
# for. This is generated from the CreateUploadJob API.
|
4120
|
+
# @return [String]
|
4121
|
+
#
|
4122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetUploadJobPathRequest AWS API Documentation
|
4123
|
+
#
|
4124
|
+
class GetUploadJobPathRequest < Struct.new(
|
4125
|
+
:domain_name,
|
4126
|
+
:job_id)
|
4127
|
+
SENSITIVE = []
|
4128
|
+
include Aws::Structure
|
4129
|
+
end
|
4130
|
+
|
4131
|
+
# @!attribute [rw] url
|
4132
|
+
# The pre-signed S3 URL for uploading the CSV file associated with the
|
4133
|
+
# upload job.
|
4134
|
+
# @return [String]
|
4135
|
+
#
|
4136
|
+
# @!attribute [rw] client_token
|
4137
|
+
# The plaintext data key used to encrypt the upload file.
|
4138
|
+
#
|
4139
|
+
# To persist to the pre-signed url, use the client token and MD5
|
4140
|
+
# client token as header. The required headers are as follows:
|
4141
|
+
#
|
4142
|
+
# * x-amz-server-side-encryption-customer-key: Client Token
|
4143
|
+
#
|
4144
|
+
# * x-amz-server-side-encryption-customer-key-MD5: MD5 Client Token
|
4145
|
+
#
|
4146
|
+
# * x-amz-server-side-encryption-customer-algorithm: AES256
|
4147
|
+
# @return [String]
|
4148
|
+
#
|
4149
|
+
# @!attribute [rw] valid_until
|
4150
|
+
# The expiry timestamp for the pre-signed URL, after which the URL
|
4151
|
+
# will no longer be valid.
|
4152
|
+
# @return [Time]
|
4153
|
+
#
|
4154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetUploadJobPathResponse AWS API Documentation
|
4155
|
+
#
|
4156
|
+
class GetUploadJobPathResponse < Struct.new(
|
4157
|
+
:url,
|
4158
|
+
:client_token,
|
4159
|
+
:valid_until)
|
4160
|
+
SENSITIVE = []
|
4161
|
+
include Aws::Structure
|
4162
|
+
end
|
4163
|
+
|
4164
|
+
# @!attribute [rw] domain_name
|
4165
|
+
# The unique name of the domain containing the upload job.
|
4166
|
+
# @return [String]
|
4167
|
+
#
|
4168
|
+
# @!attribute [rw] job_id
|
4169
|
+
# The unique identifier of the upload job to retrieve.
|
4170
|
+
# @return [String]
|
4171
|
+
#
|
4172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetUploadJobRequest AWS API Documentation
|
4173
|
+
#
|
4174
|
+
class GetUploadJobRequest < Struct.new(
|
4175
|
+
:domain_name,
|
4176
|
+
:job_id)
|
4177
|
+
SENSITIVE = []
|
4178
|
+
include Aws::Structure
|
4179
|
+
end
|
4180
|
+
|
4181
|
+
# @!attribute [rw] job_id
|
4182
|
+
# The unique identifier of the upload job.
|
4183
|
+
# @return [String]
|
4184
|
+
#
|
4185
|
+
# @!attribute [rw] display_name
|
4186
|
+
# The unique name of the upload job. Could be a file name to identify
|
4187
|
+
# the upload job.
|
4188
|
+
# @return [String]
|
4189
|
+
#
|
4190
|
+
# @!attribute [rw] status
|
4191
|
+
# The status describing the status for the upload job. The following
|
4192
|
+
# are Valid Values:
|
4193
|
+
#
|
4194
|
+
# * **CREATED**: The upload job has been created, but has not started
|
4195
|
+
# processing yet.
|
4196
|
+
#
|
4197
|
+
# * **IN\_PROGRESS**: The upload job is currently in progress,
|
4198
|
+
# ingesting and processing the profile data.
|
4199
|
+
#
|
4200
|
+
# * **PARTIALLY\_SUCCEEDED**: The upload job has successfully
|
4201
|
+
# completed the ingestion and processing of all profile data.
|
4202
|
+
#
|
4203
|
+
# * **SUCCEEDED**: The upload job has successfully completed the
|
4204
|
+
# ingestion and processing of all profile data.
|
4205
|
+
#
|
4206
|
+
# * **FAILED**: The upload job has failed to complete.
|
4207
|
+
#
|
4208
|
+
# * **STOPPED**: The upload job has been manually stopped or
|
4209
|
+
# terminated before completion.
|
4210
|
+
# @return [String]
|
4211
|
+
#
|
4212
|
+
# @!attribute [rw] status_reason
|
4213
|
+
# The reason for the current status of the upload job. Possible
|
4214
|
+
# reasons:
|
4215
|
+
#
|
4216
|
+
# * **VALIDATION\_FAILURE**: The upload job has encountered an error
|
4217
|
+
# or issue and was unable to complete the profile data ingestion.
|
4218
|
+
#
|
4219
|
+
# * **INTERNAL\_FAILURE**: Failure caused from service side
|
4220
|
+
# @return [String]
|
4221
|
+
#
|
4222
|
+
# @!attribute [rw] created_at
|
4223
|
+
# The timestamp when the upload job was created.
|
4224
|
+
# @return [Time]
|
4225
|
+
#
|
4226
|
+
# @!attribute [rw] completed_at
|
4227
|
+
# The timestamp when the upload job was completed.
|
4228
|
+
# @return [Time]
|
4229
|
+
#
|
4230
|
+
# @!attribute [rw] fields
|
4231
|
+
# The mapping between CSV Columns and Profile Object attributes for
|
4232
|
+
# the upload job.
|
4233
|
+
# @return [Hash<String,Types::ObjectTypeField>]
|
4234
|
+
#
|
4235
|
+
# @!attribute [rw] unique_key
|
4236
|
+
# The unique key columns used for de-duping the keys in the upload
|
4237
|
+
# job.
|
4238
|
+
# @return [String]
|
4239
|
+
#
|
4240
|
+
# @!attribute [rw] results_summary
|
4241
|
+
# The summary of results for the upload job, including the number of
|
4242
|
+
# updated, created, and failed records.
|
4243
|
+
# @return [Types::ResultsSummary]
|
4244
|
+
#
|
4245
|
+
# @!attribute [rw] data_expiry
|
4246
|
+
# The expiry duration for the profiles ingested with the upload job.
|
4247
|
+
# @return [Integer]
|
4248
|
+
#
|
4249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetUploadJobResponse AWS API Documentation
|
4250
|
+
#
|
4251
|
+
class GetUploadJobResponse < Struct.new(
|
4252
|
+
:job_id,
|
4253
|
+
:display_name,
|
4254
|
+
:status,
|
4255
|
+
:status_reason,
|
4256
|
+
:created_at,
|
4257
|
+
:completed_at,
|
4258
|
+
:fields,
|
4259
|
+
:unique_key,
|
4260
|
+
:results_summary,
|
4261
|
+
:data_expiry)
|
4262
|
+
SENSITIVE = [:fields]
|
4263
|
+
include Aws::Structure
|
4264
|
+
end
|
4265
|
+
|
3785
4266
|
# @!attribute [rw] domain_name
|
3786
4267
|
# The unique name of the domain.
|
3787
4268
|
# @return [String]
|
@@ -4085,13 +4566,67 @@ module Aws::CustomerProfiles
|
|
4085
4566
|
# The number of merges completed.
|
4086
4567
|
# @return [Integer]
|
4087
4568
|
#
|
4088
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/JobStats AWS API Documentation
|
4569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/JobStats AWS API Documentation
|
4570
|
+
#
|
4571
|
+
class JobStats < Struct.new(
|
4572
|
+
:number_of_profiles_reviewed,
|
4573
|
+
:number_of_matches_found,
|
4574
|
+
:number_of_merges_done)
|
4575
|
+
SENSITIVE = []
|
4576
|
+
include Aws::Structure
|
4577
|
+
end
|
4578
|
+
|
4579
|
+
# The layout object that contains LayoutDefinitionName, Description,
|
4580
|
+
# DisplayName, IsDefault, LayoutType, Tags, CreatedAt, LastUpdatedAt
|
4581
|
+
#
|
4582
|
+
# @!attribute [rw] layout_definition_name
|
4583
|
+
# The unique name of the layout.
|
4584
|
+
# @return [String]
|
4585
|
+
#
|
4586
|
+
# @!attribute [rw] description
|
4587
|
+
# The description of the layout
|
4588
|
+
# @return [String]
|
4589
|
+
#
|
4590
|
+
# @!attribute [rw] display_name
|
4591
|
+
# The display name of the layout
|
4592
|
+
# @return [String]
|
4593
|
+
#
|
4594
|
+
# @!attribute [rw] is_default
|
4595
|
+
# If set to true for a layout, this layout will be used by default to
|
4596
|
+
# view data. If set to false, then layout will not be used by default
|
4597
|
+
# but it can be used to view data by explicit selection on UI.
|
4598
|
+
# @return [Boolean]
|
4599
|
+
#
|
4600
|
+
# @!attribute [rw] layout_type
|
4601
|
+
# The type of layout that can be used to view data under customer
|
4602
|
+
# profiles domain.
|
4603
|
+
# @return [String]
|
4604
|
+
#
|
4605
|
+
# @!attribute [rw] tags
|
4606
|
+
# The tags used to organize, track, or control access for this
|
4607
|
+
# resource.
|
4608
|
+
# @return [Hash<String,String>]
|
4609
|
+
#
|
4610
|
+
# @!attribute [rw] created_at
|
4611
|
+
# The timestamp of when the layout was created.
|
4612
|
+
# @return [Time]
|
4613
|
+
#
|
4614
|
+
# @!attribute [rw] last_updated_at
|
4615
|
+
# The timestamp of when the layout was most recently updated.
|
4616
|
+
# @return [Time]
|
4617
|
+
#
|
4618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/LayoutItem AWS API Documentation
|
4089
4619
|
#
|
4090
|
-
class
|
4091
|
-
:
|
4092
|
-
:
|
4093
|
-
:
|
4094
|
-
|
4620
|
+
class LayoutItem < Struct.new(
|
4621
|
+
:layout_definition_name,
|
4622
|
+
:description,
|
4623
|
+
:display_name,
|
4624
|
+
:is_default,
|
4625
|
+
:layout_type,
|
4626
|
+
:tags,
|
4627
|
+
:created_at,
|
4628
|
+
:last_updated_at)
|
4629
|
+
SENSITIVE = [:description]
|
4095
4630
|
include Aws::Structure
|
4096
4631
|
end
|
4097
4632
|
|
@@ -4165,6 +4700,16 @@ module Aws::CustomerProfiles
|
|
4165
4700
|
# recently edited.
|
4166
4701
|
# @return [Time]
|
4167
4702
|
#
|
4703
|
+
# @!attribute [rw] use_historical_data
|
4704
|
+
# Whether historical data ingested before the Calculated Attribute was
|
4705
|
+
# created should be included in calculations.
|
4706
|
+
# @return [Boolean]
|
4707
|
+
#
|
4708
|
+
# @!attribute [rw] status
|
4709
|
+
# Status of the Calculated Attribute creation (whether all historical
|
4710
|
+
# data has been indexed.)
|
4711
|
+
# @return [String]
|
4712
|
+
#
|
4168
4713
|
# @!attribute [rw] tags
|
4169
4714
|
# The tags used to organize, track, or control access for this
|
4170
4715
|
# resource.
|
@@ -4178,6 +4723,8 @@ module Aws::CustomerProfiles
|
|
4178
4723
|
:description,
|
4179
4724
|
:created_at,
|
4180
4725
|
:last_updated_at,
|
4726
|
+
:use_historical_data,
|
4727
|
+
:status,
|
4181
4728
|
:tags)
|
4182
4729
|
SENSITIVE = [:description]
|
4183
4730
|
include Aws::Structure
|
@@ -4244,13 +4791,19 @@ module Aws::CustomerProfiles
|
|
4244
4791
|
# The value of the calculated attribute.
|
4245
4792
|
# @return [String]
|
4246
4793
|
#
|
4794
|
+
# @!attribute [rw] last_object_timestamp
|
4795
|
+
# The timestamp of the newest object included in the calculated
|
4796
|
+
# attribute calculation.
|
4797
|
+
# @return [Time]
|
4798
|
+
#
|
4247
4799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeForProfileItem AWS API Documentation
|
4248
4800
|
#
|
4249
4801
|
class ListCalculatedAttributeForProfileItem < Struct.new(
|
4250
4802
|
:calculated_attribute_name,
|
4251
4803
|
:display_name,
|
4252
4804
|
:is_data_partial,
|
4253
|
-
:value
|
4805
|
+
:value,
|
4806
|
+
:last_object_timestamp)
|
4254
4807
|
SENSITIVE = []
|
4255
4808
|
include Aws::Structure
|
4256
4809
|
end
|
@@ -4331,6 +4884,45 @@ module Aws::CustomerProfiles
|
|
4331
4884
|
include Aws::Structure
|
4332
4885
|
end
|
4333
4886
|
|
4887
|
+
# @!attribute [rw] domain_name
|
4888
|
+
# The unique name of the domain.
|
4889
|
+
# @return [String]
|
4890
|
+
#
|
4891
|
+
# @!attribute [rw] next_token
|
4892
|
+
# Identifies the next page of results to return.
|
4893
|
+
# @return [String]
|
4894
|
+
#
|
4895
|
+
# @!attribute [rw] max_results
|
4896
|
+
# The maximum number of objects returned per page.
|
4897
|
+
# @return [Integer]
|
4898
|
+
#
|
4899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainLayoutsRequest AWS API Documentation
|
4900
|
+
#
|
4901
|
+
class ListDomainLayoutsRequest < Struct.new(
|
4902
|
+
:domain_name,
|
4903
|
+
:next_token,
|
4904
|
+
:max_results)
|
4905
|
+
SENSITIVE = []
|
4906
|
+
include Aws::Structure
|
4907
|
+
end
|
4908
|
+
|
4909
|
+
# @!attribute [rw] items
|
4910
|
+
# Contains summary information about an EventStream.
|
4911
|
+
# @return [Array<Types::LayoutItem>]
|
4912
|
+
#
|
4913
|
+
# @!attribute [rw] next_token
|
4914
|
+
# Identifies the next page of results to return.
|
4915
|
+
# @return [String]
|
4916
|
+
#
|
4917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainLayoutsResponse AWS API Documentation
|
4918
|
+
#
|
4919
|
+
class ListDomainLayoutsResponse < Struct.new(
|
4920
|
+
:items,
|
4921
|
+
:next_token)
|
4922
|
+
SENSITIVE = []
|
4923
|
+
include Aws::Structure
|
4924
|
+
end
|
4925
|
+
|
4334
4926
|
# @!attribute [rw] next_token
|
4335
4927
|
# The pagination token from the previous ListDomain API call.
|
4336
4928
|
# @return [String]
|
@@ -4997,6 +5589,46 @@ module Aws::CustomerProfiles
|
|
4997
5589
|
include Aws::Structure
|
4998
5590
|
end
|
4999
5591
|
|
5592
|
+
# @!attribute [rw] domain_name
|
5593
|
+
# The unique name of the domain to list upload jobs for.
|
5594
|
+
# @return [String]
|
5595
|
+
#
|
5596
|
+
# @!attribute [rw] max_results
|
5597
|
+
# The maximum number of upload jobs to return per page.
|
5598
|
+
# @return [Integer]
|
5599
|
+
#
|
5600
|
+
# @!attribute [rw] next_token
|
5601
|
+
# The pagination token from the previous call to retrieve the next
|
5602
|
+
# page of results.
|
5603
|
+
# @return [String]
|
5604
|
+
#
|
5605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListUploadJobsRequest AWS API Documentation
|
5606
|
+
#
|
5607
|
+
class ListUploadJobsRequest < Struct.new(
|
5608
|
+
:domain_name,
|
5609
|
+
:max_results,
|
5610
|
+
:next_token)
|
5611
|
+
SENSITIVE = []
|
5612
|
+
include Aws::Structure
|
5613
|
+
end
|
5614
|
+
|
5615
|
+
# @!attribute [rw] next_token
|
5616
|
+
# The pagination token to use to retrieve the next page of results.
|
5617
|
+
# @return [String]
|
5618
|
+
#
|
5619
|
+
# @!attribute [rw] items
|
5620
|
+
# The list of upload jobs for the specified domain.
|
5621
|
+
# @return [Array<Types::UploadJobItem>]
|
5622
|
+
#
|
5623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListUploadJobsResponse AWS API Documentation
|
5624
|
+
#
|
5625
|
+
class ListUploadJobsResponse < Struct.new(
|
5626
|
+
:next_token,
|
5627
|
+
:items)
|
5628
|
+
SENSITIVE = []
|
5629
|
+
include Aws::Structure
|
5630
|
+
end
|
5631
|
+
|
5000
5632
|
# A workflow in list of workflows.
|
5001
5633
|
#
|
5002
5634
|
# @!attribute [rw] workflow_type
|
@@ -5451,7 +6083,7 @@ module Aws::CustomerProfiles
|
|
5451
6083
|
# @return [String]
|
5452
6084
|
#
|
5453
6085
|
# @!attribute [rw] account_number
|
5454
|
-
# An account number that you have
|
6086
|
+
# An account number that you have assigned to the customer.
|
5455
6087
|
# @return [String]
|
5456
6088
|
#
|
5457
6089
|
# @!attribute [rw] additional_information
|
@@ -6184,11 +6816,43 @@ module Aws::CustomerProfiles
|
|
6184
6816
|
# The unit of time.
|
6185
6817
|
# @return [String]
|
6186
6818
|
#
|
6819
|
+
# @!attribute [rw] value_range
|
6820
|
+
# A structure letting customers specify a relative time window over
|
6821
|
+
# which over which data is included in the Calculated Attribute. Use
|
6822
|
+
# positive numbers to indicate that the endpoint is in the past, and
|
6823
|
+
# negative numbers to indicate it is in the future. ValueRange
|
6824
|
+
# overrides Value.
|
6825
|
+
# @return [Types::ValueRange]
|
6826
|
+
#
|
6827
|
+
# @!attribute [rw] timestamp_source
|
6828
|
+
# An expression specifying the field in your JSON object from which
|
6829
|
+
# the date should be parsed. The expression should follow the
|
6830
|
+
# structure of \\"\{ObjectTypeName.<Location of timestamp field in
|
6831
|
+
# JSON pointer format>}\\". E.g. if your object type is MyType and
|
6832
|
+
# source JSON is \{"generatedAt": \{"timestamp":
|
6833
|
+
# "1737587945945"}}, then TimestampSource should be
|
6834
|
+
# "\{MyType.generatedAt.timestamp}".
|
6835
|
+
# @return [String]
|
6836
|
+
#
|
6837
|
+
# @!attribute [rw] timestamp_format
|
6838
|
+
# The format the timestamp field in your JSON object is specified.
|
6839
|
+
# This value should be one of EPOCHMILLI (for Unix epoch timestamps
|
6840
|
+
# with second/millisecond level precision) or ISO\_8601 (following
|
6841
|
+
# ISO\_8601 format with second/millisecond level precision, with an
|
6842
|
+
# optional offset of Z or in the format HH:MM or HHMM.). E.g. if your
|
6843
|
+
# object type is MyType and source JSON is \{"generatedAt":
|
6844
|
+
# \{"timestamp": "2001-07-04T12:08:56.235-0700"}}, then
|
6845
|
+
# TimestampFormat should be "ISO\_8601".
|
6846
|
+
# @return [String]
|
6847
|
+
#
|
6187
6848
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Range AWS API Documentation
|
6188
6849
|
#
|
6189
6850
|
class Range < Struct.new(
|
6190
6851
|
:value,
|
6191
|
-
:unit
|
6852
|
+
:unit,
|
6853
|
+
:value_range,
|
6854
|
+
:timestamp_source,
|
6855
|
+
:timestamp_format)
|
6192
6856
|
SENSITIVE = []
|
6193
6857
|
include Aws::Structure
|
6194
6858
|
end
|
@@ -6217,6 +6881,27 @@ module Aws::CustomerProfiles
|
|
6217
6881
|
include Aws::Structure
|
6218
6882
|
end
|
6219
6883
|
|
6884
|
+
# Information indicating if the Calculated Attribute is ready for use by
|
6885
|
+
# confirming all historical data has been processed and reflected.
|
6886
|
+
#
|
6887
|
+
# @!attribute [rw] progress_percentage
|
6888
|
+
# Approximately how far the Calculated Attribute creation is from
|
6889
|
+
# completion.
|
6890
|
+
# @return [Integer]
|
6891
|
+
#
|
6892
|
+
# @!attribute [rw] message
|
6893
|
+
# Any customer messaging.
|
6894
|
+
# @return [String]
|
6895
|
+
#
|
6896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Readiness AWS API Documentation
|
6897
|
+
#
|
6898
|
+
class Readiness < Struct.new(
|
6899
|
+
:progress_percentage,
|
6900
|
+
:message)
|
6901
|
+
SENSITIVE = []
|
6902
|
+
include Aws::Structure
|
6903
|
+
end
|
6904
|
+
|
6220
6905
|
# The requested resource does not exist, or access was denied.
|
6221
6906
|
#
|
6222
6907
|
# @!attribute [rw] message
|
@@ -6230,6 +6915,32 @@ module Aws::CustomerProfiles
|
|
6230
6915
|
include Aws::Structure
|
6231
6916
|
end
|
6232
6917
|
|
6918
|
+
# The summary of results for an upload job, including the number of
|
6919
|
+
# updated, created, and failed records.
|
6920
|
+
#
|
6921
|
+
# @!attribute [rw] updated_records
|
6922
|
+
# The number of records that were updated during the upload job.
|
6923
|
+
# @return [Integer]
|
6924
|
+
#
|
6925
|
+
# @!attribute [rw] created_records
|
6926
|
+
# The number of records that were newly created during the upload job.
|
6927
|
+
# @return [Integer]
|
6928
|
+
#
|
6929
|
+
# @!attribute [rw] failed_records
|
6930
|
+
# The number of records that failed to be processed during the upload
|
6931
|
+
# job.
|
6932
|
+
# @return [Integer]
|
6933
|
+
#
|
6934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ResultsSummary AWS API Documentation
|
6935
|
+
#
|
6936
|
+
class ResultsSummary < Struct.new(
|
6937
|
+
:updated_records,
|
6938
|
+
:created_records,
|
6939
|
+
:failed_records)
|
6940
|
+
SENSITIVE = []
|
6941
|
+
include Aws::Structure
|
6942
|
+
end
|
6943
|
+
|
6233
6944
|
# The request to enable the rule-based matching.
|
6234
6945
|
#
|
6235
6946
|
# @!attribute [rw] enabled
|
@@ -6799,6 +7510,48 @@ module Aws::CustomerProfiles
|
|
6799
7510
|
include Aws::Structure
|
6800
7511
|
end
|
6801
7512
|
|
7513
|
+
# @!attribute [rw] domain_name
|
7514
|
+
# The unique name of the domain containing the upload job to start.
|
7515
|
+
# @return [String]
|
7516
|
+
#
|
7517
|
+
# @!attribute [rw] job_id
|
7518
|
+
# The unique identifier of the upload job to start.
|
7519
|
+
# @return [String]
|
7520
|
+
#
|
7521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StartUploadJobRequest AWS API Documentation
|
7522
|
+
#
|
7523
|
+
class StartUploadJobRequest < Struct.new(
|
7524
|
+
:domain_name,
|
7525
|
+
:job_id)
|
7526
|
+
SENSITIVE = []
|
7527
|
+
include Aws::Structure
|
7528
|
+
end
|
7529
|
+
|
7530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StartUploadJobResponse AWS API Documentation
|
7531
|
+
#
|
7532
|
+
class StartUploadJobResponse < Aws::EmptyStructure; end
|
7533
|
+
|
7534
|
+
# @!attribute [rw] domain_name
|
7535
|
+
# The unique name of the domain containing the upload job to stop.
|
7536
|
+
# @return [String]
|
7537
|
+
#
|
7538
|
+
# @!attribute [rw] job_id
|
7539
|
+
# The unique identifier of the upload job to stop.
|
7540
|
+
# @return [String]
|
7541
|
+
#
|
7542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StopUploadJobRequest AWS API Documentation
|
7543
|
+
#
|
7544
|
+
class StopUploadJobRequest < Struct.new(
|
7545
|
+
:domain_name,
|
7546
|
+
:job_id)
|
7547
|
+
SENSITIVE = []
|
7548
|
+
include Aws::Structure
|
7549
|
+
end
|
7550
|
+
|
7551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StopUploadJobResponse AWS API Documentation
|
7552
|
+
#
|
7553
|
+
class StopUploadJobResponse < Aws::EmptyStructure; end
|
7554
|
+
|
6802
7555
|
# @!attribute [rw] resource_arn
|
6803
7556
|
# The ARN of the resource that you're adding tags to.
|
6804
7557
|
# @return [String]
|
@@ -7080,6 +7833,21 @@ module Aws::CustomerProfiles
|
|
7080
7833
|
# in that expression.
|
7081
7834
|
# @return [Types::AttributeDetails]
|
7082
7835
|
#
|
7836
|
+
# @!attribute [rw] use_historical_data
|
7837
|
+
# Whether historical data ingested before the Calculated Attribute was
|
7838
|
+
# created should be included in calculations.
|
7839
|
+
# @return [Boolean]
|
7840
|
+
#
|
7841
|
+
# @!attribute [rw] status
|
7842
|
+
# Status of the Calculated Attribute creation (whether all historical
|
7843
|
+
# data has been indexed.)
|
7844
|
+
# @return [String]
|
7845
|
+
#
|
7846
|
+
# @!attribute [rw] readiness
|
7847
|
+
# Information indicating if the Calculated Attribute is ready for use
|
7848
|
+
# by confirming all historical data has been processed and reflected.
|
7849
|
+
# @return [Types::Readiness]
|
7850
|
+
#
|
7083
7851
|
# @!attribute [rw] tags
|
7084
7852
|
# The tags used to organize, track, or control access for this
|
7085
7853
|
# resource.
|
@@ -7096,11 +7864,124 @@ module Aws::CustomerProfiles
|
|
7096
7864
|
:statistic,
|
7097
7865
|
:conditions,
|
7098
7866
|
:attribute_details,
|
7867
|
+
:use_historical_data,
|
7868
|
+
:status,
|
7869
|
+
:readiness,
|
7099
7870
|
:tags)
|
7100
7871
|
SENSITIVE = [:description, :statistic, :conditions, :attribute_details]
|
7101
7872
|
include Aws::Structure
|
7102
7873
|
end
|
7103
7874
|
|
7875
|
+
# @!attribute [rw] domain_name
|
7876
|
+
# The unique name of the domain.
|
7877
|
+
# @return [String]
|
7878
|
+
#
|
7879
|
+
# @!attribute [rw] layout_definition_name
|
7880
|
+
# The unique name of the layout.
|
7881
|
+
# @return [String]
|
7882
|
+
#
|
7883
|
+
# @!attribute [rw] description
|
7884
|
+
# The description of the layout
|
7885
|
+
# @return [String]
|
7886
|
+
#
|
7887
|
+
# @!attribute [rw] display_name
|
7888
|
+
# The display name of the layout
|
7889
|
+
# @return [String]
|
7890
|
+
#
|
7891
|
+
# @!attribute [rw] is_default
|
7892
|
+
# If set to true for a layout, this layout will be used by default to
|
7893
|
+
# view data. If set to false, then the layout will not be used by
|
7894
|
+
# default, but it can be used to view data by explicitly selecting it
|
7895
|
+
# in the console.
|
7896
|
+
# @return [Boolean]
|
7897
|
+
#
|
7898
|
+
# @!attribute [rw] layout_type
|
7899
|
+
# The type of layout that can be used to view data under a Customer
|
7900
|
+
# Profiles domain.
|
7901
|
+
# @return [String]
|
7902
|
+
#
|
7903
|
+
# @!attribute [rw] layout
|
7904
|
+
# A customizable layout that can be used to view data under a Customer
|
7905
|
+
# Profiles domain.
|
7906
|
+
# @return [String]
|
7907
|
+
#
|
7908
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateDomainLayoutRequest AWS API Documentation
|
7909
|
+
#
|
7910
|
+
class UpdateDomainLayoutRequest < Struct.new(
|
7911
|
+
:domain_name,
|
7912
|
+
:layout_definition_name,
|
7913
|
+
:description,
|
7914
|
+
:display_name,
|
7915
|
+
:is_default,
|
7916
|
+
:layout_type,
|
7917
|
+
:layout)
|
7918
|
+
SENSITIVE = [:description, :layout]
|
7919
|
+
include Aws::Structure
|
7920
|
+
end
|
7921
|
+
|
7922
|
+
# @!attribute [rw] layout_definition_name
|
7923
|
+
# The unique name of the layout.
|
7924
|
+
# @return [String]
|
7925
|
+
#
|
7926
|
+
# @!attribute [rw] description
|
7927
|
+
# The description of the layout
|
7928
|
+
# @return [String]
|
7929
|
+
#
|
7930
|
+
# @!attribute [rw] display_name
|
7931
|
+
# The display name of the layout
|
7932
|
+
# @return [String]
|
7933
|
+
#
|
7934
|
+
# @!attribute [rw] is_default
|
7935
|
+
# If set to true for a layout, this layout will be used by default to
|
7936
|
+
# view data. If set to false, then the layout will not be used by
|
7937
|
+
# default, but it can be used to view data by explicitly selecting it
|
7938
|
+
# in the console.
|
7939
|
+
# @return [Boolean]
|
7940
|
+
#
|
7941
|
+
# @!attribute [rw] layout_type
|
7942
|
+
# The type of layout that can be used to view data under a Customer
|
7943
|
+
# Profiles domain.
|
7944
|
+
# @return [String]
|
7945
|
+
#
|
7946
|
+
# @!attribute [rw] layout
|
7947
|
+
# A customizable layout that can be used to view data under a Customer
|
7948
|
+
# Profiles domain.
|
7949
|
+
# @return [String]
|
7950
|
+
#
|
7951
|
+
# @!attribute [rw] version
|
7952
|
+
# The version used to create layout.
|
7953
|
+
# @return [String]
|
7954
|
+
#
|
7955
|
+
# @!attribute [rw] created_at
|
7956
|
+
# The timestamp of when the layout was created.
|
7957
|
+
# @return [Time]
|
7958
|
+
#
|
7959
|
+
# @!attribute [rw] last_updated_at
|
7960
|
+
# The timestamp of when the layout was most recently updated.
|
7961
|
+
# @return [Time]
|
7962
|
+
#
|
7963
|
+
# @!attribute [rw] tags
|
7964
|
+
# The tags used to organize, track, or control access for this
|
7965
|
+
# resource.
|
7966
|
+
# @return [Hash<String,String>]
|
7967
|
+
#
|
7968
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateDomainLayoutResponse AWS API Documentation
|
7969
|
+
#
|
7970
|
+
class UpdateDomainLayoutResponse < Struct.new(
|
7971
|
+
:layout_definition_name,
|
7972
|
+
:description,
|
7973
|
+
:display_name,
|
7974
|
+
:is_default,
|
7975
|
+
:layout_type,
|
7976
|
+
:layout,
|
7977
|
+
:version,
|
7978
|
+
:created_at,
|
7979
|
+
:last_updated_at,
|
7980
|
+
:tags)
|
7981
|
+
SENSITIVE = [:description, :layout]
|
7982
|
+
include Aws::Structure
|
7983
|
+
end
|
7984
|
+
|
7104
7985
|
# @!attribute [rw] domain_name
|
7105
7986
|
# The unique name of the domain.
|
7106
7987
|
# @return [String]
|
@@ -7365,7 +8246,7 @@ module Aws::CustomerProfiles
|
|
7365
8246
|
# @return [String]
|
7366
8247
|
#
|
7367
8248
|
# @!attribute [rw] account_number
|
7368
|
-
# An account number that you have
|
8249
|
+
# An account number that you have assigned to the customer.
|
7369
8250
|
# @return [String]
|
7370
8251
|
#
|
7371
8252
|
# @!attribute [rw] party_type
|
@@ -7499,6 +8380,77 @@ module Aws::CustomerProfiles
|
|
7499
8380
|
include Aws::Structure
|
7500
8381
|
end
|
7501
8382
|
|
8383
|
+
# The summary information for an individual upload job.
|
8384
|
+
#
|
8385
|
+
# @!attribute [rw] job_id
|
8386
|
+
# The unique identifier of the upload job.
|
8387
|
+
# @return [String]
|
8388
|
+
#
|
8389
|
+
# @!attribute [rw] display_name
|
8390
|
+
# The name of the upload job.
|
8391
|
+
# @return [String]
|
8392
|
+
#
|
8393
|
+
# @!attribute [rw] status
|
8394
|
+
# The current status of the upload job.
|
8395
|
+
# @return [String]
|
8396
|
+
#
|
8397
|
+
# @!attribute [rw] status_reason
|
8398
|
+
# The reason for the current status of the upload job.
|
8399
|
+
# @return [String]
|
8400
|
+
#
|
8401
|
+
# @!attribute [rw] created_at
|
8402
|
+
# The timestamp when the upload job was created.
|
8403
|
+
# @return [Time]
|
8404
|
+
#
|
8405
|
+
# @!attribute [rw] completed_at
|
8406
|
+
# The timestamp when the upload job was completed.
|
8407
|
+
# @return [Time]
|
8408
|
+
#
|
8409
|
+
# @!attribute [rw] data_expiry
|
8410
|
+
# The expiry duration for the profiles ingested with the upload job.
|
8411
|
+
# @return [Integer]
|
8412
|
+
#
|
8413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UploadJobItem AWS API Documentation
|
8414
|
+
#
|
8415
|
+
class UploadJobItem < Struct.new(
|
8416
|
+
:job_id,
|
8417
|
+
:display_name,
|
8418
|
+
:status,
|
8419
|
+
:status_reason,
|
8420
|
+
:created_at,
|
8421
|
+
:completed_at,
|
8422
|
+
:data_expiry)
|
8423
|
+
SENSITIVE = []
|
8424
|
+
include Aws::Structure
|
8425
|
+
end
|
8426
|
+
|
8427
|
+
# A structure letting customers specify a relative time window over
|
8428
|
+
# which over which data is included in the Calculated Attribute. Use
|
8429
|
+
# positive numbers to indicate that the endpoint is in the past, and
|
8430
|
+
# negative numbers to indicate it is in the future. ValueRange overrides
|
8431
|
+
# Value.
|
8432
|
+
#
|
8433
|
+
# @!attribute [rw] start
|
8434
|
+
# The start time of when to include objects. Use positive numbers to
|
8435
|
+
# indicate that the starting point is in the past, and negative
|
8436
|
+
# numbers to indicate it is in the future.
|
8437
|
+
# @return [Integer]
|
8438
|
+
#
|
8439
|
+
# @!attribute [rw] end
|
8440
|
+
# The end time of when to include objects. Use positive numbers to
|
8441
|
+
# indicate that the starting point is in the past, and negative
|
8442
|
+
# numbers to indicate it is in the future.
|
8443
|
+
# @return [Integer]
|
8444
|
+
#
|
8445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ValueRange AWS API Documentation
|
8446
|
+
#
|
8447
|
+
class ValueRange < Struct.new(
|
8448
|
+
:start,
|
8449
|
+
:end)
|
8450
|
+
SENSITIVE = []
|
8451
|
+
include Aws::Structure
|
8452
|
+
end
|
8453
|
+
|
7502
8454
|
# Structure to hold workflow attributes.
|
7503
8455
|
#
|
7504
8456
|
# @!attribute [rw] appflow_integration
|