aws-sdk-customerprofiles 1.13.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +314 -14
- 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 +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e740e587892a7b167cd001e7d6b60848fd5247572e5c6602975652b88ee3d658
|
|
4
|
+
data.tar.gz: 6a516381a0fc24265ef180cf54fe96103992667ee5c247e50bb3e97747a46899
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6a52db5f65db9c96938d352be54a21c4488bb208c3220b1fcd48143af20f3f770e420f7f78506ef7a65f01adbf9075a0015c36bd82ff09ed9e9b3386283bb27c
|
|
7
|
+
data.tar.gz: 6e68b5cc05db16169408137847e07020770c61bf16bbc13f6f1ca97b704bf2d2f5b81614fe68a8d01d9ba3420938119cd9c6292504f7ec921d3cd3ac48302440
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.14.0 (2021-11-24)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* 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.
|
|
8
|
+
|
|
4
9
|
1.13.0 (2021-11-04)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.14.0
|
|
@@ -395,10 +395,15 @@ module Aws::CustomerProfiles
|
|
|
395
395
|
# Use this API or [UpdateDomain][1] to enable [identity resolution][2]\:
|
|
396
396
|
# set `Matching` to true.
|
|
397
397
|
#
|
|
398
|
+
# To prevent cross-service impersonation when you call this API, see
|
|
399
|
+
# [Cross-service confused deputy prevention][3] for sample policies that
|
|
400
|
+
# you should apply.
|
|
401
|
+
#
|
|
398
402
|
#
|
|
399
403
|
#
|
|
400
404
|
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html
|
|
401
405
|
# [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
|
406
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html
|
|
402
407
|
#
|
|
403
408
|
# @option params [required, String] :domain_name
|
|
404
409
|
# The unique name of the domain.
|
|
@@ -419,11 +424,16 @@ module Aws::CustomerProfiles
|
|
|
419
424
|
# to the DeadLetterQueue.
|
|
420
425
|
#
|
|
421
426
|
# @option params [Types::MatchingRequest] :matching
|
|
422
|
-
# The process of matching duplicate profiles. If Matching = true
|
|
423
|
-
# Connect Customer Profiles starts a weekly batch process
|
|
424
|
-
#
|
|
425
|
-
#
|
|
426
|
-
#
|
|
427
|
+
# The process of matching duplicate profiles. If `Matching` = `true`,
|
|
428
|
+
# Amazon Connect Customer Profiles starts a weekly batch process called
|
|
429
|
+
# Identity Resolution Job. If you do not specify a date and time for
|
|
430
|
+
# Identity Resolution Job to run, by default it runs every Saturday at
|
|
431
|
+
# 12AM UTC to detect duplicate profiles in your domains.
|
|
432
|
+
#
|
|
433
|
+
# After the Identity Resolution Job completes, use the [GetMatches][1]
|
|
434
|
+
# API to return and review the results. Or, if you have configured
|
|
435
|
+
# `ExportingConfig` in the `MatchingRequest`, you can download the
|
|
436
|
+
# results from S3.
|
|
427
437
|
#
|
|
428
438
|
#
|
|
429
439
|
#
|
|
@@ -452,6 +462,28 @@ module Aws::CustomerProfiles
|
|
|
452
462
|
# dead_letter_queue_url: "sqsQueueUrl",
|
|
453
463
|
# matching: {
|
|
454
464
|
# enabled: false, # required
|
|
465
|
+
# job_schedule: {
|
|
466
|
+
# day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
|
467
|
+
# time: "JobScheduleTime", # required
|
|
468
|
+
# },
|
|
469
|
+
# auto_merging: {
|
|
470
|
+
# enabled: false, # required
|
|
471
|
+
# consolidation: {
|
|
472
|
+
# matching_attributes_list: [ # required
|
|
473
|
+
# ["string1To255"],
|
|
474
|
+
# ],
|
|
475
|
+
# },
|
|
476
|
+
# conflict_resolution: {
|
|
477
|
+
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
|
478
|
+
# source_name: "string1To255",
|
|
479
|
+
# },
|
|
480
|
+
# },
|
|
481
|
+
# exporting_config: {
|
|
482
|
+
# s3_exporting: {
|
|
483
|
+
# s3_bucket_name: "s3BucketName", # required
|
|
484
|
+
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
|
485
|
+
# },
|
|
486
|
+
# },
|
|
455
487
|
# },
|
|
456
488
|
# tags: {
|
|
457
489
|
# "TagKey" => "TagValue",
|
|
@@ -465,6 +497,16 @@ module Aws::CustomerProfiles
|
|
|
465
497
|
# resp.default_encryption_key #=> String
|
|
466
498
|
# resp.dead_letter_queue_url #=> String
|
|
467
499
|
# resp.matching.enabled #=> Boolean
|
|
500
|
+
# resp.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
|
501
|
+
# resp.matching.job_schedule.time #=> String
|
|
502
|
+
# resp.matching.auto_merging.enabled #=> Boolean
|
|
503
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
|
|
504
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
|
|
505
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
|
506
|
+
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
|
507
|
+
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
|
508
|
+
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
|
509
|
+
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
|
468
510
|
# resp.created_at #=> Time
|
|
469
511
|
# resp.last_updated_at #=> Time
|
|
470
512
|
# resp.tags #=> Hash
|
|
@@ -854,6 +896,71 @@ module Aws::CustomerProfiles
|
|
|
854
896
|
req.send_request(options)
|
|
855
897
|
end
|
|
856
898
|
|
|
899
|
+
# Tests the auto-merging settings of your Identity Resolution Job
|
|
900
|
+
# without merging your data. It randomly selects a sample of matching
|
|
901
|
+
# groups from the existing matching results, and applies the automerging
|
|
902
|
+
# settings that you provided. You can then view the number of profiles
|
|
903
|
+
# in the sample, the number of matches, and the number of profiles
|
|
904
|
+
# identified to be merged. This enables you to evaluate the accuracy of
|
|
905
|
+
# the attributes in your matching list.
|
|
906
|
+
#
|
|
907
|
+
# You can't view which profiles are matched and would be merged.
|
|
908
|
+
#
|
|
909
|
+
# We strongly recommend you use this API to do a dry run of the
|
|
910
|
+
# automerging process before running the Identity Resolution Job.
|
|
911
|
+
# Include **at least** two matching attributes. If your matching list
|
|
912
|
+
# includes too few attributes (such as only `FirstName` or only
|
|
913
|
+
# `LastName`), there may be a large number of matches. This increases
|
|
914
|
+
# the chances of erroneous merges.
|
|
915
|
+
#
|
|
916
|
+
# @option params [required, String] :domain_name
|
|
917
|
+
# The unique name of the domain.
|
|
918
|
+
#
|
|
919
|
+
# @option params [required, Types::Consolidation] :consolidation
|
|
920
|
+
# A list of matching attributes that represent matching criteria.
|
|
921
|
+
#
|
|
922
|
+
# @option params [required, Types::ConflictResolution] :conflict_resolution
|
|
923
|
+
# How the auto-merging process should resolve conflicts between
|
|
924
|
+
# different profiles.
|
|
925
|
+
#
|
|
926
|
+
# @return [Types::GetAutoMergingPreviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
927
|
+
#
|
|
928
|
+
# * {Types::GetAutoMergingPreviewResponse#domain_name #domain_name} => String
|
|
929
|
+
# * {Types::GetAutoMergingPreviewResponse#number_of_matches_in_sample #number_of_matches_in_sample} => Integer
|
|
930
|
+
# * {Types::GetAutoMergingPreviewResponse#number_of_profiles_in_sample #number_of_profiles_in_sample} => Integer
|
|
931
|
+
# * {Types::GetAutoMergingPreviewResponse#number_of_profiles_will_be_merged #number_of_profiles_will_be_merged} => Integer
|
|
932
|
+
#
|
|
933
|
+
# @example Request syntax with placeholder values
|
|
934
|
+
#
|
|
935
|
+
# resp = client.get_auto_merging_preview({
|
|
936
|
+
# domain_name: "name", # required
|
|
937
|
+
# consolidation: { # required
|
|
938
|
+
# matching_attributes_list: [ # required
|
|
939
|
+
# ["string1To255"],
|
|
940
|
+
# ],
|
|
941
|
+
# },
|
|
942
|
+
# conflict_resolution: { # required
|
|
943
|
+
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
|
944
|
+
# source_name: "string1To255",
|
|
945
|
+
# },
|
|
946
|
+
# })
|
|
947
|
+
#
|
|
948
|
+
# @example Response structure
|
|
949
|
+
#
|
|
950
|
+
# resp.domain_name #=> String
|
|
951
|
+
# resp.number_of_matches_in_sample #=> Integer
|
|
952
|
+
# resp.number_of_profiles_in_sample #=> Integer
|
|
953
|
+
# resp.number_of_profiles_will_be_merged #=> Integer
|
|
954
|
+
#
|
|
955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetAutoMergingPreview AWS API Documentation
|
|
956
|
+
#
|
|
957
|
+
# @overload get_auto_merging_preview(params = {})
|
|
958
|
+
# @param [Hash] params ({})
|
|
959
|
+
def get_auto_merging_preview(params = {}, options = {})
|
|
960
|
+
req = build_request(:get_auto_merging_preview, params)
|
|
961
|
+
req.send_request(options)
|
|
962
|
+
end
|
|
963
|
+
|
|
857
964
|
# Returns information about a specific domain.
|
|
858
965
|
#
|
|
859
966
|
# @option params [required, String] :domain_name
|
|
@@ -888,6 +995,16 @@ module Aws::CustomerProfiles
|
|
|
888
995
|
# resp.stats.object_count #=> Integer
|
|
889
996
|
# resp.stats.total_size #=> Integer
|
|
890
997
|
# resp.matching.enabled #=> Boolean
|
|
998
|
+
# resp.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
|
999
|
+
# resp.matching.job_schedule.time #=> String
|
|
1000
|
+
# resp.matching.auto_merging.enabled #=> Boolean
|
|
1001
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
|
|
1002
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
|
|
1003
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
|
1004
|
+
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
|
1005
|
+
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
|
1006
|
+
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
|
1007
|
+
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
|
891
1008
|
# resp.created_at #=> Time
|
|
892
1009
|
# resp.last_updated_at #=> Time
|
|
893
1010
|
# resp.tags #=> Hash
|
|
@@ -902,6 +1019,75 @@ module Aws::CustomerProfiles
|
|
|
902
1019
|
req.send_request(options)
|
|
903
1020
|
end
|
|
904
1021
|
|
|
1022
|
+
# Returns information about an Identity Resolution Job in a specific
|
|
1023
|
+
# domain.
|
|
1024
|
+
#
|
|
1025
|
+
# Identity Resolution Jobs are set up using the Amazon Connect admin
|
|
1026
|
+
# console. For more information, see [Use Identity Resolution to
|
|
1027
|
+
# consolidate similar profiles][1].
|
|
1028
|
+
#
|
|
1029
|
+
#
|
|
1030
|
+
#
|
|
1031
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html
|
|
1032
|
+
#
|
|
1033
|
+
# @option params [required, String] :domain_name
|
|
1034
|
+
# The unique name of the domain.
|
|
1035
|
+
#
|
|
1036
|
+
# @option params [required, String] :job_id
|
|
1037
|
+
# The unique identifier of the Identity Resolution Job.
|
|
1038
|
+
#
|
|
1039
|
+
# @return [Types::GetIdentityResolutionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1040
|
+
#
|
|
1041
|
+
# * {Types::GetIdentityResolutionJobResponse#domain_name #domain_name} => String
|
|
1042
|
+
# * {Types::GetIdentityResolutionJobResponse#job_id #job_id} => String
|
|
1043
|
+
# * {Types::GetIdentityResolutionJobResponse#status #status} => String
|
|
1044
|
+
# * {Types::GetIdentityResolutionJobResponse#message #message} => String
|
|
1045
|
+
# * {Types::GetIdentityResolutionJobResponse#job_start_time #job_start_time} => Time
|
|
1046
|
+
# * {Types::GetIdentityResolutionJobResponse#job_end_time #job_end_time} => Time
|
|
1047
|
+
# * {Types::GetIdentityResolutionJobResponse#last_updated_at #last_updated_at} => Time
|
|
1048
|
+
# * {Types::GetIdentityResolutionJobResponse#job_expiration_time #job_expiration_time} => Time
|
|
1049
|
+
# * {Types::GetIdentityResolutionJobResponse#auto_merging #auto_merging} => Types::AutoMerging
|
|
1050
|
+
# * {Types::GetIdentityResolutionJobResponse#exporting_location #exporting_location} => Types::ExportingLocation
|
|
1051
|
+
# * {Types::GetIdentityResolutionJobResponse#job_stats #job_stats} => Types::JobStats
|
|
1052
|
+
#
|
|
1053
|
+
# @example Request syntax with placeholder values
|
|
1054
|
+
#
|
|
1055
|
+
# resp = client.get_identity_resolution_job({
|
|
1056
|
+
# domain_name: "name", # required
|
|
1057
|
+
# job_id: "uuid", # required
|
|
1058
|
+
# })
|
|
1059
|
+
#
|
|
1060
|
+
# @example Response structure
|
|
1061
|
+
#
|
|
1062
|
+
# resp.domain_name #=> String
|
|
1063
|
+
# resp.job_id #=> String
|
|
1064
|
+
# resp.status #=> String, one of "PENDING", "PREPROCESSING", "FIND_MATCHING", "MERGING", "COMPLETED", "PARTIAL_SUCCESS", "FAILED"
|
|
1065
|
+
# resp.message #=> String
|
|
1066
|
+
# resp.job_start_time #=> Time
|
|
1067
|
+
# resp.job_end_time #=> Time
|
|
1068
|
+
# resp.last_updated_at #=> Time
|
|
1069
|
+
# resp.job_expiration_time #=> Time
|
|
1070
|
+
# resp.auto_merging.enabled #=> Boolean
|
|
1071
|
+
# resp.auto_merging.consolidation.matching_attributes_list #=> Array
|
|
1072
|
+
# resp.auto_merging.consolidation.matching_attributes_list[0] #=> Array
|
|
1073
|
+
# resp.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
|
1074
|
+
# resp.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
|
1075
|
+
# resp.auto_merging.conflict_resolution.source_name #=> String
|
|
1076
|
+
# resp.exporting_location.s3_exporting.s3_bucket_name #=> String
|
|
1077
|
+
# resp.exporting_location.s3_exporting.s3_key_name #=> String
|
|
1078
|
+
# resp.job_stats.number_of_profiles_reviewed #=> Integer
|
|
1079
|
+
# resp.job_stats.number_of_matches_found #=> Integer
|
|
1080
|
+
# resp.job_stats.number_of_merges_done #=> Integer
|
|
1081
|
+
#
|
|
1082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIdentityResolutionJob AWS API Documentation
|
|
1083
|
+
#
|
|
1084
|
+
# @overload get_identity_resolution_job(params = {})
|
|
1085
|
+
# @param [Hash] params ({})
|
|
1086
|
+
def get_identity_resolution_job(params = {}, options = {})
|
|
1087
|
+
req = build_request(:get_identity_resolution_job, params)
|
|
1088
|
+
req.send_request(options)
|
|
1089
|
+
end
|
|
1090
|
+
|
|
905
1091
|
# Returns an integration for a domain.
|
|
906
1092
|
#
|
|
907
1093
|
# @option params [required, String] :domain_name
|
|
@@ -954,9 +1140,16 @@ module Aws::CustomerProfiles
|
|
|
954
1140
|
# GetMatches returns potentially matching profiles, based on the results
|
|
955
1141
|
# of the latest run of a machine learning process.
|
|
956
1142
|
#
|
|
957
|
-
#
|
|
958
|
-
#
|
|
959
|
-
#
|
|
1143
|
+
# The process of matching duplicate profiles. If `Matching` = `true`,
|
|
1144
|
+
# Amazon Connect Customer Profiles starts a weekly batch process called
|
|
1145
|
+
# Identity Resolution Job. If you do not specify a date and time for
|
|
1146
|
+
# Identity Resolution Job to run, by default it runs every Saturday at
|
|
1147
|
+
# 12AM UTC to detect duplicate profiles in your domains.
|
|
1148
|
+
#
|
|
1149
|
+
# After the Identity Resolution Job completes, use the [GetMatches][3]
|
|
1150
|
+
# API to return and review the results. Or, if you have configured
|
|
1151
|
+
# `ExportingConfig` in the `MatchingRequest`, you can download the
|
|
1152
|
+
# results from S3.
|
|
960
1153
|
#
|
|
961
1154
|
# Amazon Connect uses the following profile attributes to identify
|
|
962
1155
|
# matches:
|
|
@@ -990,6 +1183,7 @@ module Aws::CustomerProfiles
|
|
|
990
1183
|
#
|
|
991
1184
|
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html
|
|
992
1185
|
# [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html
|
|
1186
|
+
# [3]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
|
993
1187
|
#
|
|
994
1188
|
# @option params [String] :next_token
|
|
995
1189
|
# The token for the next set of results. Use the value returned in the
|
|
@@ -1026,6 +1220,7 @@ module Aws::CustomerProfiles
|
|
|
1026
1220
|
# resp.matches[0].match_id #=> String
|
|
1027
1221
|
# resp.matches[0].profile_ids #=> Array
|
|
1028
1222
|
# resp.matches[0].profile_ids[0] #=> String
|
|
1223
|
+
# resp.matches[0].confidence_score #=> Float
|
|
1029
1224
|
#
|
|
1030
1225
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetMatches AWS API Documentation
|
|
1031
1226
|
#
|
|
@@ -1052,6 +1247,7 @@ module Aws::CustomerProfiles
|
|
|
1052
1247
|
# * {Types::GetProfileObjectTypeResponse#expiration_days #expiration_days} => Integer
|
|
1053
1248
|
# * {Types::GetProfileObjectTypeResponse#encryption_key #encryption_key} => String
|
|
1054
1249
|
# * {Types::GetProfileObjectTypeResponse#allow_profile_creation #allow_profile_creation} => Boolean
|
|
1250
|
+
# * {Types::GetProfileObjectTypeResponse#source_last_updated_timestamp_format #source_last_updated_timestamp_format} => String
|
|
1055
1251
|
# * {Types::GetProfileObjectTypeResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
|
1056
1252
|
# * {Types::GetProfileObjectTypeResponse#keys #keys} => Hash<String,Array<Types::ObjectTypeKey>>
|
|
1057
1253
|
# * {Types::GetProfileObjectTypeResponse#created_at #created_at} => Time
|
|
@@ -1073,6 +1269,7 @@ module Aws::CustomerProfiles
|
|
|
1073
1269
|
# resp.expiration_days #=> Integer
|
|
1074
1270
|
# resp.encryption_key #=> String
|
|
1075
1271
|
# resp.allow_profile_creation #=> Boolean
|
|
1272
|
+
# resp.source_last_updated_timestamp_format #=> String
|
|
1076
1273
|
# resp.fields #=> Hash
|
|
1077
1274
|
# resp.fields["name"].source #=> String
|
|
1078
1275
|
# resp.fields["name"].target #=> String
|
|
@@ -1114,6 +1311,7 @@ module Aws::CustomerProfiles
|
|
|
1114
1311
|
# * {Types::GetProfileObjectTypeTemplateResponse#source_name #source_name} => String
|
|
1115
1312
|
# * {Types::GetProfileObjectTypeTemplateResponse#source_object #source_object} => String
|
|
1116
1313
|
# * {Types::GetProfileObjectTypeTemplateResponse#allow_profile_creation #allow_profile_creation} => Boolean
|
|
1314
|
+
# * {Types::GetProfileObjectTypeTemplateResponse#source_last_updated_timestamp_format #source_last_updated_timestamp_format} => String
|
|
1117
1315
|
# * {Types::GetProfileObjectTypeTemplateResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
|
1118
1316
|
# * {Types::GetProfileObjectTypeTemplateResponse#keys #keys} => Hash<String,Array<Types::ObjectTypeKey>>
|
|
1119
1317
|
#
|
|
@@ -1129,6 +1327,7 @@ module Aws::CustomerProfiles
|
|
|
1129
1327
|
# resp.source_name #=> String
|
|
1130
1328
|
# resp.source_object #=> String
|
|
1131
1329
|
# resp.allow_profile_creation #=> Boolean
|
|
1330
|
+
# resp.source_last_updated_timestamp_format #=> String
|
|
1132
1331
|
# resp.fields #=> Hash
|
|
1133
1332
|
# resp.fields["name"].source #=> String
|
|
1134
1333
|
# resp.fields["name"].target #=> String
|
|
@@ -1236,6 +1435,58 @@ module Aws::CustomerProfiles
|
|
|
1236
1435
|
req.send_request(options)
|
|
1237
1436
|
end
|
|
1238
1437
|
|
|
1438
|
+
# Lists all of the Identity Resolution Jobs in your domain. The response
|
|
1439
|
+
# sorts the list by `JobStartTime`.
|
|
1440
|
+
#
|
|
1441
|
+
# @option params [required, String] :domain_name
|
|
1442
|
+
# The unique name of the domain.
|
|
1443
|
+
#
|
|
1444
|
+
# @option params [String] :next_token
|
|
1445
|
+
# The token for the next set of results. Use the value returned in the
|
|
1446
|
+
# previous response in the next request to retrieve the next set of
|
|
1447
|
+
# results.
|
|
1448
|
+
#
|
|
1449
|
+
# @option params [Integer] :max_results
|
|
1450
|
+
# The maximum number of results to return per page.
|
|
1451
|
+
#
|
|
1452
|
+
# @return [Types::ListIdentityResolutionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1453
|
+
#
|
|
1454
|
+
# * {Types::ListIdentityResolutionJobsResponse#identity_resolution_jobs_list #identity_resolution_jobs_list} => Array<Types::IdentityResolutionJob>
|
|
1455
|
+
# * {Types::ListIdentityResolutionJobsResponse#next_token #next_token} => String
|
|
1456
|
+
#
|
|
1457
|
+
# @example Request syntax with placeholder values
|
|
1458
|
+
#
|
|
1459
|
+
# resp = client.list_identity_resolution_jobs({
|
|
1460
|
+
# domain_name: "name", # required
|
|
1461
|
+
# next_token: "token",
|
|
1462
|
+
# max_results: 1,
|
|
1463
|
+
# })
|
|
1464
|
+
#
|
|
1465
|
+
# @example Response structure
|
|
1466
|
+
#
|
|
1467
|
+
# resp.identity_resolution_jobs_list #=> Array
|
|
1468
|
+
# resp.identity_resolution_jobs_list[0].domain_name #=> String
|
|
1469
|
+
# resp.identity_resolution_jobs_list[0].job_id #=> String
|
|
1470
|
+
# resp.identity_resolution_jobs_list[0].status #=> String, one of "PENDING", "PREPROCESSING", "FIND_MATCHING", "MERGING", "COMPLETED", "PARTIAL_SUCCESS", "FAILED"
|
|
1471
|
+
# resp.identity_resolution_jobs_list[0].job_start_time #=> Time
|
|
1472
|
+
# resp.identity_resolution_jobs_list[0].job_end_time #=> Time
|
|
1473
|
+
# resp.identity_resolution_jobs_list[0].job_stats.number_of_profiles_reviewed #=> Integer
|
|
1474
|
+
# resp.identity_resolution_jobs_list[0].job_stats.number_of_matches_found #=> Integer
|
|
1475
|
+
# resp.identity_resolution_jobs_list[0].job_stats.number_of_merges_done #=> Integer
|
|
1476
|
+
# resp.identity_resolution_jobs_list[0].exporting_location.s3_exporting.s3_bucket_name #=> String
|
|
1477
|
+
# resp.identity_resolution_jobs_list[0].exporting_location.s3_exporting.s3_key_name #=> String
|
|
1478
|
+
# resp.identity_resolution_jobs_list[0].message #=> String
|
|
1479
|
+
# resp.next_token #=> String
|
|
1480
|
+
#
|
|
1481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIdentityResolutionJobs AWS API Documentation
|
|
1482
|
+
#
|
|
1483
|
+
# @overload list_identity_resolution_jobs(params = {})
|
|
1484
|
+
# @param [Hash] params ({})
|
|
1485
|
+
def list_identity_resolution_jobs(params = {}, options = {})
|
|
1486
|
+
req = build_request(:list_identity_resolution_jobs, params)
|
|
1487
|
+
req.send_request(options)
|
|
1488
|
+
end
|
|
1489
|
+
|
|
1239
1490
|
# Lists all of the integrations in your domain.
|
|
1240
1491
|
#
|
|
1241
1492
|
# @option params [required, String] :domain_name
|
|
@@ -1757,6 +2008,10 @@ module Aws::CustomerProfiles
|
|
|
1757
2008
|
# profile. If it is set to `TRUE`, and if no match is found, then the
|
|
1758
2009
|
# service creates a new standard profile.
|
|
1759
2010
|
#
|
|
2011
|
+
# @option params [String] :source_last_updated_timestamp_format
|
|
2012
|
+
# The format of your `sourceLastUpdatedTimestamp` that was previously
|
|
2013
|
+
# set up.
|
|
2014
|
+
#
|
|
1760
2015
|
# @option params [Hash<String,Types::ObjectTypeField>] :fields
|
|
1761
2016
|
# A map of the name and ObjectType field.
|
|
1762
2017
|
#
|
|
@@ -1774,6 +2029,7 @@ module Aws::CustomerProfiles
|
|
|
1774
2029
|
# * {Types::PutProfileObjectTypeResponse#expiration_days #expiration_days} => Integer
|
|
1775
2030
|
# * {Types::PutProfileObjectTypeResponse#encryption_key #encryption_key} => String
|
|
1776
2031
|
# * {Types::PutProfileObjectTypeResponse#allow_profile_creation #allow_profile_creation} => Boolean
|
|
2032
|
+
# * {Types::PutProfileObjectTypeResponse#source_last_updated_timestamp_format #source_last_updated_timestamp_format} => String
|
|
1777
2033
|
# * {Types::PutProfileObjectTypeResponse#fields #fields} => Hash<String,Types::ObjectTypeField>
|
|
1778
2034
|
# * {Types::PutProfileObjectTypeResponse#keys #keys} => Hash<String,Array<Types::ObjectTypeKey>>
|
|
1779
2035
|
# * {Types::PutProfileObjectTypeResponse#created_at #created_at} => Time
|
|
@@ -1790,6 +2046,7 @@ module Aws::CustomerProfiles
|
|
|
1790
2046
|
# expiration_days: 1,
|
|
1791
2047
|
# encryption_key: "encryptionKey",
|
|
1792
2048
|
# allow_profile_creation: false,
|
|
2049
|
+
# source_last_updated_timestamp_format: "string1To255",
|
|
1793
2050
|
# fields: {
|
|
1794
2051
|
# "name" => {
|
|
1795
2052
|
# source: "text",
|
|
@@ -1818,6 +2075,7 @@ module Aws::CustomerProfiles
|
|
|
1818
2075
|
# resp.expiration_days #=> Integer
|
|
1819
2076
|
# resp.encryption_key #=> String
|
|
1820
2077
|
# resp.allow_profile_creation #=> Boolean
|
|
2078
|
+
# resp.source_last_updated_timestamp_format #=> String
|
|
1821
2079
|
# resp.fields #=> Hash
|
|
1822
2080
|
# resp.fields["name"].source #=> String
|
|
1823
2081
|
# resp.fields["name"].target #=> String
|
|
@@ -2032,10 +2290,15 @@ module Aws::CustomerProfiles
|
|
|
2032
2290
|
# Use this API or [CreateDomain][1] to enable [identity resolution][2]\:
|
|
2033
2291
|
# set `Matching` to true.
|
|
2034
2292
|
#
|
|
2293
|
+
# To prevent cross-service impersonation when you call this API, see
|
|
2294
|
+
# [Cross-service confused deputy prevention][3] for sample policies that
|
|
2295
|
+
# you should apply.
|
|
2296
|
+
#
|
|
2035
2297
|
#
|
|
2036
2298
|
#
|
|
2037
2299
|
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html
|
|
2038
2300
|
# [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
|
2301
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html
|
|
2039
2302
|
#
|
|
2040
2303
|
# @option params [required, String] :domain_name
|
|
2041
2304
|
# The unique name of the domain.
|
|
@@ -2058,11 +2321,16 @@ module Aws::CustomerProfiles
|
|
|
2058
2321
|
# to the DeadLetterQueue.
|
|
2059
2322
|
#
|
|
2060
2323
|
# @option params [Types::MatchingRequest] :matching
|
|
2061
|
-
# The process of matching duplicate profiles. If Matching = true
|
|
2062
|
-
# Connect Customer Profiles starts a weekly batch process
|
|
2063
|
-
#
|
|
2064
|
-
#
|
|
2065
|
-
#
|
|
2324
|
+
# The process of matching duplicate profiles. If `Matching` = `true`,
|
|
2325
|
+
# Amazon Connect Customer Profiles starts a weekly batch process called
|
|
2326
|
+
# Identity Resolution Job. If you do not specify a date and time for
|
|
2327
|
+
# Identity Resolution Job to run, by default it runs every Saturday at
|
|
2328
|
+
# 12AM UTC to detect duplicate profiles in your domains.
|
|
2329
|
+
#
|
|
2330
|
+
# After the Identity Resolution Job completes, use the [GetMatches][1]
|
|
2331
|
+
# API to return and review the results. Or, if you have configured
|
|
2332
|
+
# `ExportingConfig` in the `MatchingRequest`, you can download the
|
|
2333
|
+
# results from S3.
|
|
2066
2334
|
#
|
|
2067
2335
|
#
|
|
2068
2336
|
#
|
|
@@ -2091,6 +2359,28 @@ module Aws::CustomerProfiles
|
|
|
2091
2359
|
# dead_letter_queue_url: "sqsQueueUrl",
|
|
2092
2360
|
# matching: {
|
|
2093
2361
|
# enabled: false, # required
|
|
2362
|
+
# job_schedule: {
|
|
2363
|
+
# day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
|
2364
|
+
# time: "JobScheduleTime", # required
|
|
2365
|
+
# },
|
|
2366
|
+
# auto_merging: {
|
|
2367
|
+
# enabled: false, # required
|
|
2368
|
+
# consolidation: {
|
|
2369
|
+
# matching_attributes_list: [ # required
|
|
2370
|
+
# ["string1To255"],
|
|
2371
|
+
# ],
|
|
2372
|
+
# },
|
|
2373
|
+
# conflict_resolution: {
|
|
2374
|
+
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
|
2375
|
+
# source_name: "string1To255",
|
|
2376
|
+
# },
|
|
2377
|
+
# },
|
|
2378
|
+
# exporting_config: {
|
|
2379
|
+
# s3_exporting: {
|
|
2380
|
+
# s3_bucket_name: "s3BucketName", # required
|
|
2381
|
+
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
|
2382
|
+
# },
|
|
2383
|
+
# },
|
|
2094
2384
|
# },
|
|
2095
2385
|
# tags: {
|
|
2096
2386
|
# "TagKey" => "TagValue",
|
|
@@ -2104,6 +2394,16 @@ module Aws::CustomerProfiles
|
|
|
2104
2394
|
# resp.default_encryption_key #=> String
|
|
2105
2395
|
# resp.dead_letter_queue_url #=> String
|
|
2106
2396
|
# resp.matching.enabled #=> Boolean
|
|
2397
|
+
# resp.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
|
2398
|
+
# resp.matching.job_schedule.time #=> String
|
|
2399
|
+
# resp.matching.auto_merging.enabled #=> Boolean
|
|
2400
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
|
|
2401
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
|
|
2402
|
+
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
|
2403
|
+
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
|
2404
|
+
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
|
2405
|
+
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
|
2406
|
+
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
|
2107
2407
|
# resp.created_at #=> Time
|
|
2108
2408
|
# resp.last_updated_at #=> Time
|
|
2109
2409
|
# resp.tags #=> Hash
|
|
@@ -2301,7 +2601,7 @@ module Aws::CustomerProfiles
|
|
|
2301
2601
|
params: params,
|
|
2302
2602
|
config: config)
|
|
2303
2603
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
|
2304
|
-
context[:gem_version] = '1.
|
|
2604
|
+
context[:gem_version] = '1.14.0'
|
|
2305
2605
|
Seahorse::Client::Request.new(handlers, context)
|
|
2306
2606
|
end
|
|
2307
2607
|
|