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
@@ -571,6 +571,7 @@ module Aws::CustomerProfiles
|
|
571
571
|
# resp.calculated_attribute_values[0].is_data_partial #=> String
|
572
572
|
# resp.calculated_attribute_values[0].profile_id #=> String
|
573
573
|
# resp.calculated_attribute_values[0].value #=> String
|
574
|
+
# resp.calculated_attribute_values[0].last_object_timestamp #=> Time
|
574
575
|
# resp.condition_overrides.range.start #=> Integer
|
575
576
|
# resp.condition_overrides.range.end #=> Integer
|
576
577
|
# resp.condition_overrides.range.unit #=> String, one of "DAYS"
|
@@ -725,6 +726,10 @@ module Aws::CustomerProfiles
|
|
725
726
|
# @option params [required, String] :statistic
|
726
727
|
# The aggregation operation to perform for the calculated attribute.
|
727
728
|
#
|
729
|
+
# @option params [Boolean] :use_historical_data
|
730
|
+
# Whether historical data ingested before the Calculated Attribute was
|
731
|
+
# created should be included in calculations.
|
732
|
+
#
|
728
733
|
# @option params [Hash<String,String>] :tags
|
729
734
|
# The tags used to organize, track, or control access for this resource.
|
730
735
|
#
|
@@ -739,6 +744,9 @@ module Aws::CustomerProfiles
|
|
739
744
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
740
745
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
741
746
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
747
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#use_historical_data #use_historical_data} => Boolean
|
748
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#status #status} => String
|
749
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#readiness #readiness} => Types::Readiness
|
742
750
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
743
751
|
#
|
744
752
|
# @example Request syntax with placeholder values
|
@@ -758,8 +766,14 @@ module Aws::CustomerProfiles
|
|
758
766
|
# },
|
759
767
|
# conditions: {
|
760
768
|
# range: {
|
761
|
-
# value: 1,
|
762
|
-
# unit: "DAYS", #
|
769
|
+
# value: 1,
|
770
|
+
# unit: "DAYS", # accepts DAYS
|
771
|
+
# value_range: {
|
772
|
+
# start: 1, # required
|
773
|
+
# end: 1, # required
|
774
|
+
# },
|
775
|
+
# timestamp_source: "string1To255",
|
776
|
+
# timestamp_format: "string1To255",
|
763
777
|
# },
|
764
778
|
# object_count: 1,
|
765
779
|
# threshold: {
|
@@ -786,6 +800,7 @@ module Aws::CustomerProfiles
|
|
786
800
|
# ],
|
787
801
|
# },
|
788
802
|
# statistic: "FIRST_OCCURRENCE", # required, accepts FIRST_OCCURRENCE, LAST_OCCURRENCE, COUNT, SUM, MINIMUM, MAXIMUM, AVERAGE, MAX_OCCURRENCE
|
803
|
+
# use_historical_data: false,
|
789
804
|
# tags: {
|
790
805
|
# "TagKey" => "TagValue",
|
791
806
|
# },
|
@@ -801,6 +816,10 @@ module Aws::CustomerProfiles
|
|
801
816
|
# resp.attribute_details.expression #=> String
|
802
817
|
# resp.conditions.range.value #=> Integer
|
803
818
|
# resp.conditions.range.unit #=> String, one of "DAYS"
|
819
|
+
# resp.conditions.range.value_range.start #=> Integer
|
820
|
+
# resp.conditions.range.value_range.end #=> Integer
|
821
|
+
# resp.conditions.range.timestamp_source #=> String
|
822
|
+
# resp.conditions.range.timestamp_format #=> String
|
804
823
|
# resp.conditions.object_count #=> Integer
|
805
824
|
# resp.conditions.threshold.value #=> String
|
806
825
|
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
@@ -815,6 +834,10 @@ module Aws::CustomerProfiles
|
|
815
834
|
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
816
835
|
# resp.created_at #=> Time
|
817
836
|
# resp.last_updated_at #=> Time
|
837
|
+
# resp.use_historical_data #=> Boolean
|
838
|
+
# resp.status #=> String, one of "PREPARING", "IN_PROGRESS", "COMPLETED", "FAILED"
|
839
|
+
# resp.readiness.progress_percentage #=> Integer
|
840
|
+
# resp.readiness.message #=> String
|
818
841
|
# resp.tags #=> Hash
|
819
842
|
# resp.tags["TagKey"] #=> String
|
820
843
|
#
|
@@ -1032,6 +1055,89 @@ module Aws::CustomerProfiles
|
|
1032
1055
|
req.send_request(options)
|
1033
1056
|
end
|
1034
1057
|
|
1058
|
+
# Creates the layout to view data for a specific domain. This API can
|
1059
|
+
# only be invoked from the Amazon Connect admin website.
|
1060
|
+
#
|
1061
|
+
# @option params [required, String] :domain_name
|
1062
|
+
# The unique name of the domain.
|
1063
|
+
#
|
1064
|
+
# @option params [required, String] :layout_definition_name
|
1065
|
+
# The unique name of the layout.
|
1066
|
+
#
|
1067
|
+
# @option params [required, String] :description
|
1068
|
+
# The description of the layout
|
1069
|
+
#
|
1070
|
+
# @option params [required, String] :display_name
|
1071
|
+
# The display name of the layout
|
1072
|
+
#
|
1073
|
+
# @option params [Boolean] :is_default
|
1074
|
+
# If set to true for a layout, this layout will be used by default to
|
1075
|
+
# view data. If set to false, then the layout will not be used by
|
1076
|
+
# default, but it can be used to view data by explicitly selecting it in
|
1077
|
+
# the console.
|
1078
|
+
#
|
1079
|
+
# @option params [required, String] :layout_type
|
1080
|
+
# The type of layout that can be used to view data under a Customer
|
1081
|
+
# Profiles domain.
|
1082
|
+
#
|
1083
|
+
# @option params [required, String] :layout
|
1084
|
+
# A customizable layout that can be used to view data under a Customer
|
1085
|
+
# Profiles domain.
|
1086
|
+
#
|
1087
|
+
# @option params [Hash<String,String>] :tags
|
1088
|
+
# The tags used to organize, track, or control access for this resource.
|
1089
|
+
#
|
1090
|
+
# @return [Types::CreateDomainLayoutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1091
|
+
#
|
1092
|
+
# * {Types::CreateDomainLayoutResponse#layout_definition_name #layout_definition_name} => String
|
1093
|
+
# * {Types::CreateDomainLayoutResponse#description #description} => String
|
1094
|
+
# * {Types::CreateDomainLayoutResponse#display_name #display_name} => String
|
1095
|
+
# * {Types::CreateDomainLayoutResponse#is_default #is_default} => Boolean
|
1096
|
+
# * {Types::CreateDomainLayoutResponse#layout_type #layout_type} => String
|
1097
|
+
# * {Types::CreateDomainLayoutResponse#layout #layout} => String
|
1098
|
+
# * {Types::CreateDomainLayoutResponse#version #version} => String
|
1099
|
+
# * {Types::CreateDomainLayoutResponse#tags #tags} => Hash<String,String>
|
1100
|
+
# * {Types::CreateDomainLayoutResponse#created_at #created_at} => Time
|
1101
|
+
# * {Types::CreateDomainLayoutResponse#last_updated_at #last_updated_at} => Time
|
1102
|
+
#
|
1103
|
+
# @example Request syntax with placeholder values
|
1104
|
+
#
|
1105
|
+
# resp = client.create_domain_layout({
|
1106
|
+
# domain_name: "name", # required
|
1107
|
+
# layout_definition_name: "name", # required
|
1108
|
+
# description: "sensitiveText", # required
|
1109
|
+
# display_name: "displayName", # required
|
1110
|
+
# is_default: false,
|
1111
|
+
# layout_type: "PROFILE_EXPLORER", # required, accepts PROFILE_EXPLORER
|
1112
|
+
# layout: "sensitiveString1To2000000", # required
|
1113
|
+
# tags: {
|
1114
|
+
# "TagKey" => "TagValue",
|
1115
|
+
# },
|
1116
|
+
# })
|
1117
|
+
#
|
1118
|
+
# @example Response structure
|
1119
|
+
#
|
1120
|
+
# resp.layout_definition_name #=> String
|
1121
|
+
# resp.description #=> String
|
1122
|
+
# resp.display_name #=> String
|
1123
|
+
# resp.is_default #=> Boolean
|
1124
|
+
# resp.layout_type #=> String, one of "PROFILE_EXPLORER"
|
1125
|
+
# resp.layout #=> String
|
1126
|
+
# resp.version #=> String
|
1127
|
+
# resp.tags #=> Hash
|
1128
|
+
# resp.tags["TagKey"] #=> String
|
1129
|
+
# resp.created_at #=> Time
|
1130
|
+
# resp.last_updated_at #=> Time
|
1131
|
+
#
|
1132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateDomainLayout AWS API Documentation
|
1133
|
+
#
|
1134
|
+
# @overload create_domain_layout(params = {})
|
1135
|
+
# @param [Hash] params ({})
|
1136
|
+
def create_domain_layout(params = {}, options = {})
|
1137
|
+
req = build_request(:create_domain_layout, params)
|
1138
|
+
req.send_request(options)
|
1139
|
+
end
|
1140
|
+
|
1035
1141
|
# Creates an event stream, which is a subscription to real-time events,
|
1036
1142
|
# such as when profiles are created and updated through Amazon Connect
|
1037
1143
|
# Customer Profiles.
|
@@ -1345,7 +1451,7 @@ module Aws::CustomerProfiles
|
|
1345
1451
|
# The unique name of the domain.
|
1346
1452
|
#
|
1347
1453
|
# @option params [String] :account_number
|
1348
|
-
# An account number that you have
|
1454
|
+
# An account number that you have assigned to the customer.
|
1349
1455
|
#
|
1350
1456
|
# @option params [String] :additional_information
|
1351
1457
|
# Any additional information relevant to the customer’s profile.
|
@@ -2071,6 +2177,62 @@ module Aws::CustomerProfiles
|
|
2071
2177
|
req.send_request(options)
|
2072
2178
|
end
|
2073
2179
|
|
2180
|
+
# Creates an Upload job to ingest data for segment imports. The metadata
|
2181
|
+
# is created for the job with the provided field mapping and unique key.
|
2182
|
+
#
|
2183
|
+
# @option params [required, String] :domain_name
|
2184
|
+
# The unique name of the domain. Domain should be exists for the upload
|
2185
|
+
# job to be created.
|
2186
|
+
#
|
2187
|
+
# @option params [required, String] :display_name
|
2188
|
+
# The unique name of the upload job. Could be a file name to identify
|
2189
|
+
# the upload job.
|
2190
|
+
#
|
2191
|
+
# @option params [required, Hash<String,Types::ObjectTypeField>] :fields
|
2192
|
+
# The mapping between CSV Columns and Profile Object attributes. A map
|
2193
|
+
# of the name and ObjectType field.
|
2194
|
+
#
|
2195
|
+
# @option params [required, String] :unique_key
|
2196
|
+
# The unique key columns for de-duping the profiles used to map data to
|
2197
|
+
# the profile.
|
2198
|
+
#
|
2199
|
+
# @option params [Integer] :data_expiry
|
2200
|
+
# The expiry duration for the profiles ingested with the job. If not
|
2201
|
+
# provided, the system default of 2 weeks is used.
|
2202
|
+
#
|
2203
|
+
# @return [Types::CreateUploadJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2204
|
+
#
|
2205
|
+
# * {Types::CreateUploadJobResponse#job_id #job_id} => String
|
2206
|
+
#
|
2207
|
+
# @example Request syntax with placeholder values
|
2208
|
+
#
|
2209
|
+
# resp = client.create_upload_job({
|
2210
|
+
# domain_name: "name", # required
|
2211
|
+
# display_name: "string1To255", # required
|
2212
|
+
# fields: { # required
|
2213
|
+
# "fieldName" => {
|
2214
|
+
# source: "text",
|
2215
|
+
# target: "text",
|
2216
|
+
# content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
|
2217
|
+
# },
|
2218
|
+
# },
|
2219
|
+
# unique_key: "text", # required
|
2220
|
+
# data_expiry: 1,
|
2221
|
+
# })
|
2222
|
+
#
|
2223
|
+
# @example Response structure
|
2224
|
+
#
|
2225
|
+
# resp.job_id #=> String
|
2226
|
+
#
|
2227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateUploadJob AWS API Documentation
|
2228
|
+
#
|
2229
|
+
# @overload create_upload_job(params = {})
|
2230
|
+
# @param [Hash] params ({})
|
2231
|
+
def create_upload_job(params = {}, options = {})
|
2232
|
+
req = build_request(:create_upload_job, params)
|
2233
|
+
req.send_request(options)
|
2234
|
+
end
|
2235
|
+
|
2074
2236
|
# Deletes an existing calculated attribute definition. Note that
|
2075
2237
|
# deleting a default calculated attribute is possible, however once
|
2076
2238
|
# deleted, you will be unable to undo that action and will need to
|
@@ -2130,6 +2292,39 @@ module Aws::CustomerProfiles
|
|
2130
2292
|
req.send_request(options)
|
2131
2293
|
end
|
2132
2294
|
|
2295
|
+
# Deletes the layout used to view data for a specific domain. This API
|
2296
|
+
# can only be invoked from the Amazon Connect admin website.
|
2297
|
+
#
|
2298
|
+
# @option params [required, String] :domain_name
|
2299
|
+
# The unique name of the domain.
|
2300
|
+
#
|
2301
|
+
# @option params [required, String] :layout_definition_name
|
2302
|
+
# The unique name of the layout.
|
2303
|
+
#
|
2304
|
+
# @return [Types::DeleteDomainLayoutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2305
|
+
#
|
2306
|
+
# * {Types::DeleteDomainLayoutResponse#message #message} => String
|
2307
|
+
#
|
2308
|
+
# @example Request syntax with placeholder values
|
2309
|
+
#
|
2310
|
+
# resp = client.delete_domain_layout({
|
2311
|
+
# domain_name: "name", # required
|
2312
|
+
# layout_definition_name: "name", # required
|
2313
|
+
# })
|
2314
|
+
#
|
2315
|
+
# @example Response structure
|
2316
|
+
#
|
2317
|
+
# resp.message #=> String
|
2318
|
+
#
|
2319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteDomainLayout AWS API Documentation
|
2320
|
+
#
|
2321
|
+
# @overload delete_domain_layout(params = {})
|
2322
|
+
# @param [Hash] params ({})
|
2323
|
+
def delete_domain_layout(params = {}, options = {})
|
2324
|
+
req = build_request(:delete_domain_layout, params)
|
2325
|
+
req.send_request(options)
|
2326
|
+
end
|
2327
|
+
|
2133
2328
|
# Disables and deletes the specified event stream.
|
2134
2329
|
#
|
2135
2330
|
# @option params [required, String] :domain_name
|
@@ -2459,13 +2654,13 @@ module Aws::CustomerProfiles
|
|
2459
2654
|
# resp.detected_profile_object_types #=> Array
|
2460
2655
|
# resp.detected_profile_object_types[0].source_last_updated_timestamp_format #=> String
|
2461
2656
|
# resp.detected_profile_object_types[0].fields #=> Hash
|
2462
|
-
# resp.detected_profile_object_types[0].fields["
|
2463
|
-
# resp.detected_profile_object_types[0].fields["
|
2464
|
-
# resp.detected_profile_object_types[0].fields["
|
2657
|
+
# resp.detected_profile_object_types[0].fields["fieldName"].source #=> String
|
2658
|
+
# resp.detected_profile_object_types[0].fields["fieldName"].target #=> String
|
2659
|
+
# resp.detected_profile_object_types[0].fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
|
2465
2660
|
# resp.detected_profile_object_types[0].keys #=> Hash
|
2466
2661
|
# resp.detected_profile_object_types[0].keys["name"] #=> Array
|
2467
2662
|
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers #=> Array
|
2468
|
-
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
2663
|
+
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
2469
2664
|
# resp.detected_profile_object_types[0].keys["name"][0].field_names #=> Array
|
2470
2665
|
# resp.detected_profile_object_types[0].keys["name"][0].field_names[0] #=> String
|
2471
2666
|
#
|
@@ -2568,6 +2763,9 @@ module Aws::CustomerProfiles
|
|
2568
2763
|
# * {Types::GetCalculatedAttributeDefinitionResponse#filter #data.filter} => Types::Filter (This method conflicts with a method on Response, call it through the data member)
|
2569
2764
|
# * {Types::GetCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
2570
2765
|
# * {Types::GetCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
2766
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#use_historical_data #use_historical_data} => Boolean
|
2767
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#status #status} => String
|
2768
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#readiness #readiness} => Types::Readiness
|
2571
2769
|
# * {Types::GetCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
2572
2770
|
#
|
2573
2771
|
# @example Request syntax with placeholder values
|
@@ -2595,12 +2793,20 @@ module Aws::CustomerProfiles
|
|
2595
2793
|
# resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values[0] #=> String
|
2596
2794
|
# resp.conditions.range.value #=> Integer
|
2597
2795
|
# resp.conditions.range.unit #=> String, one of "DAYS"
|
2796
|
+
# resp.conditions.range.value_range.start #=> Integer
|
2797
|
+
# resp.conditions.range.value_range.end #=> Integer
|
2798
|
+
# resp.conditions.range.timestamp_source #=> String
|
2799
|
+
# resp.conditions.range.timestamp_format #=> String
|
2598
2800
|
# resp.conditions.object_count #=> Integer
|
2599
2801
|
# resp.conditions.threshold.value #=> String
|
2600
2802
|
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
2601
2803
|
# resp.attribute_details.attributes #=> Array
|
2602
2804
|
# resp.attribute_details.attributes[0].name #=> String
|
2603
2805
|
# resp.attribute_details.expression #=> String
|
2806
|
+
# resp.use_historical_data #=> Boolean
|
2807
|
+
# resp.status #=> String, one of "PREPARING", "IN_PROGRESS", "COMPLETED", "FAILED"
|
2808
|
+
# resp.readiness.progress_percentage #=> Integer
|
2809
|
+
# resp.readiness.message #=> String
|
2604
2810
|
# resp.tags #=> Hash
|
2605
2811
|
# resp.tags["TagKey"] #=> String
|
2606
2812
|
#
|
@@ -2630,6 +2836,7 @@ module Aws::CustomerProfiles
|
|
2630
2836
|
# * {Types::GetCalculatedAttributeForProfileResponse#display_name #display_name} => String
|
2631
2837
|
# * {Types::GetCalculatedAttributeForProfileResponse#is_data_partial #is_data_partial} => String
|
2632
2838
|
# * {Types::GetCalculatedAttributeForProfileResponse#value #value} => String
|
2839
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#last_object_timestamp #last_object_timestamp} => Time
|
2633
2840
|
#
|
2634
2841
|
# @example Request syntax with placeholder values
|
2635
2842
|
#
|
@@ -2645,6 +2852,7 @@ module Aws::CustomerProfiles
|
|
2645
2852
|
# resp.display_name #=> String
|
2646
2853
|
# resp.is_data_partial #=> String
|
2647
2854
|
# resp.value #=> String
|
2855
|
+
# resp.last_object_timestamp #=> Time
|
2648
2856
|
#
|
2649
2857
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile AWS API Documentation
|
2650
2858
|
#
|
@@ -2733,6 +2941,58 @@ module Aws::CustomerProfiles
|
|
2733
2941
|
req.send_request(options)
|
2734
2942
|
end
|
2735
2943
|
|
2944
|
+
# Gets the layout to view data for a specific domain. This API can only
|
2945
|
+
# be invoked from the Amazon Connect admin website.
|
2946
|
+
#
|
2947
|
+
# @option params [required, String] :domain_name
|
2948
|
+
# The unique name of the domain.
|
2949
|
+
#
|
2950
|
+
# @option params [required, String] :layout_definition_name
|
2951
|
+
# The unique name of the layout.
|
2952
|
+
#
|
2953
|
+
# @return [Types::GetDomainLayoutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2954
|
+
#
|
2955
|
+
# * {Types::GetDomainLayoutResponse#layout_definition_name #layout_definition_name} => String
|
2956
|
+
# * {Types::GetDomainLayoutResponse#description #description} => String
|
2957
|
+
# * {Types::GetDomainLayoutResponse#display_name #display_name} => String
|
2958
|
+
# * {Types::GetDomainLayoutResponse#is_default #is_default} => Boolean
|
2959
|
+
# * {Types::GetDomainLayoutResponse#layout_type #layout_type} => String
|
2960
|
+
# * {Types::GetDomainLayoutResponse#layout #layout} => String
|
2961
|
+
# * {Types::GetDomainLayoutResponse#version #version} => String
|
2962
|
+
# * {Types::GetDomainLayoutResponse#created_at #created_at} => Time
|
2963
|
+
# * {Types::GetDomainLayoutResponse#last_updated_at #last_updated_at} => Time
|
2964
|
+
# * {Types::GetDomainLayoutResponse#tags #tags} => Hash<String,String>
|
2965
|
+
#
|
2966
|
+
# @example Request syntax with placeholder values
|
2967
|
+
#
|
2968
|
+
# resp = client.get_domain_layout({
|
2969
|
+
# domain_name: "name", # required
|
2970
|
+
# layout_definition_name: "name", # required
|
2971
|
+
# })
|
2972
|
+
#
|
2973
|
+
# @example Response structure
|
2974
|
+
#
|
2975
|
+
# resp.layout_definition_name #=> String
|
2976
|
+
# resp.description #=> String
|
2977
|
+
# resp.display_name #=> String
|
2978
|
+
# resp.is_default #=> Boolean
|
2979
|
+
# resp.layout_type #=> String, one of "PROFILE_EXPLORER"
|
2980
|
+
# resp.layout #=> String
|
2981
|
+
# resp.version #=> String
|
2982
|
+
# resp.created_at #=> Time
|
2983
|
+
# resp.last_updated_at #=> Time
|
2984
|
+
# resp.tags #=> Hash
|
2985
|
+
# resp.tags["TagKey"] #=> String
|
2986
|
+
#
|
2987
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainLayout AWS API Documentation
|
2988
|
+
#
|
2989
|
+
# @overload get_domain_layout(params = {})
|
2990
|
+
# @param [Hash] params ({})
|
2991
|
+
def get_domain_layout(params = {}, options = {})
|
2992
|
+
req = build_request(:get_domain_layout, params)
|
2993
|
+
req.send_request(options)
|
2994
|
+
end
|
2995
|
+
|
2736
2996
|
# Returns information about the specified event stream in a specific
|
2737
2997
|
# domain.
|
2738
2998
|
#
|
@@ -3108,13 +3368,13 @@ module Aws::CustomerProfiles
|
|
3108
3368
|
# resp.max_available_profile_object_count #=> Integer
|
3109
3369
|
# resp.max_profile_object_count #=> Integer
|
3110
3370
|
# resp.fields #=> Hash
|
3111
|
-
# resp.fields["
|
3112
|
-
# resp.fields["
|
3113
|
-
# resp.fields["
|
3371
|
+
# resp.fields["fieldName"].source #=> String
|
3372
|
+
# resp.fields["fieldName"].target #=> String
|
3373
|
+
# resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
|
3114
3374
|
# resp.keys #=> Hash
|
3115
3375
|
# resp.keys["name"] #=> Array
|
3116
3376
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
3117
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
3377
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
3118
3378
|
# resp.keys["name"][0].field_names #=> Array
|
3119
3379
|
# resp.keys["name"][0].field_names[0] #=> String
|
3120
3380
|
# resp.created_at #=> Time
|
@@ -3166,13 +3426,13 @@ module Aws::CustomerProfiles
|
|
3166
3426
|
# resp.allow_profile_creation #=> Boolean
|
3167
3427
|
# resp.source_last_updated_timestamp_format #=> String
|
3168
3428
|
# resp.fields #=> Hash
|
3169
|
-
# resp.fields["
|
3170
|
-
# resp.fields["
|
3171
|
-
# resp.fields["
|
3429
|
+
# resp.fields["fieldName"].source #=> String
|
3430
|
+
# resp.fields["fieldName"].target #=> String
|
3431
|
+
# resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
|
3172
3432
|
# resp.keys #=> Hash
|
3173
3433
|
# resp.keys["name"] #=> Array
|
3174
3434
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
3175
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
3435
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
3176
3436
|
# resp.keys["name"][0].field_names #=> Array
|
3177
3437
|
# resp.keys["name"][0].field_names[0] #=> String
|
3178
3438
|
#
|
@@ -3632,6 +3892,99 @@ module Aws::CustomerProfiles
|
|
3632
3892
|
req.send_request(options)
|
3633
3893
|
end
|
3634
3894
|
|
3895
|
+
# This API retrieves the details of a specific upload job.
|
3896
|
+
#
|
3897
|
+
# @option params [required, String] :domain_name
|
3898
|
+
# The unique name of the domain containing the upload job.
|
3899
|
+
#
|
3900
|
+
# @option params [required, String] :job_id
|
3901
|
+
# The unique identifier of the upload job to retrieve.
|
3902
|
+
#
|
3903
|
+
# @return [Types::GetUploadJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3904
|
+
#
|
3905
|
+
# * {Types::GetUploadJobResponse#job_id #job_id} => String
|
3906
|
+
# * {Types::GetUploadJobResponse#display_name #display_name} => String
|
3907
|
+
# * {Types::GetUploadJobResponse#status #status} => String
|
3908
|
+
# * {Types::GetUploadJobResponse#status_reason #status_reason} => String
|
3909
|
+
# * {Types::GetUploadJobResponse#created_at #created_at} => Time
|
3910
|
+
# * {Types::GetUploadJobResponse#completed_at #completed_at} => Time
|
3911
|
+
# * {Types::GetUploadJobResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
3912
|
+
# * {Types::GetUploadJobResponse#unique_key #unique_key} => String
|
3913
|
+
# * {Types::GetUploadJobResponse#results_summary #results_summary} => Types::ResultsSummary
|
3914
|
+
# * {Types::GetUploadJobResponse#data_expiry #data_expiry} => Integer
|
3915
|
+
#
|
3916
|
+
# @example Request syntax with placeholder values
|
3917
|
+
#
|
3918
|
+
# resp = client.get_upload_job({
|
3919
|
+
# domain_name: "name", # required
|
3920
|
+
# job_id: "uuid", # required
|
3921
|
+
# })
|
3922
|
+
#
|
3923
|
+
# @example Response structure
|
3924
|
+
#
|
3925
|
+
# resp.job_id #=> String
|
3926
|
+
# resp.display_name #=> String
|
3927
|
+
# resp.status #=> String, one of "CREATED", "IN_PROGRESS", "PARTIALLY_SUCCEEDED", "SUCCEEDED", "FAILED", "STOPPED"
|
3928
|
+
# resp.status_reason #=> String, one of "VALIDATION_FAILURE", "INTERNAL_FAILURE"
|
3929
|
+
# resp.created_at #=> Time
|
3930
|
+
# resp.completed_at #=> Time
|
3931
|
+
# resp.fields #=> Hash
|
3932
|
+
# resp.fields["fieldName"].source #=> String
|
3933
|
+
# resp.fields["fieldName"].target #=> String
|
3934
|
+
# resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
|
3935
|
+
# resp.unique_key #=> String
|
3936
|
+
# resp.results_summary.updated_records #=> Integer
|
3937
|
+
# resp.results_summary.created_records #=> Integer
|
3938
|
+
# resp.results_summary.failed_records #=> Integer
|
3939
|
+
# resp.data_expiry #=> Integer
|
3940
|
+
#
|
3941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetUploadJob AWS API Documentation
|
3942
|
+
#
|
3943
|
+
# @overload get_upload_job(params = {})
|
3944
|
+
# @param [Hash] params ({})
|
3945
|
+
def get_upload_job(params = {}, options = {})
|
3946
|
+
req = build_request(:get_upload_job, params)
|
3947
|
+
req.send_request(options)
|
3948
|
+
end
|
3949
|
+
|
3950
|
+
# This API retrieves the pre-signed URL and client token for uploading
|
3951
|
+
# the file associated with the upload job.
|
3952
|
+
#
|
3953
|
+
# @option params [required, String] :domain_name
|
3954
|
+
# The unique name of the domain containing the upload job.
|
3955
|
+
#
|
3956
|
+
# @option params [required, String] :job_id
|
3957
|
+
# The unique identifier of the upload job to retrieve the upload path
|
3958
|
+
# for. This is generated from the CreateUploadJob API.
|
3959
|
+
#
|
3960
|
+
# @return [Types::GetUploadJobPathResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3961
|
+
#
|
3962
|
+
# * {Types::GetUploadJobPathResponse#url #url} => String
|
3963
|
+
# * {Types::GetUploadJobPathResponse#client_token #client_token} => String
|
3964
|
+
# * {Types::GetUploadJobPathResponse#valid_until #valid_until} => Time
|
3965
|
+
#
|
3966
|
+
# @example Request syntax with placeholder values
|
3967
|
+
#
|
3968
|
+
# resp = client.get_upload_job_path({
|
3969
|
+
# domain_name: "name", # required
|
3970
|
+
# job_id: "name", # required
|
3971
|
+
# })
|
3972
|
+
#
|
3973
|
+
# @example Response structure
|
3974
|
+
#
|
3975
|
+
# resp.url #=> String
|
3976
|
+
# resp.client_token #=> String
|
3977
|
+
# resp.valid_until #=> Time
|
3978
|
+
#
|
3979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetUploadJobPath AWS API Documentation
|
3980
|
+
#
|
3981
|
+
# @overload get_upload_job_path(params = {})
|
3982
|
+
# @param [Hash] params ({})
|
3983
|
+
def get_upload_job_path(params = {}, options = {})
|
3984
|
+
req = build_request(:get_upload_job_path, params)
|
3985
|
+
req.send_request(options)
|
3986
|
+
end
|
3987
|
+
|
3635
3988
|
# Get details of specified workflow.
|
3636
3989
|
#
|
3637
3990
|
# @option params [required, String] :domain_name
|
@@ -3831,6 +4184,8 @@ module Aws::CustomerProfiles
|
|
3831
4184
|
# resp.items[0].description #=> String
|
3832
4185
|
# resp.items[0].created_at #=> Time
|
3833
4186
|
# resp.items[0].last_updated_at #=> Time
|
4187
|
+
# resp.items[0].use_historical_data #=> Boolean
|
4188
|
+
# resp.items[0].status #=> String, one of "PREPARING", "IN_PROGRESS", "COMPLETED", "FAILED"
|
3834
4189
|
# resp.items[0].tags #=> Hash
|
3835
4190
|
# resp.items[0].tags["TagKey"] #=> String
|
3836
4191
|
# resp.next_token #=> String
|
@@ -3880,6 +4235,7 @@ module Aws::CustomerProfiles
|
|
3880
4235
|
# resp.items[0].display_name #=> String
|
3881
4236
|
# resp.items[0].is_data_partial #=> String
|
3882
4237
|
# resp.items[0].value #=> String
|
4238
|
+
# resp.items[0].last_object_timestamp #=> Time
|
3883
4239
|
# resp.next_token #=> String
|
3884
4240
|
#
|
3885
4241
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile AWS API Documentation
|
@@ -3891,6 +4247,57 @@ module Aws::CustomerProfiles
|
|
3891
4247
|
req.send_request(options)
|
3892
4248
|
end
|
3893
4249
|
|
4250
|
+
# Lists the existing layouts that can be used to view data for a
|
4251
|
+
# specific domain. This API can only be invoked from the Amazon Connect
|
4252
|
+
# admin website.
|
4253
|
+
#
|
4254
|
+
# @option params [required, String] :domain_name
|
4255
|
+
# The unique name of the domain.
|
4256
|
+
#
|
4257
|
+
# @option params [String] :next_token
|
4258
|
+
# Identifies the next page of results to return.
|
4259
|
+
#
|
4260
|
+
# @option params [Integer] :max_results
|
4261
|
+
# The maximum number of objects returned per page.
|
4262
|
+
#
|
4263
|
+
# @return [Types::ListDomainLayoutsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4264
|
+
#
|
4265
|
+
# * {Types::ListDomainLayoutsResponse#items #items} => Array<Types::LayoutItem>
|
4266
|
+
# * {Types::ListDomainLayoutsResponse#next_token #next_token} => String
|
4267
|
+
#
|
4268
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4269
|
+
#
|
4270
|
+
# @example Request syntax with placeholder values
|
4271
|
+
#
|
4272
|
+
# resp = client.list_domain_layouts({
|
4273
|
+
# domain_name: "name", # required
|
4274
|
+
# next_token: "token",
|
4275
|
+
# max_results: 1,
|
4276
|
+
# })
|
4277
|
+
#
|
4278
|
+
# @example Response structure
|
4279
|
+
#
|
4280
|
+
# resp.items #=> Array
|
4281
|
+
# resp.items[0].layout_definition_name #=> String
|
4282
|
+
# resp.items[0].description #=> String
|
4283
|
+
# resp.items[0].display_name #=> String
|
4284
|
+
# resp.items[0].is_default #=> Boolean
|
4285
|
+
# resp.items[0].layout_type #=> String, one of "PROFILE_EXPLORER"
|
4286
|
+
# resp.items[0].tags #=> Hash
|
4287
|
+
# resp.items[0].tags["TagKey"] #=> String
|
4288
|
+
# resp.items[0].created_at #=> Time
|
4289
|
+
# resp.items[0].last_updated_at #=> Time
|
4290
|
+
# resp.next_token #=> String
|
4291
|
+
#
|
4292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListDomainLayouts AWS API Documentation
|
4293
|
+
#
|
4294
|
+
# @overload list_domain_layouts(params = {})
|
4295
|
+
# @param [Hash] params ({})
|
4296
|
+
def list_domain_layouts(params = {}, options = {})
|
4297
|
+
req = build_request(:list_domain_layouts, params)
|
4298
|
+
req.send_request(options)
|
4299
|
+
end
|
4300
|
+
|
3894
4301
|
# Returns a list of all the domains for an AWS account that have been
|
3895
4302
|
# created.
|
3896
4303
|
#
|
@@ -4484,6 +4891,54 @@ module Aws::CustomerProfiles
|
|
4484
4891
|
req.send_request(options)
|
4485
4892
|
end
|
4486
4893
|
|
4894
|
+
# This API retrieves a list of upload jobs for the specified domain.
|
4895
|
+
#
|
4896
|
+
# @option params [required, String] :domain_name
|
4897
|
+
# The unique name of the domain to list upload jobs for.
|
4898
|
+
#
|
4899
|
+
# @option params [Integer] :max_results
|
4900
|
+
# The maximum number of upload jobs to return per page.
|
4901
|
+
#
|
4902
|
+
# @option params [String] :next_token
|
4903
|
+
# The pagination token from the previous call to retrieve the next page
|
4904
|
+
# of results.
|
4905
|
+
#
|
4906
|
+
# @return [Types::ListUploadJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4907
|
+
#
|
4908
|
+
# * {Types::ListUploadJobsResponse#next_token #next_token} => String
|
4909
|
+
# * {Types::ListUploadJobsResponse#items #items} => Array<Types::UploadJobItem>
|
4910
|
+
#
|
4911
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4912
|
+
#
|
4913
|
+
# @example Request syntax with placeholder values
|
4914
|
+
#
|
4915
|
+
# resp = client.list_upload_jobs({
|
4916
|
+
# domain_name: "name", # required
|
4917
|
+
# max_results: 1,
|
4918
|
+
# next_token: "token",
|
4919
|
+
# })
|
4920
|
+
#
|
4921
|
+
# @example Response structure
|
4922
|
+
#
|
4923
|
+
# resp.next_token #=> String
|
4924
|
+
# resp.items #=> Array
|
4925
|
+
# resp.items[0].job_id #=> String
|
4926
|
+
# resp.items[0].display_name #=> String
|
4927
|
+
# resp.items[0].status #=> String, one of "CREATED", "IN_PROGRESS", "PARTIALLY_SUCCEEDED", "SUCCEEDED", "FAILED", "STOPPED"
|
4928
|
+
# resp.items[0].status_reason #=> String, one of "VALIDATION_FAILURE", "INTERNAL_FAILURE"
|
4929
|
+
# resp.items[0].created_at #=> Time
|
4930
|
+
# resp.items[0].completed_at #=> Time
|
4931
|
+
# resp.items[0].data_expiry #=> Integer
|
4932
|
+
#
|
4933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListUploadJobs AWS API Documentation
|
4934
|
+
#
|
4935
|
+
# @overload list_upload_jobs(params = {})
|
4936
|
+
# @param [Hash] params ({})
|
4937
|
+
def list_upload_jobs(params = {}, options = {})
|
4938
|
+
req = build_request(:list_upload_jobs, params)
|
4939
|
+
req.send_request(options)
|
4940
|
+
end
|
4941
|
+
|
4487
4942
|
# Query to list all workflows.
|
4488
4943
|
#
|
4489
4944
|
# @option params [required, String] :domain_name
|
@@ -4951,7 +5406,7 @@ module Aws::CustomerProfiles
|
|
4951
5406
|
# source_last_updated_timestamp_format: "string1To255",
|
4952
5407
|
# max_profile_object_count: 1,
|
4953
5408
|
# fields: {
|
4954
|
-
# "
|
5409
|
+
# "fieldName" => {
|
4955
5410
|
# source: "text",
|
4956
5411
|
# target: "text",
|
4957
5412
|
# content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
|
@@ -4960,7 +5415,7 @@ module Aws::CustomerProfiles
|
|
4960
5415
|
# keys: {
|
4961
5416
|
# "name" => [
|
4962
5417
|
# {
|
4963
|
-
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, ORDER, COMMUNICATION_RECORD, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
5418
|
+
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, ORDER, COMMUNICATION_RECORD, AIR_PREFERENCE, HOTEL_PREFERENCE, AIR_BOOKING, AIR_SEGMENT, HOTEL_RESERVATION, HOTEL_STAY_REVENUE, LOYALTY, LOYALTY_TRANSACTION, LOYALTY_PROMOTION, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
4964
5419
|
# field_names: ["name"],
|
4965
5420
|
# },
|
4966
5421
|
# ],
|
@@ -4982,13 +5437,13 @@ module Aws::CustomerProfiles
|
|
4982
5437
|
# resp.max_profile_object_count #=> Integer
|
4983
5438
|
# resp.max_available_profile_object_count #=> Integer
|
4984
5439
|
# resp.fields #=> Hash
|
4985
|
-
# resp.fields["
|
4986
|
-
# resp.fields["
|
4987
|
-
# resp.fields["
|
5440
|
+
# resp.fields["fieldName"].source #=> String
|
5441
|
+
# resp.fields["fieldName"].target #=> String
|
5442
|
+
# resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
|
4988
5443
|
# resp.keys #=> Hash
|
4989
5444
|
# resp.keys["name"] #=> Array
|
4990
5445
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
4991
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
5446
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
4992
5447
|
# resp.keys["name"][0].field_names #=> Array
|
4993
5448
|
# resp.keys["name"][0].field_names[0] #=> String
|
4994
5449
|
# resp.created_at #=> Time
|
@@ -5165,6 +5620,59 @@ module Aws::CustomerProfiles
|
|
5165
5620
|
req.send_request(options)
|
5166
5621
|
end
|
5167
5622
|
|
5623
|
+
# This API starts the processing of an upload job to ingest profile
|
5624
|
+
# data.
|
5625
|
+
#
|
5626
|
+
# @option params [required, String] :domain_name
|
5627
|
+
# The unique name of the domain containing the upload job to start.
|
5628
|
+
#
|
5629
|
+
# @option params [required, String] :job_id
|
5630
|
+
# The unique identifier of the upload job to start.
|
5631
|
+
#
|
5632
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5633
|
+
#
|
5634
|
+
# @example Request syntax with placeholder values
|
5635
|
+
#
|
5636
|
+
# resp = client.start_upload_job({
|
5637
|
+
# domain_name: "name", # required
|
5638
|
+
# job_id: "name", # required
|
5639
|
+
# })
|
5640
|
+
#
|
5641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StartUploadJob AWS API Documentation
|
5642
|
+
#
|
5643
|
+
# @overload start_upload_job(params = {})
|
5644
|
+
# @param [Hash] params ({})
|
5645
|
+
def start_upload_job(params = {}, options = {})
|
5646
|
+
req = build_request(:start_upload_job, params)
|
5647
|
+
req.send_request(options)
|
5648
|
+
end
|
5649
|
+
|
5650
|
+
# This API stops the processing of an upload job.
|
5651
|
+
#
|
5652
|
+
# @option params [required, String] :domain_name
|
5653
|
+
# The unique name of the domain containing the upload job to stop.
|
5654
|
+
#
|
5655
|
+
# @option params [required, String] :job_id
|
5656
|
+
# The unique identifier of the upload job to stop.
|
5657
|
+
#
|
5658
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5659
|
+
#
|
5660
|
+
# @example Request syntax with placeholder values
|
5661
|
+
#
|
5662
|
+
# resp = client.stop_upload_job({
|
5663
|
+
# domain_name: "name", # required
|
5664
|
+
# job_id: "name", # required
|
5665
|
+
# })
|
5666
|
+
#
|
5667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/StopUploadJob AWS API Documentation
|
5668
|
+
#
|
5669
|
+
# @overload stop_upload_job(params = {})
|
5670
|
+
# @param [Hash] params ({})
|
5671
|
+
def stop_upload_job(params = {}, options = {})
|
5672
|
+
req = build_request(:stop_upload_job, params)
|
5673
|
+
req.send_request(options)
|
5674
|
+
end
|
5675
|
+
|
5168
5676
|
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
5169
5677
|
# Connect Customer Profiles resource. Tags can help you organize and
|
5170
5678
|
# categorize your resources. You can also use them to scope user
|
@@ -5268,6 +5776,9 @@ module Aws::CustomerProfiles
|
|
5268
5776
|
# * {Types::UpdateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
5269
5777
|
# * {Types::UpdateCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
5270
5778
|
# * {Types::UpdateCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
5779
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#use_historical_data #use_historical_data} => Boolean
|
5780
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#status #status} => String
|
5781
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#readiness #readiness} => Types::Readiness
|
5271
5782
|
# * {Types::UpdateCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
5272
5783
|
#
|
5273
5784
|
# @example Request syntax with placeholder values
|
@@ -5279,8 +5790,14 @@ module Aws::CustomerProfiles
|
|
5279
5790
|
# description: "sensitiveText",
|
5280
5791
|
# conditions: {
|
5281
5792
|
# range: {
|
5282
|
-
# value: 1,
|
5283
|
-
# unit: "DAYS", #
|
5793
|
+
# value: 1,
|
5794
|
+
# unit: "DAYS", # accepts DAYS
|
5795
|
+
# value_range: {
|
5796
|
+
# start: 1, # required
|
5797
|
+
# end: 1, # required
|
5798
|
+
# },
|
5799
|
+
# timestamp_source: "string1To255",
|
5800
|
+
# timestamp_format: "string1To255",
|
5284
5801
|
# },
|
5285
5802
|
# object_count: 1,
|
5286
5803
|
# threshold: {
|
@@ -5300,12 +5817,20 @@ module Aws::CustomerProfiles
|
|
5300
5817
|
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
5301
5818
|
# resp.conditions.range.value #=> Integer
|
5302
5819
|
# resp.conditions.range.unit #=> String, one of "DAYS"
|
5820
|
+
# resp.conditions.range.value_range.start #=> Integer
|
5821
|
+
# resp.conditions.range.value_range.end #=> Integer
|
5822
|
+
# resp.conditions.range.timestamp_source #=> String
|
5823
|
+
# resp.conditions.range.timestamp_format #=> String
|
5303
5824
|
# resp.conditions.object_count #=> Integer
|
5304
5825
|
# resp.conditions.threshold.value #=> String
|
5305
5826
|
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
5306
5827
|
# resp.attribute_details.attributes #=> Array
|
5307
5828
|
# resp.attribute_details.attributes[0].name #=> String
|
5308
5829
|
# resp.attribute_details.expression #=> String
|
5830
|
+
# resp.use_historical_data #=> Boolean
|
5831
|
+
# resp.status #=> String, one of "PREPARING", "IN_PROGRESS", "COMPLETED", "FAILED"
|
5832
|
+
# resp.readiness.progress_percentage #=> Integer
|
5833
|
+
# resp.readiness.message #=> String
|
5309
5834
|
# resp.tags #=> Hash
|
5310
5835
|
# resp.tags["TagKey"] #=> String
|
5311
5836
|
#
|
@@ -5515,6 +6040,83 @@ module Aws::CustomerProfiles
|
|
5515
6040
|
req.send_request(options)
|
5516
6041
|
end
|
5517
6042
|
|
6043
|
+
# Updates the layout used to view data for a specific domain. This API
|
6044
|
+
# can only be invoked from the Amazon Connect admin website.
|
6045
|
+
#
|
6046
|
+
# @option params [required, String] :domain_name
|
6047
|
+
# The unique name of the domain.
|
6048
|
+
#
|
6049
|
+
# @option params [required, String] :layout_definition_name
|
6050
|
+
# The unique name of the layout.
|
6051
|
+
#
|
6052
|
+
# @option params [String] :description
|
6053
|
+
# The description of the layout
|
6054
|
+
#
|
6055
|
+
# @option params [String] :display_name
|
6056
|
+
# The display name of the layout
|
6057
|
+
#
|
6058
|
+
# @option params [Boolean] :is_default
|
6059
|
+
# If set to true for a layout, this layout will be used by default to
|
6060
|
+
# view data. If set to false, then the layout will not be used by
|
6061
|
+
# default, but it can be used to view data by explicitly selecting it in
|
6062
|
+
# the console.
|
6063
|
+
#
|
6064
|
+
# @option params [String] :layout_type
|
6065
|
+
# The type of layout that can be used to view data under a Customer
|
6066
|
+
# Profiles domain.
|
6067
|
+
#
|
6068
|
+
# @option params [String] :layout
|
6069
|
+
# A customizable layout that can be used to view data under a Customer
|
6070
|
+
# Profiles domain.
|
6071
|
+
#
|
6072
|
+
# @return [Types::UpdateDomainLayoutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6073
|
+
#
|
6074
|
+
# * {Types::UpdateDomainLayoutResponse#layout_definition_name #layout_definition_name} => String
|
6075
|
+
# * {Types::UpdateDomainLayoutResponse#description #description} => String
|
6076
|
+
# * {Types::UpdateDomainLayoutResponse#display_name #display_name} => String
|
6077
|
+
# * {Types::UpdateDomainLayoutResponse#is_default #is_default} => Boolean
|
6078
|
+
# * {Types::UpdateDomainLayoutResponse#layout_type #layout_type} => String
|
6079
|
+
# * {Types::UpdateDomainLayoutResponse#layout #layout} => String
|
6080
|
+
# * {Types::UpdateDomainLayoutResponse#version #version} => String
|
6081
|
+
# * {Types::UpdateDomainLayoutResponse#created_at #created_at} => Time
|
6082
|
+
# * {Types::UpdateDomainLayoutResponse#last_updated_at #last_updated_at} => Time
|
6083
|
+
# * {Types::UpdateDomainLayoutResponse#tags #tags} => Hash<String,String>
|
6084
|
+
#
|
6085
|
+
# @example Request syntax with placeholder values
|
6086
|
+
#
|
6087
|
+
# resp = client.update_domain_layout({
|
6088
|
+
# domain_name: "name", # required
|
6089
|
+
# layout_definition_name: "name", # required
|
6090
|
+
# description: "sensitiveText",
|
6091
|
+
# display_name: "displayName",
|
6092
|
+
# is_default: false,
|
6093
|
+
# layout_type: "PROFILE_EXPLORER", # accepts PROFILE_EXPLORER
|
6094
|
+
# layout: "sensitiveString1To2000000",
|
6095
|
+
# })
|
6096
|
+
#
|
6097
|
+
# @example Response structure
|
6098
|
+
#
|
6099
|
+
# resp.layout_definition_name #=> String
|
6100
|
+
# resp.description #=> String
|
6101
|
+
# resp.display_name #=> String
|
6102
|
+
# resp.is_default #=> Boolean
|
6103
|
+
# resp.layout_type #=> String, one of "PROFILE_EXPLORER"
|
6104
|
+
# resp.layout #=> String
|
6105
|
+
# resp.version #=> String
|
6106
|
+
# resp.created_at #=> Time
|
6107
|
+
# resp.last_updated_at #=> Time
|
6108
|
+
# resp.tags #=> Hash
|
6109
|
+
# resp.tags["TagKey"] #=> String
|
6110
|
+
#
|
6111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateDomainLayout AWS API Documentation
|
6112
|
+
#
|
6113
|
+
# @overload update_domain_layout(params = {})
|
6114
|
+
# @param [Hash] params ({})
|
6115
|
+
def update_domain_layout(params = {}, options = {})
|
6116
|
+
req = build_request(:update_domain_layout, params)
|
6117
|
+
req.send_request(options)
|
6118
|
+
end
|
6119
|
+
|
5518
6120
|
# Update the properties of an Event Trigger.
|
5519
6121
|
#
|
5520
6122
|
# @option params [required, String] :domain_name
|
@@ -5644,7 +6246,7 @@ module Aws::CustomerProfiles
|
|
5644
6246
|
# Any additional information relevant to the customer’s profile.
|
5645
6247
|
#
|
5646
6248
|
# @option params [String] :account_number
|
5647
|
-
# An account number that you have
|
6249
|
+
# An account number that you have assigned to the customer.
|
5648
6250
|
#
|
5649
6251
|
# @option params [String] :party_type
|
5650
6252
|
# The type of profile used to describe the customer.
|
@@ -5823,7 +6425,7 @@ module Aws::CustomerProfiles
|
|
5823
6425
|
tracer: tracer
|
5824
6426
|
)
|
5825
6427
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
5826
|
-
context[:gem_version] = '1.
|
6428
|
+
context[:gem_version] = '1.66.0'
|
5827
6429
|
Seahorse::Client::Request.new(handlers, context)
|
5828
6430
|
end
|
5829
6431
|
|