aws-sdk-customerprofiles 1.11.0 → 1.15.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +326 -15
- data/lib/aws-sdk-customerprofiles/client_api.rb +165 -0
- data/lib/aws-sdk-customerprofiles/types.rb +754 -23
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e52203962823925c7d040a65b9b2e0f7bd93b11d9ae0abe1d91425e2b7594b61
|
4
|
+
data.tar.gz: cc84b0b81a2260a2bbbacbe4a979bd669d3e990a1bcf33217619d2be8eef4102
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bffa339efaa288571ed4e131f370467b6b6e0f71b01b2af2b856b2bf25a38b67c8a5bc31b9d886aa48f220ec6824eb155a3139934da1d95c90aa60fc1752c56d
|
7
|
+
data.tar.gz: e86af968d37f4aee4c03e423f179bf43386aefbb317de6f1d3cf162ee7f360be996859cde95f33a70c0d49b4aec6f56738a51fd30473711f7c9186882b1ab939
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.15.0 (2021-11-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.14.0 (2021-11-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release introduces a new auto-merging feature for profile matching. The auto-merging configurations can be set via CreateDomain API or UpdateDomain API. You can use GetIdentityResolutionJob API and ListIdentityResolutionJobs API to fetch job status.
|
13
|
+
|
14
|
+
1.13.0 (2021-11-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.12.0 (2021-10-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.11.0 (2021-09-01)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.15.0
|
@@ -119,7 +119,9 @@ module Aws::CustomerProfiles
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -275,6 +277,15 @@ module Aws::CustomerProfiles
|
|
275
277
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
278
|
# requests are made, and retries are disabled.
|
277
279
|
#
|
280
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
281
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
|
+
# will be used if available.
|
283
|
+
#
|
284
|
+
# @option options [Boolean] :use_fips_endpoint
|
285
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
286
|
+
# When a `fips` region is used, the region is normalized and this config
|
287
|
+
# is set to `true`.
|
288
|
+
#
|
278
289
|
# @option options [Boolean] :validate_params (true)
|
279
290
|
# When `true`, request parameters are validated before
|
280
291
|
# sending the request.
|
@@ -386,10 +397,15 @@ module Aws::CustomerProfiles
|
|
386
397
|
# Use this API or [UpdateDomain][1] to enable [identity resolution][2]\:
|
387
398
|
# set `Matching` to true.
|
388
399
|
#
|
400
|
+
# To prevent cross-service impersonation when you call this API, see
|
401
|
+
# [Cross-service confused deputy prevention][3] for sample policies that
|
402
|
+
# you should apply.
|
403
|
+
#
|
389
404
|
#
|
390
405
|
#
|
391
406
|
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html
|
392
407
|
# [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
408
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html
|
393
409
|
#
|
394
410
|
# @option params [required, String] :domain_name
|
395
411
|
# The unique name of the domain.
|
@@ -410,11 +426,16 @@ module Aws::CustomerProfiles
|
|
410
426
|
# to the DeadLetterQueue.
|
411
427
|
#
|
412
428
|
# @option params [Types::MatchingRequest] :matching
|
413
|
-
# The process of matching duplicate profiles. If Matching = true
|
414
|
-
# Connect Customer Profiles starts a weekly batch process
|
415
|
-
#
|
416
|
-
#
|
417
|
-
#
|
429
|
+
# The process of matching duplicate profiles. If `Matching` = `true`,
|
430
|
+
# Amazon Connect Customer Profiles starts a weekly batch process called
|
431
|
+
# Identity Resolution Job. If you do not specify a date and time for
|
432
|
+
# Identity Resolution Job to run, by default it runs every Saturday at
|
433
|
+
# 12AM UTC to detect duplicate profiles in your domains.
|
434
|
+
#
|
435
|
+
# After the Identity Resolution Job completes, use the [GetMatches][1]
|
436
|
+
# API to return and review the results. Or, if you have configured
|
437
|
+
# `ExportingConfig` in the `MatchingRequest`, you can download the
|
438
|
+
# results from S3.
|
418
439
|
#
|
419
440
|
#
|
420
441
|
#
|
@@ -443,6 +464,28 @@ module Aws::CustomerProfiles
|
|
443
464
|
# dead_letter_queue_url: "sqsQueueUrl",
|
444
465
|
# matching: {
|
445
466
|
# enabled: false, # required
|
467
|
+
# job_schedule: {
|
468
|
+
# day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
469
|
+
# time: "JobScheduleTime", # required
|
470
|
+
# },
|
471
|
+
# auto_merging: {
|
472
|
+
# enabled: false, # required
|
473
|
+
# consolidation: {
|
474
|
+
# matching_attributes_list: [ # required
|
475
|
+
# ["string1To255"],
|
476
|
+
# ],
|
477
|
+
# },
|
478
|
+
# conflict_resolution: {
|
479
|
+
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
480
|
+
# source_name: "string1To255",
|
481
|
+
# },
|
482
|
+
# },
|
483
|
+
# exporting_config: {
|
484
|
+
# s3_exporting: {
|
485
|
+
# s3_bucket_name: "s3BucketName", # required
|
486
|
+
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
487
|
+
# },
|
488
|
+
# },
|
446
489
|
# },
|
447
490
|
# tags: {
|
448
491
|
# "TagKey" => "TagValue",
|
@@ -456,6 +499,16 @@ module Aws::CustomerProfiles
|
|
456
499
|
# resp.default_encryption_key #=> String
|
457
500
|
# resp.dead_letter_queue_url #=> String
|
458
501
|
# resp.matching.enabled #=> Boolean
|
502
|
+
# resp.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
503
|
+
# resp.matching.job_schedule.time #=> String
|
504
|
+
# resp.matching.auto_merging.enabled #=> Boolean
|
505
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
|
506
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
|
507
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
508
|
+
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
509
|
+
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
510
|
+
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
511
|
+
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
459
512
|
# resp.created_at #=> Time
|
460
513
|
# resp.last_updated_at #=> Time
|
461
514
|
# resp.tags #=> Hash
|
@@ -845,6 +898,71 @@ module Aws::CustomerProfiles
|
|
845
898
|
req.send_request(options)
|
846
899
|
end
|
847
900
|
|
901
|
+
# Tests the auto-merging settings of your Identity Resolution Job
|
902
|
+
# without merging your data. It randomly selects a sample of matching
|
903
|
+
# groups from the existing matching results, and applies the automerging
|
904
|
+
# settings that you provided. You can then view the number of profiles
|
905
|
+
# in the sample, the number of matches, and the number of profiles
|
906
|
+
# identified to be merged. This enables you to evaluate the accuracy of
|
907
|
+
# the attributes in your matching list.
|
908
|
+
#
|
909
|
+
# You can't view which profiles are matched and would be merged.
|
910
|
+
#
|
911
|
+
# We strongly recommend you use this API to do a dry run of the
|
912
|
+
# automerging process before running the Identity Resolution Job.
|
913
|
+
# Include **at least** two matching attributes. If your matching list
|
914
|
+
# includes too few attributes (such as only `FirstName` or only
|
915
|
+
# `LastName`), there may be a large number of matches. This increases
|
916
|
+
# the chances of erroneous merges.
|
917
|
+
#
|
918
|
+
# @option params [required, String] :domain_name
|
919
|
+
# The unique name of the domain.
|
920
|
+
#
|
921
|
+
# @option params [required, Types::Consolidation] :consolidation
|
922
|
+
# A list of matching attributes that represent matching criteria.
|
923
|
+
#
|
924
|
+
# @option params [required, Types::ConflictResolution] :conflict_resolution
|
925
|
+
# How the auto-merging process should resolve conflicts between
|
926
|
+
# different profiles.
|
927
|
+
#
|
928
|
+
# @return [Types::GetAutoMergingPreviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
929
|
+
#
|
930
|
+
# * {Types::GetAutoMergingPreviewResponse#domain_name #domain_name} => String
|
931
|
+
# * {Types::GetAutoMergingPreviewResponse#number_of_matches_in_sample #number_of_matches_in_sample} => Integer
|
932
|
+
# * {Types::GetAutoMergingPreviewResponse#number_of_profiles_in_sample #number_of_profiles_in_sample} => Integer
|
933
|
+
# * {Types::GetAutoMergingPreviewResponse#number_of_profiles_will_be_merged #number_of_profiles_will_be_merged} => Integer
|
934
|
+
#
|
935
|
+
# @example Request syntax with placeholder values
|
936
|
+
#
|
937
|
+
# resp = client.get_auto_merging_preview({
|
938
|
+
# domain_name: "name", # required
|
939
|
+
# consolidation: { # required
|
940
|
+
# matching_attributes_list: [ # required
|
941
|
+
# ["string1To255"],
|
942
|
+
# ],
|
943
|
+
# },
|
944
|
+
# conflict_resolution: { # required
|
945
|
+
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
946
|
+
# source_name: "string1To255",
|
947
|
+
# },
|
948
|
+
# })
|
949
|
+
#
|
950
|
+
# @example Response structure
|
951
|
+
#
|
952
|
+
# resp.domain_name #=> String
|
953
|
+
# resp.number_of_matches_in_sample #=> Integer
|
954
|
+
# resp.number_of_profiles_in_sample #=> Integer
|
955
|
+
# resp.number_of_profiles_will_be_merged #=> Integer
|
956
|
+
#
|
957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetAutoMergingPreview AWS API Documentation
|
958
|
+
#
|
959
|
+
# @overload get_auto_merging_preview(params = {})
|
960
|
+
# @param [Hash] params ({})
|
961
|
+
def get_auto_merging_preview(params = {}, options = {})
|
962
|
+
req = build_request(:get_auto_merging_preview, params)
|
963
|
+
req.send_request(options)
|
964
|
+
end
|
965
|
+
|
848
966
|
# Returns information about a specific domain.
|
849
967
|
#
|
850
968
|
# @option params [required, String] :domain_name
|
@@ -879,6 +997,16 @@ module Aws::CustomerProfiles
|
|
879
997
|
# resp.stats.object_count #=> Integer
|
880
998
|
# resp.stats.total_size #=> Integer
|
881
999
|
# resp.matching.enabled #=> Boolean
|
1000
|
+
# resp.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
1001
|
+
# resp.matching.job_schedule.time #=> String
|
1002
|
+
# resp.matching.auto_merging.enabled #=> Boolean
|
1003
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
|
1004
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
|
1005
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
1006
|
+
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
1007
|
+
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
1008
|
+
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
1009
|
+
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
882
1010
|
# resp.created_at #=> Time
|
883
1011
|
# resp.last_updated_at #=> Time
|
884
1012
|
# resp.tags #=> Hash
|
@@ -893,6 +1021,75 @@ module Aws::CustomerProfiles
|
|
893
1021
|
req.send_request(options)
|
894
1022
|
end
|
895
1023
|
|
1024
|
+
# Returns information about an Identity Resolution Job in a specific
|
1025
|
+
# domain.
|
1026
|
+
#
|
1027
|
+
# Identity Resolution Jobs are set up using the Amazon Connect admin
|
1028
|
+
# console. For more information, see [Use Identity Resolution to
|
1029
|
+
# consolidate similar profiles][1].
|
1030
|
+
#
|
1031
|
+
#
|
1032
|
+
#
|
1033
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html
|
1034
|
+
#
|
1035
|
+
# @option params [required, String] :domain_name
|
1036
|
+
# The unique name of the domain.
|
1037
|
+
#
|
1038
|
+
# @option params [required, String] :job_id
|
1039
|
+
# The unique identifier of the Identity Resolution Job.
|
1040
|
+
#
|
1041
|
+
# @return [Types::GetIdentityResolutionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1042
|
+
#
|
1043
|
+
# * {Types::GetIdentityResolutionJobResponse#domain_name #domain_name} => String
|
1044
|
+
# * {Types::GetIdentityResolutionJobResponse#job_id #job_id} => String
|
1045
|
+
# * {Types::GetIdentityResolutionJobResponse#status #status} => String
|
1046
|
+
# * {Types::GetIdentityResolutionJobResponse#message #message} => String
|
1047
|
+
# * {Types::GetIdentityResolutionJobResponse#job_start_time #job_start_time} => Time
|
1048
|
+
# * {Types::GetIdentityResolutionJobResponse#job_end_time #job_end_time} => Time
|
1049
|
+
# * {Types::GetIdentityResolutionJobResponse#last_updated_at #last_updated_at} => Time
|
1050
|
+
# * {Types::GetIdentityResolutionJobResponse#job_expiration_time #job_expiration_time} => Time
|
1051
|
+
# * {Types::GetIdentityResolutionJobResponse#auto_merging #auto_merging} => Types::AutoMerging
|
1052
|
+
# * {Types::GetIdentityResolutionJobResponse#exporting_location #exporting_location} => Types::ExportingLocation
|
1053
|
+
# * {Types::GetIdentityResolutionJobResponse#job_stats #job_stats} => Types::JobStats
|
1054
|
+
#
|
1055
|
+
# @example Request syntax with placeholder values
|
1056
|
+
#
|
1057
|
+
# resp = client.get_identity_resolution_job({
|
1058
|
+
# domain_name: "name", # required
|
1059
|
+
# job_id: "uuid", # required
|
1060
|
+
# })
|
1061
|
+
#
|
1062
|
+
# @example Response structure
|
1063
|
+
#
|
1064
|
+
# resp.domain_name #=> String
|
1065
|
+
# resp.job_id #=> String
|
1066
|
+
# resp.status #=> String, one of "PENDING", "PREPROCESSING", "FIND_MATCHING", "MERGING", "COMPLETED", "PARTIAL_SUCCESS", "FAILED"
|
1067
|
+
# resp.message #=> String
|
1068
|
+
# resp.job_start_time #=> Time
|
1069
|
+
# resp.job_end_time #=> Time
|
1070
|
+
# resp.last_updated_at #=> Time
|
1071
|
+
# resp.job_expiration_time #=> Time
|
1072
|
+
# resp.auto_merging.enabled #=> Boolean
|
1073
|
+
# resp.auto_merging.consolidation.matching_attributes_list #=> Array
|
1074
|
+
# resp.auto_merging.consolidation.matching_attributes_list[0] #=> Array
|
1075
|
+
# resp.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
1076
|
+
# resp.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
1077
|
+
# resp.auto_merging.conflict_resolution.source_name #=> String
|
1078
|
+
# resp.exporting_location.s3_exporting.s3_bucket_name #=> String
|
1079
|
+
# resp.exporting_location.s3_exporting.s3_key_name #=> String
|
1080
|
+
# resp.job_stats.number_of_profiles_reviewed #=> Integer
|
1081
|
+
# resp.job_stats.number_of_matches_found #=> Integer
|
1082
|
+
# resp.job_stats.number_of_merges_done #=> Integer
|
1083
|
+
#
|
1084
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIdentityResolutionJob AWS API Documentation
|
1085
|
+
#
|
1086
|
+
# @overload get_identity_resolution_job(params = {})
|
1087
|
+
# @param [Hash] params ({})
|
1088
|
+
def get_identity_resolution_job(params = {}, options = {})
|
1089
|
+
req = build_request(:get_identity_resolution_job, params)
|
1090
|
+
req.send_request(options)
|
1091
|
+
end
|
1092
|
+
|
896
1093
|
# Returns an integration for a domain.
|
897
1094
|
#
|
898
1095
|
# @option params [required, String] :domain_name
|
@@ -945,9 +1142,16 @@ module Aws::CustomerProfiles
|
|
945
1142
|
# GetMatches returns potentially matching profiles, based on the results
|
946
1143
|
# of the latest run of a machine learning process.
|
947
1144
|
#
|
948
|
-
#
|
949
|
-
#
|
950
|
-
#
|
1145
|
+
# The process of matching duplicate profiles. If `Matching` = `true`,
|
1146
|
+
# Amazon Connect Customer Profiles starts a weekly batch process called
|
1147
|
+
# Identity Resolution Job. If you do not specify a date and time for
|
1148
|
+
# Identity Resolution Job to run, by default it runs every Saturday at
|
1149
|
+
# 12AM UTC to detect duplicate profiles in your domains.
|
1150
|
+
#
|
1151
|
+
# After the Identity Resolution Job completes, use the [GetMatches][3]
|
1152
|
+
# API to return and review the results. Or, if you have configured
|
1153
|
+
# `ExportingConfig` in the `MatchingRequest`, you can download the
|
1154
|
+
# results from S3.
|
951
1155
|
#
|
952
1156
|
# Amazon Connect uses the following profile attributes to identify
|
953
1157
|
# matches:
|
@@ -981,6 +1185,7 @@ module Aws::CustomerProfiles
|
|
981
1185
|
#
|
982
1186
|
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html
|
983
1187
|
# [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html
|
1188
|
+
# [3]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
984
1189
|
#
|
985
1190
|
# @option params [String] :next_token
|
986
1191
|
# The token for the next set of results. Use the value returned in the
|
@@ -1017,6 +1222,7 @@ module Aws::CustomerProfiles
|
|
1017
1222
|
# resp.matches[0].match_id #=> String
|
1018
1223
|
# resp.matches[0].profile_ids #=> Array
|
1019
1224
|
# resp.matches[0].profile_ids[0] #=> String
|
1225
|
+
# resp.matches[0].confidence_score #=> Float
|
1020
1226
|
#
|
1021
1227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetMatches AWS API Documentation
|
1022
1228
|
#
|
@@ -1043,6 +1249,7 @@ module Aws::CustomerProfiles
|
|
1043
1249
|
# * {Types::GetProfileObjectTypeResponse#expiration_days #expiration_days} => Integer
|
1044
1250
|
# * {Types::GetProfileObjectTypeResponse#encryption_key #encryption_key} => String
|
1045
1251
|
# * {Types::GetProfileObjectTypeResponse#allow_profile_creation #allow_profile_creation} => Boolean
|
1252
|
+
# * {Types::GetProfileObjectTypeResponse#source_last_updated_timestamp_format #source_last_updated_timestamp_format} => String
|
1046
1253
|
# * {Types::GetProfileObjectTypeResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
1047
1254
|
# * {Types::GetProfileObjectTypeResponse#keys #keys} => Hash<String,Array<Types::ObjectTypeKey>>
|
1048
1255
|
# * {Types::GetProfileObjectTypeResponse#created_at #created_at} => Time
|
@@ -1064,6 +1271,7 @@ module Aws::CustomerProfiles
|
|
1064
1271
|
# resp.expiration_days #=> Integer
|
1065
1272
|
# resp.encryption_key #=> String
|
1066
1273
|
# resp.allow_profile_creation #=> Boolean
|
1274
|
+
# resp.source_last_updated_timestamp_format #=> String
|
1067
1275
|
# resp.fields #=> Hash
|
1068
1276
|
# resp.fields["name"].source #=> String
|
1069
1277
|
# resp.fields["name"].target #=> String
|
@@ -1105,6 +1313,7 @@ module Aws::CustomerProfiles
|
|
1105
1313
|
# * {Types::GetProfileObjectTypeTemplateResponse#source_name #source_name} => String
|
1106
1314
|
# * {Types::GetProfileObjectTypeTemplateResponse#source_object #source_object} => String
|
1107
1315
|
# * {Types::GetProfileObjectTypeTemplateResponse#allow_profile_creation #allow_profile_creation} => Boolean
|
1316
|
+
# * {Types::GetProfileObjectTypeTemplateResponse#source_last_updated_timestamp_format #source_last_updated_timestamp_format} => String
|
1108
1317
|
# * {Types::GetProfileObjectTypeTemplateResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
1109
1318
|
# * {Types::GetProfileObjectTypeTemplateResponse#keys #keys} => Hash<String,Array<Types::ObjectTypeKey>>
|
1110
1319
|
#
|
@@ -1120,6 +1329,7 @@ module Aws::CustomerProfiles
|
|
1120
1329
|
# resp.source_name #=> String
|
1121
1330
|
# resp.source_object #=> String
|
1122
1331
|
# resp.allow_profile_creation #=> Boolean
|
1332
|
+
# resp.source_last_updated_timestamp_format #=> String
|
1123
1333
|
# resp.fields #=> Hash
|
1124
1334
|
# resp.fields["name"].source #=> String
|
1125
1335
|
# resp.fields["name"].target #=> String
|
@@ -1227,6 +1437,58 @@ module Aws::CustomerProfiles
|
|
1227
1437
|
req.send_request(options)
|
1228
1438
|
end
|
1229
1439
|
|
1440
|
+
# Lists all of the Identity Resolution Jobs in your domain. The response
|
1441
|
+
# sorts the list by `JobStartTime`.
|
1442
|
+
#
|
1443
|
+
# @option params [required, String] :domain_name
|
1444
|
+
# The unique name of the domain.
|
1445
|
+
#
|
1446
|
+
# @option params [String] :next_token
|
1447
|
+
# The token for the next set of results. Use the value returned in the
|
1448
|
+
# previous response in the next request to retrieve the next set of
|
1449
|
+
# results.
|
1450
|
+
#
|
1451
|
+
# @option params [Integer] :max_results
|
1452
|
+
# The maximum number of results to return per page.
|
1453
|
+
#
|
1454
|
+
# @return [Types::ListIdentityResolutionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1455
|
+
#
|
1456
|
+
# * {Types::ListIdentityResolutionJobsResponse#identity_resolution_jobs_list #identity_resolution_jobs_list} => Array<Types::IdentityResolutionJob>
|
1457
|
+
# * {Types::ListIdentityResolutionJobsResponse#next_token #next_token} => String
|
1458
|
+
#
|
1459
|
+
# @example Request syntax with placeholder values
|
1460
|
+
#
|
1461
|
+
# resp = client.list_identity_resolution_jobs({
|
1462
|
+
# domain_name: "name", # required
|
1463
|
+
# next_token: "token",
|
1464
|
+
# max_results: 1,
|
1465
|
+
# })
|
1466
|
+
#
|
1467
|
+
# @example Response structure
|
1468
|
+
#
|
1469
|
+
# resp.identity_resolution_jobs_list #=> Array
|
1470
|
+
# resp.identity_resolution_jobs_list[0].domain_name #=> String
|
1471
|
+
# resp.identity_resolution_jobs_list[0].job_id #=> String
|
1472
|
+
# resp.identity_resolution_jobs_list[0].status #=> String, one of "PENDING", "PREPROCESSING", "FIND_MATCHING", "MERGING", "COMPLETED", "PARTIAL_SUCCESS", "FAILED"
|
1473
|
+
# resp.identity_resolution_jobs_list[0].job_start_time #=> Time
|
1474
|
+
# resp.identity_resolution_jobs_list[0].job_end_time #=> Time
|
1475
|
+
# resp.identity_resolution_jobs_list[0].job_stats.number_of_profiles_reviewed #=> Integer
|
1476
|
+
# resp.identity_resolution_jobs_list[0].job_stats.number_of_matches_found #=> Integer
|
1477
|
+
# resp.identity_resolution_jobs_list[0].job_stats.number_of_merges_done #=> Integer
|
1478
|
+
# resp.identity_resolution_jobs_list[0].exporting_location.s3_exporting.s3_bucket_name #=> String
|
1479
|
+
# resp.identity_resolution_jobs_list[0].exporting_location.s3_exporting.s3_key_name #=> String
|
1480
|
+
# resp.identity_resolution_jobs_list[0].message #=> String
|
1481
|
+
# resp.next_token #=> String
|
1482
|
+
#
|
1483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIdentityResolutionJobs AWS API Documentation
|
1484
|
+
#
|
1485
|
+
# @overload list_identity_resolution_jobs(params = {})
|
1486
|
+
# @param [Hash] params ({})
|
1487
|
+
def list_identity_resolution_jobs(params = {}, options = {})
|
1488
|
+
req = build_request(:list_identity_resolution_jobs, params)
|
1489
|
+
req.send_request(options)
|
1490
|
+
end
|
1491
|
+
|
1230
1492
|
# Lists all of the integrations in your domain.
|
1231
1493
|
#
|
1232
1494
|
# @option params [required, String] :domain_name
|
@@ -1748,6 +2010,10 @@ module Aws::CustomerProfiles
|
|
1748
2010
|
# profile. If it is set to `TRUE`, and if no match is found, then the
|
1749
2011
|
# service creates a new standard profile.
|
1750
2012
|
#
|
2013
|
+
# @option params [String] :source_last_updated_timestamp_format
|
2014
|
+
# The format of your `sourceLastUpdatedTimestamp` that was previously
|
2015
|
+
# set up.
|
2016
|
+
#
|
1751
2017
|
# @option params [Hash<String,Types::ObjectTypeField>] :fields
|
1752
2018
|
# A map of the name and ObjectType field.
|
1753
2019
|
#
|
@@ -1765,6 +2031,7 @@ module Aws::CustomerProfiles
|
|
1765
2031
|
# * {Types::PutProfileObjectTypeResponse#expiration_days #expiration_days} => Integer
|
1766
2032
|
# * {Types::PutProfileObjectTypeResponse#encryption_key #encryption_key} => String
|
1767
2033
|
# * {Types::PutProfileObjectTypeResponse#allow_profile_creation #allow_profile_creation} => Boolean
|
2034
|
+
# * {Types::PutProfileObjectTypeResponse#source_last_updated_timestamp_format #source_last_updated_timestamp_format} => String
|
1768
2035
|
# * {Types::PutProfileObjectTypeResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
1769
2036
|
# * {Types::PutProfileObjectTypeResponse#keys #keys} => Hash<String,Array<Types::ObjectTypeKey>>
|
1770
2037
|
# * {Types::PutProfileObjectTypeResponse#created_at #created_at} => Time
|
@@ -1781,6 +2048,7 @@ module Aws::CustomerProfiles
|
|
1781
2048
|
# expiration_days: 1,
|
1782
2049
|
# encryption_key: "encryptionKey",
|
1783
2050
|
# allow_profile_creation: false,
|
2051
|
+
# source_last_updated_timestamp_format: "string1To255",
|
1784
2052
|
# fields: {
|
1785
2053
|
# "name" => {
|
1786
2054
|
# source: "text",
|
@@ -1809,6 +2077,7 @@ module Aws::CustomerProfiles
|
|
1809
2077
|
# resp.expiration_days #=> Integer
|
1810
2078
|
# resp.encryption_key #=> String
|
1811
2079
|
# resp.allow_profile_creation #=> Boolean
|
2080
|
+
# resp.source_last_updated_timestamp_format #=> String
|
1812
2081
|
# resp.fields #=> Hash
|
1813
2082
|
# resp.fields["name"].source #=> String
|
1814
2083
|
# resp.fields["name"].target #=> String
|
@@ -2023,10 +2292,15 @@ module Aws::CustomerProfiles
|
|
2023
2292
|
# Use this API or [CreateDomain][1] to enable [identity resolution][2]\:
|
2024
2293
|
# set `Matching` to true.
|
2025
2294
|
#
|
2295
|
+
# To prevent cross-service impersonation when you call this API, see
|
2296
|
+
# [Cross-service confused deputy prevention][3] for sample policies that
|
2297
|
+
# you should apply.
|
2298
|
+
#
|
2026
2299
|
#
|
2027
2300
|
#
|
2028
2301
|
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html
|
2029
2302
|
# [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
2303
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html
|
2030
2304
|
#
|
2031
2305
|
# @option params [required, String] :domain_name
|
2032
2306
|
# The unique name of the domain.
|
@@ -2049,11 +2323,16 @@ module Aws::CustomerProfiles
|
|
2049
2323
|
# to the DeadLetterQueue.
|
2050
2324
|
#
|
2051
2325
|
# @option params [Types::MatchingRequest] :matching
|
2052
|
-
# The process of matching duplicate profiles. If Matching = true
|
2053
|
-
# Connect Customer Profiles starts a weekly batch process
|
2054
|
-
#
|
2055
|
-
#
|
2056
|
-
#
|
2326
|
+
# The process of matching duplicate profiles. If `Matching` = `true`,
|
2327
|
+
# Amazon Connect Customer Profiles starts a weekly batch process called
|
2328
|
+
# Identity Resolution Job. If you do not specify a date and time for
|
2329
|
+
# Identity Resolution Job to run, by default it runs every Saturday at
|
2330
|
+
# 12AM UTC to detect duplicate profiles in your domains.
|
2331
|
+
#
|
2332
|
+
# After the Identity Resolution Job completes, use the [GetMatches][1]
|
2333
|
+
# API to return and review the results. Or, if you have configured
|
2334
|
+
# `ExportingConfig` in the `MatchingRequest`, you can download the
|
2335
|
+
# results from S3.
|
2057
2336
|
#
|
2058
2337
|
#
|
2059
2338
|
#
|
@@ -2082,6 +2361,28 @@ module Aws::CustomerProfiles
|
|
2082
2361
|
# dead_letter_queue_url: "sqsQueueUrl",
|
2083
2362
|
# matching: {
|
2084
2363
|
# enabled: false, # required
|
2364
|
+
# job_schedule: {
|
2365
|
+
# day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
2366
|
+
# time: "JobScheduleTime", # required
|
2367
|
+
# },
|
2368
|
+
# auto_merging: {
|
2369
|
+
# enabled: false, # required
|
2370
|
+
# consolidation: {
|
2371
|
+
# matching_attributes_list: [ # required
|
2372
|
+
# ["string1To255"],
|
2373
|
+
# ],
|
2374
|
+
# },
|
2375
|
+
# conflict_resolution: {
|
2376
|
+
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
2377
|
+
# source_name: "string1To255",
|
2378
|
+
# },
|
2379
|
+
# },
|
2380
|
+
# exporting_config: {
|
2381
|
+
# s3_exporting: {
|
2382
|
+
# s3_bucket_name: "s3BucketName", # required
|
2383
|
+
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
2384
|
+
# },
|
2385
|
+
# },
|
2085
2386
|
# },
|
2086
2387
|
# tags: {
|
2087
2388
|
# "TagKey" => "TagValue",
|
@@ -2095,6 +2396,16 @@ module Aws::CustomerProfiles
|
|
2095
2396
|
# resp.default_encryption_key #=> String
|
2096
2397
|
# resp.dead_letter_queue_url #=> String
|
2097
2398
|
# resp.matching.enabled #=> Boolean
|
2399
|
+
# resp.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
2400
|
+
# resp.matching.job_schedule.time #=> String
|
2401
|
+
# resp.matching.auto_merging.enabled #=> Boolean
|
2402
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
|
2403
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
|
2404
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
2405
|
+
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
2406
|
+
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
2407
|
+
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
2408
|
+
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
2098
2409
|
# resp.created_at #=> Time
|
2099
2410
|
# resp.last_updated_at #=> Time
|
2100
2411
|
# resp.tags #=> Hash
|
@@ -2292,7 +2603,7 @@ module Aws::CustomerProfiles
|
|
2292
2603
|
params: params,
|
2293
2604
|
config: config)
|
2294
2605
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
2295
|
-
context[:gem_version] = '1.
|
2606
|
+
context[:gem_version] = '1.15.0'
|
2296
2607
|
Seahorse::Client::Request.new(handlers, context)
|
2297
2608
|
end
|
2298
2609
|
|