aws-sdk-customerprofiles 1.63.0 → 1.65.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 +364 -12
- data/lib/aws-sdk-customerprofiles/client_api.rb +206 -2
- data/lib/aws-sdk-customerprofiles/types.rb +605 -7
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- data/sig/client.rbs +123 -5
- data/sig/types.rbs +138 -1
- metadata +4 -4
@@ -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
|
@@ -1713,6 +1859,35 @@ module Aws::CustomerProfiles
|
|
1713
1859
|
#
|
1714
1860
|
class DeleteCalculatedAttributeDefinitionResponse < Aws::EmptyStructure; end
|
1715
1861
|
|
1862
|
+
# @!attribute [rw] domain_name
|
1863
|
+
# The unique name of the domain.
|
1864
|
+
# @return [String]
|
1865
|
+
#
|
1866
|
+
# @!attribute [rw] layout_definition_name
|
1867
|
+
# The unique name of the layout.
|
1868
|
+
# @return [String]
|
1869
|
+
#
|
1870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainLayoutRequest AWS API Documentation
|
1871
|
+
#
|
1872
|
+
class DeleteDomainLayoutRequest < Struct.new(
|
1873
|
+
:domain_name,
|
1874
|
+
:layout_definition_name)
|
1875
|
+
SENSITIVE = []
|
1876
|
+
include Aws::Structure
|
1877
|
+
end
|
1878
|
+
|
1879
|
+
# @!attribute [rw] message
|
1880
|
+
# A message that indicates the delete request is done.
|
1881
|
+
# @return [String]
|
1882
|
+
#
|
1883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainLayoutResponse AWS API Documentation
|
1884
|
+
#
|
1885
|
+
class DeleteDomainLayoutResponse < Struct.new(
|
1886
|
+
:message)
|
1887
|
+
SENSITIVE = []
|
1888
|
+
include Aws::Structure
|
1889
|
+
end
|
1890
|
+
|
1716
1891
|
# @!attribute [rw] domain_name
|
1717
1892
|
# The unique name of the domain.
|
1718
1893
|
# @return [String]
|
@@ -2755,6 +2930,21 @@ module Aws::CustomerProfiles
|
|
2755
2930
|
# that expression.
|
2756
2931
|
# @return [Types::AttributeDetails]
|
2757
2932
|
#
|
2933
|
+
# @!attribute [rw] use_historical_data
|
2934
|
+
# Whether historical data ingested before the Calculated Attribute was
|
2935
|
+
# created should be included in calculations.
|
2936
|
+
# @return [Boolean]
|
2937
|
+
#
|
2938
|
+
# @!attribute [rw] status
|
2939
|
+
# Status of the Calculated Attribute creation (whether all historical
|
2940
|
+
# data has been indexed).
|
2941
|
+
# @return [String]
|
2942
|
+
#
|
2943
|
+
# @!attribute [rw] readiness
|
2944
|
+
# Information indicating if the Calculated Attribute is ready for use
|
2945
|
+
# by confirming all historical data has been processed and reflected.
|
2946
|
+
# @return [Types::Readiness]
|
2947
|
+
#
|
2758
2948
|
# @!attribute [rw] tags
|
2759
2949
|
# The tags used to organize, track, or control access for this
|
2760
2950
|
# resource.
|
@@ -2772,6 +2962,9 @@ module Aws::CustomerProfiles
|
|
2772
2962
|
:filter,
|
2773
2963
|
:conditions,
|
2774
2964
|
:attribute_details,
|
2965
|
+
:use_historical_data,
|
2966
|
+
:status,
|
2967
|
+
:readiness,
|
2775
2968
|
:tags)
|
2776
2969
|
SENSITIVE = [:description, :statistic, :conditions, :attribute_details]
|
2777
2970
|
include Aws::Structure
|
@@ -2816,17 +3009,103 @@ module Aws::CustomerProfiles
|
|
2816
3009
|
# The value of the calculated attribute.
|
2817
3010
|
# @return [String]
|
2818
3011
|
#
|
3012
|
+
# @!attribute [rw] last_object_timestamp
|
3013
|
+
# The timestamp of the newest object included in the calculated
|
3014
|
+
# attribute calculation.
|
3015
|
+
# @return [Time]
|
3016
|
+
#
|
2819
3017
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeForProfileResponse AWS API Documentation
|
2820
3018
|
#
|
2821
3019
|
class GetCalculatedAttributeForProfileResponse < Struct.new(
|
2822
3020
|
:calculated_attribute_name,
|
2823
3021
|
:display_name,
|
2824
3022
|
:is_data_partial,
|
2825
|
-
:value
|
3023
|
+
:value,
|
3024
|
+
:last_object_timestamp)
|
2826
3025
|
SENSITIVE = []
|
2827
3026
|
include Aws::Structure
|
2828
3027
|
end
|
2829
3028
|
|
3029
|
+
# @!attribute [rw] domain_name
|
3030
|
+
# The unique name of the domain.
|
3031
|
+
# @return [String]
|
3032
|
+
#
|
3033
|
+
# @!attribute [rw] layout_definition_name
|
3034
|
+
# The unique name of the layout.
|
3035
|
+
# @return [String]
|
3036
|
+
#
|
3037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainLayoutRequest AWS API Documentation
|
3038
|
+
#
|
3039
|
+
class GetDomainLayoutRequest < Struct.new(
|
3040
|
+
:domain_name,
|
3041
|
+
:layout_definition_name)
|
3042
|
+
SENSITIVE = []
|
3043
|
+
include Aws::Structure
|
3044
|
+
end
|
3045
|
+
|
3046
|
+
# @!attribute [rw] layout_definition_name
|
3047
|
+
# The unique name of the layout.
|
3048
|
+
# @return [String]
|
3049
|
+
#
|
3050
|
+
# @!attribute [rw] description
|
3051
|
+
# The description of the layout
|
3052
|
+
# @return [String]
|
3053
|
+
#
|
3054
|
+
# @!attribute [rw] display_name
|
3055
|
+
# The display name of the layout
|
3056
|
+
# @return [String]
|
3057
|
+
#
|
3058
|
+
# @!attribute [rw] is_default
|
3059
|
+
# If set to true for a layout, this layout will be used by default to
|
3060
|
+
# view data. If set to false, then the layout will not be used by
|
3061
|
+
# default, but it can be used to view data by explicitly selecting it
|
3062
|
+
# in the console.
|
3063
|
+
# @return [Boolean]
|
3064
|
+
#
|
3065
|
+
# @!attribute [rw] layout_type
|
3066
|
+
# The type of layout that can be used to view data under a Customer
|
3067
|
+
# Profiles domain.
|
3068
|
+
# @return [String]
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] layout
|
3071
|
+
# A customizable layout that can be used to view data under a Customer
|
3072
|
+
# Profiles domain.
|
3073
|
+
# @return [String]
|
3074
|
+
#
|
3075
|
+
# @!attribute [rw] version
|
3076
|
+
# The version used to create layout.
|
3077
|
+
# @return [String]
|
3078
|
+
#
|
3079
|
+
# @!attribute [rw] created_at
|
3080
|
+
# The timestamp of when the layout was created.
|
3081
|
+
# @return [Time]
|
3082
|
+
#
|
3083
|
+
# @!attribute [rw] last_updated_at
|
3084
|
+
# The timestamp of when the layout was most recently updated.
|
3085
|
+
# @return [Time]
|
3086
|
+
#
|
3087
|
+
# @!attribute [rw] tags
|
3088
|
+
# The tags used to organize, track, or control access for this
|
3089
|
+
# resource.
|
3090
|
+
# @return [Hash<String,String>]
|
3091
|
+
#
|
3092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainLayoutResponse AWS API Documentation
|
3093
|
+
#
|
3094
|
+
class GetDomainLayoutResponse < Struct.new(
|
3095
|
+
:layout_definition_name,
|
3096
|
+
:description,
|
3097
|
+
:display_name,
|
3098
|
+
:is_default,
|
3099
|
+
:layout_type,
|
3100
|
+
:layout,
|
3101
|
+
:version,
|
3102
|
+
:created_at,
|
3103
|
+
:last_updated_at,
|
3104
|
+
:tags)
|
3105
|
+
SENSITIVE = [:description, :layout]
|
3106
|
+
include Aws::Structure
|
3107
|
+
end
|
3108
|
+
|
2830
3109
|
# @!attribute [rw] domain_name
|
2831
3110
|
# The unique name of the domain.
|
2832
3111
|
# @return [String]
|
@@ -4095,6 +4374,60 @@ module Aws::CustomerProfiles
|
|
4095
4374
|
include Aws::Structure
|
4096
4375
|
end
|
4097
4376
|
|
4377
|
+
# The layout object that contains LayoutDefinitionName, Description,
|
4378
|
+
# DisplayName, IsDefault, LayoutType, Tags, CreatedAt, LastUpdatedAt
|
4379
|
+
#
|
4380
|
+
# @!attribute [rw] layout_definition_name
|
4381
|
+
# The unique name of the layout.
|
4382
|
+
# @return [String]
|
4383
|
+
#
|
4384
|
+
# @!attribute [rw] description
|
4385
|
+
# The description of the layout
|
4386
|
+
# @return [String]
|
4387
|
+
#
|
4388
|
+
# @!attribute [rw] display_name
|
4389
|
+
# The display name of the layout
|
4390
|
+
# @return [String]
|
4391
|
+
#
|
4392
|
+
# @!attribute [rw] is_default
|
4393
|
+
# If set to true for a layout, this layout will be used by default to
|
4394
|
+
# view data. If set to false, then layout will not be used by default
|
4395
|
+
# but it can be used to view data by explicit selection on UI.
|
4396
|
+
# @return [Boolean]
|
4397
|
+
#
|
4398
|
+
# @!attribute [rw] layout_type
|
4399
|
+
# The type of layout that can be used to view data under customer
|
4400
|
+
# profiles domain.
|
4401
|
+
# @return [String]
|
4402
|
+
#
|
4403
|
+
# @!attribute [rw] tags
|
4404
|
+
# The tags used to organize, track, or control access for this
|
4405
|
+
# resource.
|
4406
|
+
# @return [Hash<String,String>]
|
4407
|
+
#
|
4408
|
+
# @!attribute [rw] created_at
|
4409
|
+
# The timestamp of when the layout was created.
|
4410
|
+
# @return [Time]
|
4411
|
+
#
|
4412
|
+
# @!attribute [rw] last_updated_at
|
4413
|
+
# The timestamp of when the layout was most recently updated.
|
4414
|
+
# @return [Time]
|
4415
|
+
#
|
4416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/LayoutItem AWS API Documentation
|
4417
|
+
#
|
4418
|
+
class LayoutItem < Struct.new(
|
4419
|
+
:layout_definition_name,
|
4420
|
+
:description,
|
4421
|
+
:display_name,
|
4422
|
+
:is_default,
|
4423
|
+
:layout_type,
|
4424
|
+
:tags,
|
4425
|
+
:created_at,
|
4426
|
+
:last_updated_at)
|
4427
|
+
SENSITIVE = [:description]
|
4428
|
+
include Aws::Structure
|
4429
|
+
end
|
4430
|
+
|
4098
4431
|
# @!attribute [rw] uri
|
4099
4432
|
# The URI of the S3 bucket or any other type of data source.
|
4100
4433
|
# @return [String]
|
@@ -4165,6 +4498,16 @@ module Aws::CustomerProfiles
|
|
4165
4498
|
# recently edited.
|
4166
4499
|
# @return [Time]
|
4167
4500
|
#
|
4501
|
+
# @!attribute [rw] use_historical_data
|
4502
|
+
# Whether historical data ingested before the Calculated Attribute was
|
4503
|
+
# created should be included in calculations.
|
4504
|
+
# @return [Boolean]
|
4505
|
+
#
|
4506
|
+
# @!attribute [rw] status
|
4507
|
+
# Status of the Calculated Attribute creation (whether all historical
|
4508
|
+
# data has been indexed.)
|
4509
|
+
# @return [String]
|
4510
|
+
#
|
4168
4511
|
# @!attribute [rw] tags
|
4169
4512
|
# The tags used to organize, track, or control access for this
|
4170
4513
|
# resource.
|
@@ -4178,6 +4521,8 @@ module Aws::CustomerProfiles
|
|
4178
4521
|
:description,
|
4179
4522
|
:created_at,
|
4180
4523
|
:last_updated_at,
|
4524
|
+
:use_historical_data,
|
4525
|
+
:status,
|
4181
4526
|
:tags)
|
4182
4527
|
SENSITIVE = [:description]
|
4183
4528
|
include Aws::Structure
|
@@ -4244,13 +4589,19 @@ module Aws::CustomerProfiles
|
|
4244
4589
|
# The value of the calculated attribute.
|
4245
4590
|
# @return [String]
|
4246
4591
|
#
|
4592
|
+
# @!attribute [rw] last_object_timestamp
|
4593
|
+
# The timestamp of the newest object included in the calculated
|
4594
|
+
# attribute calculation.
|
4595
|
+
# @return [Time]
|
4596
|
+
#
|
4247
4597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeForProfileItem AWS API Documentation
|
4248
4598
|
#
|
4249
4599
|
class ListCalculatedAttributeForProfileItem < Struct.new(
|
4250
4600
|
:calculated_attribute_name,
|
4251
4601
|
:display_name,
|
4252
4602
|
:is_data_partial,
|
4253
|
-
:value
|
4603
|
+
:value,
|
4604
|
+
:last_object_timestamp)
|
4254
4605
|
SENSITIVE = []
|
4255
4606
|
include Aws::Structure
|
4256
4607
|
end
|
@@ -4331,6 +4682,45 @@ module Aws::CustomerProfiles
|
|
4331
4682
|
include Aws::Structure
|
4332
4683
|
end
|
4333
4684
|
|
4685
|
+
# @!attribute [rw] domain_name
|
4686
|
+
# The unique name of the domain.
|
4687
|
+
# @return [String]
|
4688
|
+
#
|
4689
|
+
# @!attribute [rw] next_token
|
4690
|
+
# Identifies the next page of results to return.
|
4691
|
+
# @return [String]
|
4692
|
+
#
|
4693
|
+
# @!attribute [rw] max_results
|
4694
|
+
# The maximum number of objects returned per page.
|
4695
|
+
# @return [Integer]
|
4696
|
+
#
|
4697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainLayoutsRequest AWS API Documentation
|
4698
|
+
#
|
4699
|
+
class ListDomainLayoutsRequest < Struct.new(
|
4700
|
+
:domain_name,
|
4701
|
+
:next_token,
|
4702
|
+
:max_results)
|
4703
|
+
SENSITIVE = []
|
4704
|
+
include Aws::Structure
|
4705
|
+
end
|
4706
|
+
|
4707
|
+
# @!attribute [rw] items
|
4708
|
+
# Contains summary information about an EventStream.
|
4709
|
+
# @return [Array<Types::LayoutItem>]
|
4710
|
+
#
|
4711
|
+
# @!attribute [rw] next_token
|
4712
|
+
# Identifies the next page of results to return.
|
4713
|
+
# @return [String]
|
4714
|
+
#
|
4715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainLayoutsResponse AWS API Documentation
|
4716
|
+
#
|
4717
|
+
class ListDomainLayoutsResponse < Struct.new(
|
4718
|
+
:items,
|
4719
|
+
:next_token)
|
4720
|
+
SENSITIVE = []
|
4721
|
+
include Aws::Structure
|
4722
|
+
end
|
4723
|
+
|
4334
4724
|
# @!attribute [rw] next_token
|
4335
4725
|
# The pagination token from the previous ListDomain API call.
|
4336
4726
|
# @return [String]
|
@@ -5451,7 +5841,7 @@ module Aws::CustomerProfiles
|
|
5451
5841
|
# @return [String]
|
5452
5842
|
#
|
5453
5843
|
# @!attribute [rw] account_number
|
5454
|
-
# An account number that you have
|
5844
|
+
# An account number that you have assigned to the customer.
|
5455
5845
|
# @return [String]
|
5456
5846
|
#
|
5457
5847
|
# @!attribute [rw] additional_information
|
@@ -6184,11 +6574,43 @@ module Aws::CustomerProfiles
|
|
6184
6574
|
# The unit of time.
|
6185
6575
|
# @return [String]
|
6186
6576
|
#
|
6577
|
+
# @!attribute [rw] value_range
|
6578
|
+
# A structure letting customers specify a relative time window over
|
6579
|
+
# which over which data is included in the Calculated Attribute. Use
|
6580
|
+
# positive numbers to indicate that the endpoint is in the past, and
|
6581
|
+
# negative numbers to indicate it is in the future. ValueRange
|
6582
|
+
# overrides Value.
|
6583
|
+
# @return [Types::ValueRange]
|
6584
|
+
#
|
6585
|
+
# @!attribute [rw] timestamp_source
|
6586
|
+
# An expression specifying the field in your JSON object from which
|
6587
|
+
# the date should be parsed. The expression should follow the
|
6588
|
+
# structure of \\"\{ObjectTypeName.<Location of timestamp field in
|
6589
|
+
# JSON pointer format>}\\". E.g. if your object type is MyType and
|
6590
|
+
# source JSON is \{"generatedAt": \{"timestamp":
|
6591
|
+
# "1737587945945"}}, then TimestampSource should be
|
6592
|
+
# "\{MyType.generatedAt.timestamp}".
|
6593
|
+
# @return [String]
|
6594
|
+
#
|
6595
|
+
# @!attribute [rw] timestamp_format
|
6596
|
+
# The format the timestamp field in your JSON object is specified.
|
6597
|
+
# This value should be one of EPOCHMILLI (for Unix epoch timestamps
|
6598
|
+
# with second/millisecond level precision) or ISO\_8601 (following
|
6599
|
+
# ISO\_8601 format with second/millisecond level precision, with an
|
6600
|
+
# optional offset of Z or in the format HH:MM or HHMM.). E.g. if your
|
6601
|
+
# object type is MyType and source JSON is \{"generatedAt":
|
6602
|
+
# \{"timestamp": "2001-07-04T12:08:56.235-0700"}}, then
|
6603
|
+
# TimestampFormat should be "ISO\_8601".
|
6604
|
+
# @return [String]
|
6605
|
+
#
|
6187
6606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Range AWS API Documentation
|
6188
6607
|
#
|
6189
6608
|
class Range < Struct.new(
|
6190
6609
|
:value,
|
6191
|
-
:unit
|
6610
|
+
:unit,
|
6611
|
+
:value_range,
|
6612
|
+
:timestamp_source,
|
6613
|
+
:timestamp_format)
|
6192
6614
|
SENSITIVE = []
|
6193
6615
|
include Aws::Structure
|
6194
6616
|
end
|
@@ -6217,6 +6639,27 @@ module Aws::CustomerProfiles
|
|
6217
6639
|
include Aws::Structure
|
6218
6640
|
end
|
6219
6641
|
|
6642
|
+
# Information indicating if the Calculated Attribute is ready for use by
|
6643
|
+
# confirming all historical data has been processed and reflected.
|
6644
|
+
#
|
6645
|
+
# @!attribute [rw] progress_percentage
|
6646
|
+
# Approximately how far the Calculated Attribute creation is from
|
6647
|
+
# completion.
|
6648
|
+
# @return [Integer]
|
6649
|
+
#
|
6650
|
+
# @!attribute [rw] message
|
6651
|
+
# Any customer messaging.
|
6652
|
+
# @return [String]
|
6653
|
+
#
|
6654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Readiness AWS API Documentation
|
6655
|
+
#
|
6656
|
+
class Readiness < Struct.new(
|
6657
|
+
:progress_percentage,
|
6658
|
+
:message)
|
6659
|
+
SENSITIVE = []
|
6660
|
+
include Aws::Structure
|
6661
|
+
end
|
6662
|
+
|
6220
6663
|
# The requested resource does not exist, or access was denied.
|
6221
6664
|
#
|
6222
6665
|
# @!attribute [rw] message
|
@@ -7080,6 +7523,21 @@ module Aws::CustomerProfiles
|
|
7080
7523
|
# in that expression.
|
7081
7524
|
# @return [Types::AttributeDetails]
|
7082
7525
|
#
|
7526
|
+
# @!attribute [rw] use_historical_data
|
7527
|
+
# Whether historical data ingested before the Calculated Attribute was
|
7528
|
+
# created should be included in calculations.
|
7529
|
+
# @return [Boolean]
|
7530
|
+
#
|
7531
|
+
# @!attribute [rw] status
|
7532
|
+
# Status of the Calculated Attribute creation (whether all historical
|
7533
|
+
# data has been indexed.)
|
7534
|
+
# @return [String]
|
7535
|
+
#
|
7536
|
+
# @!attribute [rw] readiness
|
7537
|
+
# Information indicating if the Calculated Attribute is ready for use
|
7538
|
+
# by confirming all historical data has been processed and reflected.
|
7539
|
+
# @return [Types::Readiness]
|
7540
|
+
#
|
7083
7541
|
# @!attribute [rw] tags
|
7084
7542
|
# The tags used to organize, track, or control access for this
|
7085
7543
|
# resource.
|
@@ -7096,11 +7554,124 @@ module Aws::CustomerProfiles
|
|
7096
7554
|
:statistic,
|
7097
7555
|
:conditions,
|
7098
7556
|
:attribute_details,
|
7557
|
+
:use_historical_data,
|
7558
|
+
:status,
|
7559
|
+
:readiness,
|
7099
7560
|
:tags)
|
7100
7561
|
SENSITIVE = [:description, :statistic, :conditions, :attribute_details]
|
7101
7562
|
include Aws::Structure
|
7102
7563
|
end
|
7103
7564
|
|
7565
|
+
# @!attribute [rw] domain_name
|
7566
|
+
# The unique name of the domain.
|
7567
|
+
# @return [String]
|
7568
|
+
#
|
7569
|
+
# @!attribute [rw] layout_definition_name
|
7570
|
+
# The unique name of the layout.
|
7571
|
+
# @return [String]
|
7572
|
+
#
|
7573
|
+
# @!attribute [rw] description
|
7574
|
+
# The description of the layout
|
7575
|
+
# @return [String]
|
7576
|
+
#
|
7577
|
+
# @!attribute [rw] display_name
|
7578
|
+
# The display name of the layout
|
7579
|
+
# @return [String]
|
7580
|
+
#
|
7581
|
+
# @!attribute [rw] is_default
|
7582
|
+
# If set to true for a layout, this layout will be used by default to
|
7583
|
+
# view data. If set to false, then the layout will not be used by
|
7584
|
+
# default, but it can be used to view data by explicitly selecting it
|
7585
|
+
# in the console.
|
7586
|
+
# @return [Boolean]
|
7587
|
+
#
|
7588
|
+
# @!attribute [rw] layout_type
|
7589
|
+
# The type of layout that can be used to view data under a Customer
|
7590
|
+
# Profiles domain.
|
7591
|
+
# @return [String]
|
7592
|
+
#
|
7593
|
+
# @!attribute [rw] layout
|
7594
|
+
# A customizable layout that can be used to view data under a Customer
|
7595
|
+
# Profiles domain.
|
7596
|
+
# @return [String]
|
7597
|
+
#
|
7598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateDomainLayoutRequest AWS API Documentation
|
7599
|
+
#
|
7600
|
+
class UpdateDomainLayoutRequest < Struct.new(
|
7601
|
+
:domain_name,
|
7602
|
+
:layout_definition_name,
|
7603
|
+
:description,
|
7604
|
+
:display_name,
|
7605
|
+
:is_default,
|
7606
|
+
:layout_type,
|
7607
|
+
:layout)
|
7608
|
+
SENSITIVE = [:description, :layout]
|
7609
|
+
include Aws::Structure
|
7610
|
+
end
|
7611
|
+
|
7612
|
+
# @!attribute [rw] layout_definition_name
|
7613
|
+
# The unique name of the layout.
|
7614
|
+
# @return [String]
|
7615
|
+
#
|
7616
|
+
# @!attribute [rw] description
|
7617
|
+
# The description of the layout
|
7618
|
+
# @return [String]
|
7619
|
+
#
|
7620
|
+
# @!attribute [rw] display_name
|
7621
|
+
# The display name of the layout
|
7622
|
+
# @return [String]
|
7623
|
+
#
|
7624
|
+
# @!attribute [rw] is_default
|
7625
|
+
# If set to true for a layout, this layout will be used by default to
|
7626
|
+
# view data. If set to false, then the layout will not be used by
|
7627
|
+
# default, but it can be used to view data by explicitly selecting it
|
7628
|
+
# in the console.
|
7629
|
+
# @return [Boolean]
|
7630
|
+
#
|
7631
|
+
# @!attribute [rw] layout_type
|
7632
|
+
# The type of layout that can be used to view data under a Customer
|
7633
|
+
# Profiles domain.
|
7634
|
+
# @return [String]
|
7635
|
+
#
|
7636
|
+
# @!attribute [rw] layout
|
7637
|
+
# A customizable layout that can be used to view data under a Customer
|
7638
|
+
# Profiles domain.
|
7639
|
+
# @return [String]
|
7640
|
+
#
|
7641
|
+
# @!attribute [rw] version
|
7642
|
+
# The version used to create layout.
|
7643
|
+
# @return [String]
|
7644
|
+
#
|
7645
|
+
# @!attribute [rw] created_at
|
7646
|
+
# The timestamp of when the layout was created.
|
7647
|
+
# @return [Time]
|
7648
|
+
#
|
7649
|
+
# @!attribute [rw] last_updated_at
|
7650
|
+
# The timestamp of when the layout was most recently updated.
|
7651
|
+
# @return [Time]
|
7652
|
+
#
|
7653
|
+
# @!attribute [rw] tags
|
7654
|
+
# The tags used to organize, track, or control access for this
|
7655
|
+
# resource.
|
7656
|
+
# @return [Hash<String,String>]
|
7657
|
+
#
|
7658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateDomainLayoutResponse AWS API Documentation
|
7659
|
+
#
|
7660
|
+
class UpdateDomainLayoutResponse < Struct.new(
|
7661
|
+
:layout_definition_name,
|
7662
|
+
:description,
|
7663
|
+
:display_name,
|
7664
|
+
:is_default,
|
7665
|
+
:layout_type,
|
7666
|
+
:layout,
|
7667
|
+
:version,
|
7668
|
+
:created_at,
|
7669
|
+
:last_updated_at,
|
7670
|
+
:tags)
|
7671
|
+
SENSITIVE = [:description, :layout]
|
7672
|
+
include Aws::Structure
|
7673
|
+
end
|
7674
|
+
|
7104
7675
|
# @!attribute [rw] domain_name
|
7105
7676
|
# The unique name of the domain.
|
7106
7677
|
# @return [String]
|
@@ -7365,7 +7936,7 @@ module Aws::CustomerProfiles
|
|
7365
7936
|
# @return [String]
|
7366
7937
|
#
|
7367
7938
|
# @!attribute [rw] account_number
|
7368
|
-
# An account number that you have
|
7939
|
+
# An account number that you have assigned to the customer.
|
7369
7940
|
# @return [String]
|
7370
7941
|
#
|
7371
7942
|
# @!attribute [rw] party_type
|
@@ -7499,6 +8070,33 @@ module Aws::CustomerProfiles
|
|
7499
8070
|
include Aws::Structure
|
7500
8071
|
end
|
7501
8072
|
|
8073
|
+
# A structure letting customers specify a relative time window over
|
8074
|
+
# which over which data is included in the Calculated Attribute. Use
|
8075
|
+
# positive numbers to indicate that the endpoint is in the past, and
|
8076
|
+
# negative numbers to indicate it is in the future. ValueRange overrides
|
8077
|
+
# Value.
|
8078
|
+
#
|
8079
|
+
# @!attribute [rw] start
|
8080
|
+
# The start time of when to include objects. Use positive numbers to
|
8081
|
+
# indicate that the starting point is in the past, and negative
|
8082
|
+
# numbers to indicate it is in the future.
|
8083
|
+
# @return [Integer]
|
8084
|
+
#
|
8085
|
+
# @!attribute [rw] end
|
8086
|
+
# The end time of when to include objects. Use positive numbers to
|
8087
|
+
# indicate that the starting point is in the past, and negative
|
8088
|
+
# numbers to indicate it is in the future.
|
8089
|
+
# @return [Integer]
|
8090
|
+
#
|
8091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ValueRange AWS API Documentation
|
8092
|
+
#
|
8093
|
+
class ValueRange < Struct.new(
|
8094
|
+
:start,
|
8095
|
+
:end)
|
8096
|
+
SENSITIVE = []
|
8097
|
+
include Aws::Structure
|
8098
|
+
end
|
8099
|
+
|
7502
8100
|
# Structure to hold workflow attributes.
|
7503
8101
|
#
|
7504
8102
|
# @!attribute [rw] appflow_integration
|