aws-sdk-customerprofiles 1.6.0 → 1.10.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.rb +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +269 -16
- data/lib/aws-sdk-customerprofiles/client_api.rb +112 -0
- data/lib/aws-sdk-customerprofiles/types.rb +475 -23
- metadata +5 -6
@@ -17,6 +17,7 @@ module Aws::CustomerProfiles
|
|
17
17
|
AddProfileKeyRequest = Shapes::StructureShape.new(name: 'AddProfileKeyRequest')
|
18
18
|
AddProfileKeyResponse = Shapes::StructureShape.new(name: 'AddProfileKeyResponse')
|
19
19
|
Address = Shapes::StructureShape.new(name: 'Address')
|
20
|
+
AttributeSourceIdMap = Shapes::MapShape.new(name: 'AttributeSourceIdMap')
|
20
21
|
Attributes = Shapes::MapShape.new(name: 'Attributes')
|
21
22
|
BadRequestException = Shapes::StructureShape.new(name: 'BadRequestException')
|
22
23
|
BucketName = Shapes::StringShape.new(name: 'BucketName')
|
@@ -48,6 +49,7 @@ module Aws::CustomerProfiles
|
|
48
49
|
FieldContentType = Shapes::StringShape.new(name: 'FieldContentType')
|
49
50
|
FieldMap = Shapes::MapShape.new(name: 'FieldMap')
|
50
51
|
FieldNameList = Shapes::ListShape.new(name: 'FieldNameList')
|
52
|
+
FieldSourceProfileIds = Shapes::StructureShape.new(name: 'FieldSourceProfileIds')
|
51
53
|
FlowDefinition = Shapes::StructureShape.new(name: 'FlowDefinition')
|
52
54
|
FlowDescription = Shapes::StringShape.new(name: 'FlowDescription')
|
53
55
|
FlowName = Shapes::StringShape.new(name: 'FlowName')
|
@@ -56,6 +58,8 @@ module Aws::CustomerProfiles
|
|
56
58
|
GetDomainResponse = Shapes::StructureShape.new(name: 'GetDomainResponse')
|
57
59
|
GetIntegrationRequest = Shapes::StructureShape.new(name: 'GetIntegrationRequest')
|
58
60
|
GetIntegrationResponse = Shapes::StructureShape.new(name: 'GetIntegrationResponse')
|
61
|
+
GetMatchesRequest = Shapes::StructureShape.new(name: 'GetMatchesRequest')
|
62
|
+
GetMatchesResponse = Shapes::StructureShape.new(name: 'GetMatchesResponse')
|
59
63
|
GetProfileObjectTypeRequest = Shapes::StructureShape.new(name: 'GetProfileObjectTypeRequest')
|
60
64
|
GetProfileObjectTypeResponse = Shapes::StructureShape.new(name: 'GetProfileObjectTypeResponse')
|
61
65
|
GetProfileObjectTypeTemplateRequest = Shapes::StructureShape.new(name: 'GetProfileObjectTypeTemplateRequest')
|
@@ -86,13 +90,22 @@ module Aws::CustomerProfiles
|
|
86
90
|
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
87
91
|
MarketoConnectorOperator = Shapes::StringShape.new(name: 'MarketoConnectorOperator')
|
88
92
|
MarketoSourceProperties = Shapes::StructureShape.new(name: 'MarketoSourceProperties')
|
93
|
+
MatchItem = Shapes::StructureShape.new(name: 'MatchItem')
|
94
|
+
MatchesList = Shapes::ListShape.new(name: 'MatchesList')
|
95
|
+
MatchingRequest = Shapes::StructureShape.new(name: 'MatchingRequest')
|
96
|
+
MatchingResponse = Shapes::StructureShape.new(name: 'MatchingResponse')
|
97
|
+
MergeProfilesRequest = Shapes::StructureShape.new(name: 'MergeProfilesRequest')
|
98
|
+
MergeProfilesResponse = Shapes::StructureShape.new(name: 'MergeProfilesResponse')
|
89
99
|
Object = Shapes::StringShape.new(name: 'Object')
|
100
|
+
ObjectFilter = Shapes::StructureShape.new(name: 'ObjectFilter')
|
90
101
|
ObjectTypeField = Shapes::StructureShape.new(name: 'ObjectTypeField')
|
91
102
|
ObjectTypeKey = Shapes::StructureShape.new(name: 'ObjectTypeKey')
|
92
103
|
ObjectTypeKeyList = Shapes::ListShape.new(name: 'ObjectTypeKeyList')
|
93
104
|
OperatorPropertiesKeys = Shapes::StringShape.new(name: 'OperatorPropertiesKeys')
|
94
105
|
PartyType = Shapes::StringShape.new(name: 'PartyType')
|
95
106
|
Profile = Shapes::StructureShape.new(name: 'Profile')
|
107
|
+
ProfileIdList = Shapes::ListShape.new(name: 'ProfileIdList')
|
108
|
+
ProfileIdToBeMergedList = Shapes::ListShape.new(name: 'ProfileIdToBeMergedList')
|
96
109
|
ProfileList = Shapes::ListShape.new(name: 'ProfileList')
|
97
110
|
ProfileObjectList = Shapes::ListShape.new(name: 'ProfileObjectList')
|
98
111
|
ProfileObjectTypeList = Shapes::ListShape.new(name: 'ProfileObjectTypeList')
|
@@ -152,9 +165,11 @@ module Aws::CustomerProfiles
|
|
152
165
|
encryptionKey = Shapes::StringShape.new(name: 'encryptionKey')
|
153
166
|
expirationDaysInteger = Shapes::IntegerShape.new(name: 'expirationDaysInteger')
|
154
167
|
long = Shapes::IntegerShape.new(name: 'long')
|
168
|
+
matchesNumber = Shapes::IntegerShape.new(name: 'matchesNumber')
|
155
169
|
maxSize100 = Shapes::IntegerShape.new(name: 'maxSize100')
|
156
170
|
message = Shapes::StringShape.new(name: 'message')
|
157
171
|
name = Shapes::StringShape.new(name: 'name')
|
172
|
+
optionalBoolean = Shapes::BooleanShape.new(name: 'optionalBoolean')
|
158
173
|
requestValueList = Shapes::ListShape.new(name: 'requestValueList')
|
159
174
|
sqsQueueUrl = Shapes::StringShape.new(name: 'sqsQueueUrl')
|
160
175
|
string0To1000 = Shapes::StringShape.new(name: 'string0To1000')
|
@@ -194,6 +209,9 @@ module Aws::CustomerProfiles
|
|
194
209
|
Address.add_member(:postal_code, Shapes::ShapeRef.new(shape: string1To255, location_name: "PostalCode"))
|
195
210
|
Address.struct_class = Types::Address
|
196
211
|
|
212
|
+
AttributeSourceIdMap.key = Shapes::ShapeRef.new(shape: string1To255)
|
213
|
+
AttributeSourceIdMap.value = Shapes::ShapeRef.new(shape: uuid)
|
214
|
+
|
197
215
|
Attributes.key = Shapes::ShapeRef.new(shape: string1To255)
|
198
216
|
Attributes.value = Shapes::ShapeRef.new(shape: string1To255)
|
199
217
|
|
@@ -211,6 +229,7 @@ module Aws::CustomerProfiles
|
|
211
229
|
CreateDomainRequest.add_member(:default_expiration_days, Shapes::ShapeRef.new(shape: expirationDaysInteger, required: true, location_name: "DefaultExpirationDays"))
|
212
230
|
CreateDomainRequest.add_member(:default_encryption_key, Shapes::ShapeRef.new(shape: encryptionKey, location_name: "DefaultEncryptionKey"))
|
213
231
|
CreateDomainRequest.add_member(:dead_letter_queue_url, Shapes::ShapeRef.new(shape: sqsQueueUrl, location_name: "DeadLetterQueueUrl"))
|
232
|
+
CreateDomainRequest.add_member(:matching, Shapes::ShapeRef.new(shape: MatchingRequest, location_name: "Matching"))
|
214
233
|
CreateDomainRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
215
234
|
CreateDomainRequest.struct_class = Types::CreateDomainRequest
|
216
235
|
|
@@ -218,6 +237,7 @@ module Aws::CustomerProfiles
|
|
218
237
|
CreateDomainResponse.add_member(:default_expiration_days, Shapes::ShapeRef.new(shape: expirationDaysInteger, required: true, location_name: "DefaultExpirationDays"))
|
219
238
|
CreateDomainResponse.add_member(:default_encryption_key, Shapes::ShapeRef.new(shape: encryptionKey, location_name: "DefaultEncryptionKey"))
|
220
239
|
CreateDomainResponse.add_member(:dead_letter_queue_url, Shapes::ShapeRef.new(shape: sqsQueueUrl, location_name: "DeadLetterQueueUrl"))
|
240
|
+
CreateDomainResponse.add_member(:matching, Shapes::ShapeRef.new(shape: MatchingResponse, location_name: "Matching"))
|
221
241
|
CreateDomainResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: timestamp, required: true, location_name: "CreatedAt"))
|
222
242
|
CreateDomainResponse.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: timestamp, required: true, location_name: "LastUpdatedAt"))
|
223
243
|
CreateDomainResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
@@ -308,6 +328,29 @@ module Aws::CustomerProfiles
|
|
308
328
|
|
309
329
|
FieldNameList.member = Shapes::ShapeRef.new(shape: name)
|
310
330
|
|
331
|
+
FieldSourceProfileIds.add_member(:account_number, Shapes::ShapeRef.new(shape: uuid, location_name: "AccountNumber"))
|
332
|
+
FieldSourceProfileIds.add_member(:additional_information, Shapes::ShapeRef.new(shape: uuid, location_name: "AdditionalInformation"))
|
333
|
+
FieldSourceProfileIds.add_member(:party_type, Shapes::ShapeRef.new(shape: uuid, location_name: "PartyType"))
|
334
|
+
FieldSourceProfileIds.add_member(:business_name, Shapes::ShapeRef.new(shape: uuid, location_name: "BusinessName"))
|
335
|
+
FieldSourceProfileIds.add_member(:first_name, Shapes::ShapeRef.new(shape: uuid, location_name: "FirstName"))
|
336
|
+
FieldSourceProfileIds.add_member(:middle_name, Shapes::ShapeRef.new(shape: uuid, location_name: "MiddleName"))
|
337
|
+
FieldSourceProfileIds.add_member(:last_name, Shapes::ShapeRef.new(shape: uuid, location_name: "LastName"))
|
338
|
+
FieldSourceProfileIds.add_member(:birth_date, Shapes::ShapeRef.new(shape: uuid, location_name: "BirthDate"))
|
339
|
+
FieldSourceProfileIds.add_member(:gender, Shapes::ShapeRef.new(shape: uuid, location_name: "Gender"))
|
340
|
+
FieldSourceProfileIds.add_member(:phone_number, Shapes::ShapeRef.new(shape: uuid, location_name: "PhoneNumber"))
|
341
|
+
FieldSourceProfileIds.add_member(:mobile_phone_number, Shapes::ShapeRef.new(shape: uuid, location_name: "MobilePhoneNumber"))
|
342
|
+
FieldSourceProfileIds.add_member(:home_phone_number, Shapes::ShapeRef.new(shape: uuid, location_name: "HomePhoneNumber"))
|
343
|
+
FieldSourceProfileIds.add_member(:business_phone_number, Shapes::ShapeRef.new(shape: uuid, location_name: "BusinessPhoneNumber"))
|
344
|
+
FieldSourceProfileIds.add_member(:email_address, Shapes::ShapeRef.new(shape: uuid, location_name: "EmailAddress"))
|
345
|
+
FieldSourceProfileIds.add_member(:personal_email_address, Shapes::ShapeRef.new(shape: uuid, location_name: "PersonalEmailAddress"))
|
346
|
+
FieldSourceProfileIds.add_member(:business_email_address, Shapes::ShapeRef.new(shape: uuid, location_name: "BusinessEmailAddress"))
|
347
|
+
FieldSourceProfileIds.add_member(:address, Shapes::ShapeRef.new(shape: uuid, location_name: "Address"))
|
348
|
+
FieldSourceProfileIds.add_member(:shipping_address, Shapes::ShapeRef.new(shape: uuid, location_name: "ShippingAddress"))
|
349
|
+
FieldSourceProfileIds.add_member(:mailing_address, Shapes::ShapeRef.new(shape: uuid, location_name: "MailingAddress"))
|
350
|
+
FieldSourceProfileIds.add_member(:billing_address, Shapes::ShapeRef.new(shape: uuid, location_name: "BillingAddress"))
|
351
|
+
FieldSourceProfileIds.add_member(:attributes, Shapes::ShapeRef.new(shape: AttributeSourceIdMap, location_name: "Attributes"))
|
352
|
+
FieldSourceProfileIds.struct_class = Types::FieldSourceProfileIds
|
353
|
+
|
311
354
|
FlowDefinition.add_member(:description, Shapes::ShapeRef.new(shape: FlowDescription, location_name: "Description"))
|
312
355
|
FlowDefinition.add_member(:flow_name, Shapes::ShapeRef.new(shape: FlowName, required: true, location_name: "FlowName"))
|
313
356
|
FlowDefinition.add_member(:kms_arn, Shapes::ShapeRef.new(shape: KmsArn, required: true, location_name: "KmsArn"))
|
@@ -324,6 +367,7 @@ module Aws::CustomerProfiles
|
|
324
367
|
GetDomainResponse.add_member(:default_encryption_key, Shapes::ShapeRef.new(shape: encryptionKey, location_name: "DefaultEncryptionKey"))
|
325
368
|
GetDomainResponse.add_member(:dead_letter_queue_url, Shapes::ShapeRef.new(shape: sqsQueueUrl, location_name: "DeadLetterQueueUrl"))
|
326
369
|
GetDomainResponse.add_member(:stats, Shapes::ShapeRef.new(shape: DomainStats, location_name: "Stats"))
|
370
|
+
GetDomainResponse.add_member(:matching, Shapes::ShapeRef.new(shape: MatchingResponse, location_name: "Matching"))
|
327
371
|
GetDomainResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: timestamp, required: true, location_name: "CreatedAt"))
|
328
372
|
GetDomainResponse.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: timestamp, required: true, location_name: "LastUpdatedAt"))
|
329
373
|
GetDomainResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
@@ -341,6 +385,17 @@ module Aws::CustomerProfiles
|
|
341
385
|
GetIntegrationResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
342
386
|
GetIntegrationResponse.struct_class = Types::GetIntegrationResponse
|
343
387
|
|
388
|
+
GetMatchesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: token, location: "querystring", location_name: "next-token"))
|
389
|
+
GetMatchesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: maxSize100, location: "querystring", location_name: "max-results"))
|
390
|
+
GetMatchesRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
|
391
|
+
GetMatchesRequest.struct_class = Types::GetMatchesRequest
|
392
|
+
|
393
|
+
GetMatchesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: token, location_name: "NextToken"))
|
394
|
+
GetMatchesResponse.add_member(:match_generation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "MatchGenerationDate"))
|
395
|
+
GetMatchesResponse.add_member(:potential_matches, Shapes::ShapeRef.new(shape: matchesNumber, location_name: "PotentialMatches"))
|
396
|
+
GetMatchesResponse.add_member(:matches, Shapes::ShapeRef.new(shape: MatchesList, location_name: "Matches"))
|
397
|
+
GetMatchesResponse.struct_class = Types::GetMatchesResponse
|
398
|
+
|
344
399
|
GetProfileObjectTypeRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
|
345
400
|
GetProfileObjectTypeRequest.add_member(:object_type_name, Shapes::ShapeRef.new(shape: typeName, required: true, location: "uri", location_name: "ObjectTypeName"))
|
346
401
|
GetProfileObjectTypeRequest.struct_class = Types::GetProfileObjectTypeRequest
|
@@ -459,6 +514,7 @@ module Aws::CustomerProfiles
|
|
459
514
|
ListProfileObjectsRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
|
460
515
|
ListProfileObjectsRequest.add_member(:object_type_name, Shapes::ShapeRef.new(shape: typeName, required: true, location_name: "ObjectTypeName"))
|
461
516
|
ListProfileObjectsRequest.add_member(:profile_id, Shapes::ShapeRef.new(shape: uuid, required: true, location_name: "ProfileId"))
|
517
|
+
ListProfileObjectsRequest.add_member(:object_filter, Shapes::ShapeRef.new(shape: ObjectFilter, location_name: "ObjectFilter"))
|
462
518
|
ListProfileObjectsRequest.struct_class = Types::ListProfileObjectsRequest
|
463
519
|
|
464
520
|
ListProfileObjectsResponse.add_member(:items, Shapes::ShapeRef.new(shape: ProfileObjectList, location_name: "Items"))
|
@@ -474,6 +530,31 @@ module Aws::CustomerProfiles
|
|
474
530
|
MarketoSourceProperties.add_member(:object, Shapes::ShapeRef.new(shape: Object, required: true, location_name: "Object"))
|
475
531
|
MarketoSourceProperties.struct_class = Types::MarketoSourceProperties
|
476
532
|
|
533
|
+
MatchItem.add_member(:match_id, Shapes::ShapeRef.new(shape: string1To255, location_name: "MatchId"))
|
534
|
+
MatchItem.add_member(:profile_ids, Shapes::ShapeRef.new(shape: ProfileIdList, location_name: "ProfileIds"))
|
535
|
+
MatchItem.struct_class = Types::MatchItem
|
536
|
+
|
537
|
+
MatchesList.member = Shapes::ShapeRef.new(shape: MatchItem)
|
538
|
+
|
539
|
+
MatchingRequest.add_member(:enabled, Shapes::ShapeRef.new(shape: optionalBoolean, required: true, location_name: "Enabled"))
|
540
|
+
MatchingRequest.struct_class = Types::MatchingRequest
|
541
|
+
|
542
|
+
MatchingResponse.add_member(:enabled, Shapes::ShapeRef.new(shape: optionalBoolean, location_name: "Enabled"))
|
543
|
+
MatchingResponse.struct_class = Types::MatchingResponse
|
544
|
+
|
545
|
+
MergeProfilesRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
|
546
|
+
MergeProfilesRequest.add_member(:main_profile_id, Shapes::ShapeRef.new(shape: uuid, required: true, location_name: "MainProfileId"))
|
547
|
+
MergeProfilesRequest.add_member(:profile_ids_to_be_merged, Shapes::ShapeRef.new(shape: ProfileIdToBeMergedList, required: true, location_name: "ProfileIdsToBeMerged"))
|
548
|
+
MergeProfilesRequest.add_member(:field_source_profile_ids, Shapes::ShapeRef.new(shape: FieldSourceProfileIds, location_name: "FieldSourceProfileIds"))
|
549
|
+
MergeProfilesRequest.struct_class = Types::MergeProfilesRequest
|
550
|
+
|
551
|
+
MergeProfilesResponse.add_member(:message, Shapes::ShapeRef.new(shape: message, location_name: "Message"))
|
552
|
+
MergeProfilesResponse.struct_class = Types::MergeProfilesResponse
|
553
|
+
|
554
|
+
ObjectFilter.add_member(:key_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "KeyName"))
|
555
|
+
ObjectFilter.add_member(:values, Shapes::ShapeRef.new(shape: requestValueList, required: true, location_name: "Values"))
|
556
|
+
ObjectFilter.struct_class = Types::ObjectFilter
|
557
|
+
|
477
558
|
ObjectTypeField.add_member(:source, Shapes::ShapeRef.new(shape: text, location_name: "Source"))
|
478
559
|
ObjectTypeField.add_member(:target, Shapes::ShapeRef.new(shape: text, location_name: "Target"))
|
479
560
|
ObjectTypeField.add_member(:content_type, Shapes::ShapeRef.new(shape: FieldContentType, location_name: "ContentType"))
|
@@ -509,6 +590,10 @@ module Aws::CustomerProfiles
|
|
509
590
|
Profile.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
|
510
591
|
Profile.struct_class = Types::Profile
|
511
592
|
|
593
|
+
ProfileIdList.member = Shapes::ShapeRef.new(shape: uuid)
|
594
|
+
|
595
|
+
ProfileIdToBeMergedList.member = Shapes::ShapeRef.new(shape: uuid)
|
596
|
+
|
512
597
|
ProfileList.member = Shapes::ShapeRef.new(shape: Profile)
|
513
598
|
|
514
599
|
ProfileObjectList.member = Shapes::ShapeRef.new(shape: ListProfileObjectsItem)
|
@@ -675,6 +760,7 @@ module Aws::CustomerProfiles
|
|
675
760
|
UpdateDomainRequest.add_member(:default_expiration_days, Shapes::ShapeRef.new(shape: expirationDaysInteger, location_name: "DefaultExpirationDays"))
|
676
761
|
UpdateDomainRequest.add_member(:default_encryption_key, Shapes::ShapeRef.new(shape: encryptionKey, location_name: "DefaultEncryptionKey"))
|
677
762
|
UpdateDomainRequest.add_member(:dead_letter_queue_url, Shapes::ShapeRef.new(shape: sqsQueueUrl, location_name: "DeadLetterQueueUrl"))
|
763
|
+
UpdateDomainRequest.add_member(:matching, Shapes::ShapeRef.new(shape: MatchingRequest, location_name: "Matching"))
|
678
764
|
UpdateDomainRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
679
765
|
UpdateDomainRequest.struct_class = Types::UpdateDomainRequest
|
680
766
|
|
@@ -682,6 +768,7 @@ module Aws::CustomerProfiles
|
|
682
768
|
UpdateDomainResponse.add_member(:default_expiration_days, Shapes::ShapeRef.new(shape: expirationDaysInteger, location_name: "DefaultExpirationDays"))
|
683
769
|
UpdateDomainResponse.add_member(:default_encryption_key, Shapes::ShapeRef.new(shape: encryptionKey, location_name: "DefaultEncryptionKey"))
|
684
770
|
UpdateDomainResponse.add_member(:dead_letter_queue_url, Shapes::ShapeRef.new(shape: sqsQueueUrl, location_name: "DeadLetterQueueUrl"))
|
771
|
+
UpdateDomainResponse.add_member(:matching, Shapes::ShapeRef.new(shape: MatchingResponse, location_name: "Matching"))
|
685
772
|
UpdateDomainResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: timestamp, required: true, location_name: "CreatedAt"))
|
686
773
|
UpdateDomainResponse.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: timestamp, required: true, location_name: "LastUpdatedAt"))
|
687
774
|
UpdateDomainResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
@@ -882,6 +969,19 @@ module Aws::CustomerProfiles
|
|
882
969
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
883
970
|
end)
|
884
971
|
|
972
|
+
api.add_operation(:get_matches, Seahorse::Model::Operation.new.tap do |o|
|
973
|
+
o.name = "GetMatches"
|
974
|
+
o.http_method = "GET"
|
975
|
+
o.http_request_uri = "/domains/{DomainName}/matches"
|
976
|
+
o.input = Shapes::ShapeRef.new(shape: GetMatchesRequest)
|
977
|
+
o.output = Shapes::ShapeRef.new(shape: GetMatchesResponse)
|
978
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
979
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
980
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
981
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
982
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
983
|
+
end)
|
984
|
+
|
885
985
|
api.add_operation(:get_profile_object_type, Seahorse::Model::Operation.new.tap do |o|
|
886
986
|
o.name = "GetProfileObjectType"
|
887
987
|
o.http_method = "GET"
|
@@ -997,6 +1097,18 @@ module Aws::CustomerProfiles
|
|
997
1097
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
998
1098
|
end)
|
999
1099
|
|
1100
|
+
api.add_operation(:merge_profiles, Seahorse::Model::Operation.new.tap do |o|
|
1101
|
+
o.name = "MergeProfiles"
|
1102
|
+
o.http_method = "POST"
|
1103
|
+
o.http_request_uri = "/domains/{DomainName}/profiles/objects/merge"
|
1104
|
+
o.input = Shapes::ShapeRef.new(shape: MergeProfilesRequest)
|
1105
|
+
o.output = Shapes::ShapeRef.new(shape: MergeProfilesResponse)
|
1106
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1107
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1108
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1109
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1110
|
+
end)
|
1111
|
+
|
1000
1112
|
api.add_operation(:put_integration, Seahorse::Model::Operation.new.tap do |o|
|
1001
1113
|
o.name = "PutIntegration"
|
1002
1114
|
o.http_method = "PUT"
|
@@ -222,6 +222,9 @@ module Aws::CustomerProfiles
|
|
222
222
|
# default_expiration_days: 1, # required
|
223
223
|
# default_encryption_key: "encryptionKey",
|
224
224
|
# dead_letter_queue_url: "sqsQueueUrl",
|
225
|
+
# matching: {
|
226
|
+
# enabled: false, # required
|
227
|
+
# },
|
225
228
|
# tags: {
|
226
229
|
# "TagKey" => "TagValue",
|
227
230
|
# },
|
@@ -250,6 +253,18 @@ module Aws::CustomerProfiles
|
|
250
253
|
# messages to the DeadLetterQueue.
|
251
254
|
# @return [String]
|
252
255
|
#
|
256
|
+
# @!attribute [rw] matching
|
257
|
+
# The process of matching duplicate profiles. If Matching = true,
|
258
|
+
# Amazon Connect Customer Profiles starts a weekly batch process every
|
259
|
+
# Saturday at 12AM UTC to detect duplicate profiles in your domains.
|
260
|
+
# After that batch process completes, use the [GetMatches][1] API to
|
261
|
+
# return and review the results.
|
262
|
+
#
|
263
|
+
#
|
264
|
+
#
|
265
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
266
|
+
# @return [Types::MatchingRequest]
|
267
|
+
#
|
253
268
|
# @!attribute [rw] tags
|
254
269
|
# The tags used to organize, track, or control access for this
|
255
270
|
# resource.
|
@@ -262,6 +277,7 @@ module Aws::CustomerProfiles
|
|
262
277
|
:default_expiration_days,
|
263
278
|
:default_encryption_key,
|
264
279
|
:dead_letter_queue_url,
|
280
|
+
:matching,
|
265
281
|
:tags)
|
266
282
|
SENSITIVE = []
|
267
283
|
include Aws::Structure
|
@@ -287,6 +303,18 @@ module Aws::CustomerProfiles
|
|
287
303
|
# errors associated with ingesting data from third party applications.
|
288
304
|
# @return [String]
|
289
305
|
#
|
306
|
+
# @!attribute [rw] matching
|
307
|
+
# The process of matching duplicate profiles. If Matching = true,
|
308
|
+
# Amazon Connect Customer Profiles starts a weekly batch process every
|
309
|
+
# Saturday at 12AM UTC to detect duplicate profiles in your domains.
|
310
|
+
# After that batch process completes, use the [GetMatches][1] API to
|
311
|
+
# return and review the results.
|
312
|
+
#
|
313
|
+
#
|
314
|
+
#
|
315
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
316
|
+
# @return [Types::MatchingResponse]
|
317
|
+
#
|
290
318
|
# @!attribute [rw] created_at
|
291
319
|
# The timestamp of when the domain was created.
|
292
320
|
# @return [Time]
|
@@ -307,6 +335,7 @@ module Aws::CustomerProfiles
|
|
307
335
|
:default_expiration_days,
|
308
336
|
:default_encryption_key,
|
309
337
|
:dead_letter_queue_url,
|
338
|
+
:matching,
|
310
339
|
:created_at,
|
311
340
|
:last_updated_at,
|
312
341
|
:tags)
|
@@ -397,7 +426,7 @@ module Aws::CustomerProfiles
|
|
397
426
|
# @return [String]
|
398
427
|
#
|
399
428
|
# @!attribute [rw] additional_information
|
400
|
-
# Any additional information relevant to the customer
|
429
|
+
# Any additional information relevant to the customer’s profile.
|
401
430
|
# @return [String]
|
402
431
|
#
|
403
432
|
# @!attribute [rw] party_type
|
@@ -429,7 +458,7 @@ module Aws::CustomerProfiles
|
|
429
458
|
# @return [String]
|
430
459
|
#
|
431
460
|
# @!attribute [rw] phone_number
|
432
|
-
# The customer
|
461
|
+
# The customer’s phone number, which has not been specified as a
|
433
462
|
# mobile, home, or business number.
|
434
463
|
# @return [String]
|
435
464
|
#
|
@@ -446,7 +475,7 @@ module Aws::CustomerProfiles
|
|
446
475
|
# @return [String]
|
447
476
|
#
|
448
477
|
# @!attribute [rw] email_address
|
449
|
-
# The customer
|
478
|
+
# The customer’s email address, which has not been specified as a
|
450
479
|
# personal or business address.
|
451
480
|
# @return [String]
|
452
481
|
#
|
@@ -793,6 +822,152 @@ module Aws::CustomerProfiles
|
|
793
822
|
include Aws::Structure
|
794
823
|
end
|
795
824
|
|
825
|
+
# A duplicate customer profile that is to be merged into a main profile.
|
826
|
+
#
|
827
|
+
# @note When making an API call, you may pass FieldSourceProfileIds
|
828
|
+
# data as a hash:
|
829
|
+
#
|
830
|
+
# {
|
831
|
+
# account_number: "uuid",
|
832
|
+
# additional_information: "uuid",
|
833
|
+
# party_type: "uuid",
|
834
|
+
# business_name: "uuid",
|
835
|
+
# first_name: "uuid",
|
836
|
+
# middle_name: "uuid",
|
837
|
+
# last_name: "uuid",
|
838
|
+
# birth_date: "uuid",
|
839
|
+
# gender: "uuid",
|
840
|
+
# phone_number: "uuid",
|
841
|
+
# mobile_phone_number: "uuid",
|
842
|
+
# home_phone_number: "uuid",
|
843
|
+
# business_phone_number: "uuid",
|
844
|
+
# email_address: "uuid",
|
845
|
+
# personal_email_address: "uuid",
|
846
|
+
# business_email_address: "uuid",
|
847
|
+
# address: "uuid",
|
848
|
+
# shipping_address: "uuid",
|
849
|
+
# mailing_address: "uuid",
|
850
|
+
# billing_address: "uuid",
|
851
|
+
# attributes: {
|
852
|
+
# "string1To255" => "uuid",
|
853
|
+
# },
|
854
|
+
# }
|
855
|
+
#
|
856
|
+
# @!attribute [rw] account_number
|
857
|
+
# A unique identifier for the account number field to be merged.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @!attribute [rw] additional_information
|
861
|
+
# A unique identifier for the additional information field to be
|
862
|
+
# merged.
|
863
|
+
# @return [String]
|
864
|
+
#
|
865
|
+
# @!attribute [rw] party_type
|
866
|
+
# A unique identifier for the party type field to be merged.
|
867
|
+
# @return [String]
|
868
|
+
#
|
869
|
+
# @!attribute [rw] business_name
|
870
|
+
# A unique identifier for the business name field to be merged.
|
871
|
+
# @return [String]
|
872
|
+
#
|
873
|
+
# @!attribute [rw] first_name
|
874
|
+
# A unique identifier for the first name field to be merged.
|
875
|
+
# @return [String]
|
876
|
+
#
|
877
|
+
# @!attribute [rw] middle_name
|
878
|
+
# A unique identifier for the middle name field to be merged.
|
879
|
+
# @return [String]
|
880
|
+
#
|
881
|
+
# @!attribute [rw] last_name
|
882
|
+
# A unique identifier for the last name field to be merged.
|
883
|
+
# @return [String]
|
884
|
+
#
|
885
|
+
# @!attribute [rw] birth_date
|
886
|
+
# A unique identifier for the birthdate field to be merged.
|
887
|
+
# @return [String]
|
888
|
+
#
|
889
|
+
# @!attribute [rw] gender
|
890
|
+
# A unique identifier for the gender field to be merged.
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
# @!attribute [rw] phone_number
|
894
|
+
# A unique identifier for the phone number field to be merged.
|
895
|
+
# @return [String]
|
896
|
+
#
|
897
|
+
# @!attribute [rw] mobile_phone_number
|
898
|
+
# A unique identifier for the mobile phone number field to be merged.
|
899
|
+
# @return [String]
|
900
|
+
#
|
901
|
+
# @!attribute [rw] home_phone_number
|
902
|
+
# A unique identifier for the home phone number field to be merged.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @!attribute [rw] business_phone_number
|
906
|
+
# A unique identifier for the business phone number field to be
|
907
|
+
# merged.
|
908
|
+
# @return [String]
|
909
|
+
#
|
910
|
+
# @!attribute [rw] email_address
|
911
|
+
# A unique identifier for the email address field to be merged.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] personal_email_address
|
915
|
+
# A unique identifier for the personal email address field to be
|
916
|
+
# merged.
|
917
|
+
# @return [String]
|
918
|
+
#
|
919
|
+
# @!attribute [rw] business_email_address
|
920
|
+
# A unique identifier for the party type field to be merged.
|
921
|
+
# @return [String]
|
922
|
+
#
|
923
|
+
# @!attribute [rw] address
|
924
|
+
# A unique identifier for the party type field to be merged.
|
925
|
+
# @return [String]
|
926
|
+
#
|
927
|
+
# @!attribute [rw] shipping_address
|
928
|
+
# A unique identifier for the shipping address field to be merged.
|
929
|
+
# @return [String]
|
930
|
+
#
|
931
|
+
# @!attribute [rw] mailing_address
|
932
|
+
# A unique identifier for the mailing address field to be merged.
|
933
|
+
# @return [String]
|
934
|
+
#
|
935
|
+
# @!attribute [rw] billing_address
|
936
|
+
# A unique identifier for the billing type field to be merged.
|
937
|
+
# @return [String]
|
938
|
+
#
|
939
|
+
# @!attribute [rw] attributes
|
940
|
+
# A unique identifier for the attributes field to be merged.
|
941
|
+
# @return [Hash<String,String>]
|
942
|
+
#
|
943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FieldSourceProfileIds AWS API Documentation
|
944
|
+
#
|
945
|
+
class FieldSourceProfileIds < Struct.new(
|
946
|
+
:account_number,
|
947
|
+
:additional_information,
|
948
|
+
:party_type,
|
949
|
+
:business_name,
|
950
|
+
:first_name,
|
951
|
+
:middle_name,
|
952
|
+
:last_name,
|
953
|
+
:birth_date,
|
954
|
+
:gender,
|
955
|
+
:phone_number,
|
956
|
+
:mobile_phone_number,
|
957
|
+
:home_phone_number,
|
958
|
+
:business_phone_number,
|
959
|
+
:email_address,
|
960
|
+
:personal_email_address,
|
961
|
+
:business_email_address,
|
962
|
+
:address,
|
963
|
+
:shipping_address,
|
964
|
+
:mailing_address,
|
965
|
+
:billing_address,
|
966
|
+
:attributes)
|
967
|
+
SENSITIVE = []
|
968
|
+
include Aws::Structure
|
969
|
+
end
|
970
|
+
|
796
971
|
# The configurations that control how Customer Profiles retrieves data
|
797
972
|
# from the source, Amazon AppFlow. Customer Profiles uses this
|
798
973
|
# information to create an AppFlow flow on behalf of customers.
|
@@ -913,7 +1088,7 @@ module Aws::CustomerProfiles
|
|
913
1088
|
# }
|
914
1089
|
#
|
915
1090
|
# @!attribute [rw] domain_name
|
916
|
-
#
|
1091
|
+
# The unique name of the domain.
|
917
1092
|
# @return [String]
|
918
1093
|
#
|
919
1094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetDomainRequest AWS API Documentation
|
@@ -948,6 +1123,18 @@ module Aws::CustomerProfiles
|
|
948
1123
|
# Usage-specific statistics about the domain.
|
949
1124
|
# @return [Types::DomainStats]
|
950
1125
|
#
|
1126
|
+
# @!attribute [rw] matching
|
1127
|
+
# The process of matching duplicate profiles. If Matching = true,
|
1128
|
+
# Amazon Connect Customer Profiles starts a weekly batch process every
|
1129
|
+
# Saturday at 12AM UTC to detect duplicate profiles in your domains.
|
1130
|
+
# After that batch process completes, use the [GetMatches][1] API to
|
1131
|
+
# return and review the results.
|
1132
|
+
#
|
1133
|
+
#
|
1134
|
+
#
|
1135
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
1136
|
+
# @return [Types::MatchingResponse]
|
1137
|
+
#
|
951
1138
|
# @!attribute [rw] created_at
|
952
1139
|
# The timestamp of when the domain was created.
|
953
1140
|
# @return [Time]
|
@@ -969,6 +1156,7 @@ module Aws::CustomerProfiles
|
|
969
1156
|
:default_encryption_key,
|
970
1157
|
:dead_letter_queue_url,
|
971
1158
|
:stats,
|
1159
|
+
:matching,
|
972
1160
|
:created_at,
|
973
1161
|
:last_updated_at,
|
974
1162
|
:tags)
|
@@ -1039,6 +1227,67 @@ module Aws::CustomerProfiles
|
|
1039
1227
|
include Aws::Structure
|
1040
1228
|
end
|
1041
1229
|
|
1230
|
+
# @note When making an API call, you may pass GetMatchesRequest
|
1231
|
+
# data as a hash:
|
1232
|
+
#
|
1233
|
+
# {
|
1234
|
+
# next_token: "token",
|
1235
|
+
# max_results: 1,
|
1236
|
+
# domain_name: "name", # required
|
1237
|
+
# }
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] next_token
|
1240
|
+
# The token for the next set of results. Use the value returned in the
|
1241
|
+
# previous response in the next request to retrieve the next set of
|
1242
|
+
# results.
|
1243
|
+
# @return [String]
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] max_results
|
1246
|
+
# The maximum number of results to return per page.
|
1247
|
+
# @return [Integer]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] domain_name
|
1250
|
+
# The unique name of the domain.
|
1251
|
+
# @return [String]
|
1252
|
+
#
|
1253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetMatchesRequest AWS API Documentation
|
1254
|
+
#
|
1255
|
+
class GetMatchesRequest < Struct.new(
|
1256
|
+
:next_token,
|
1257
|
+
:max_results,
|
1258
|
+
:domain_name)
|
1259
|
+
SENSITIVE = []
|
1260
|
+
include Aws::Structure
|
1261
|
+
end
|
1262
|
+
|
1263
|
+
# @!attribute [rw] next_token
|
1264
|
+
# If there are additional results, this is the token for the next set
|
1265
|
+
# of results.
|
1266
|
+
# @return [String]
|
1267
|
+
#
|
1268
|
+
# @!attribute [rw] match_generation_date
|
1269
|
+
# The timestamp this version of Match Result generated.
|
1270
|
+
# @return [Time]
|
1271
|
+
#
|
1272
|
+
# @!attribute [rw] potential_matches
|
1273
|
+
# The number of potential matches found.
|
1274
|
+
# @return [Integer]
|
1275
|
+
#
|
1276
|
+
# @!attribute [rw] matches
|
1277
|
+
# The list of matched profiles for this instance.
|
1278
|
+
# @return [Array<Types::MatchItem>]
|
1279
|
+
#
|
1280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetMatchesResponse AWS API Documentation
|
1281
|
+
#
|
1282
|
+
class GetMatchesResponse < Struct.new(
|
1283
|
+
:next_token,
|
1284
|
+
:match_generation_date,
|
1285
|
+
:potential_matches,
|
1286
|
+
:matches)
|
1287
|
+
SENSITIVE = []
|
1288
|
+
include Aws::Structure
|
1289
|
+
end
|
1290
|
+
|
1042
1291
|
# @note When making an API call, you may pass GetProfileObjectTypeRequest
|
1043
1292
|
# data as a hash:
|
1044
1293
|
#
|
@@ -1625,6 +1874,10 @@ module Aws::CustomerProfiles
|
|
1625
1874
|
# domain_name: "name", # required
|
1626
1875
|
# object_type_name: "typeName", # required
|
1627
1876
|
# profile_id: "uuid", # required
|
1877
|
+
# object_filter: {
|
1878
|
+
# key_name: "name", # required
|
1879
|
+
# values: ["string1To255"], # required
|
1880
|
+
# },
|
1628
1881
|
# }
|
1629
1882
|
#
|
1630
1883
|
# @!attribute [rw] next_token
|
@@ -1647,6 +1900,12 @@ module Aws::CustomerProfiles
|
|
1647
1900
|
# The unique identifier of a customer profile.
|
1648
1901
|
# @return [String]
|
1649
1902
|
#
|
1903
|
+
# @!attribute [rw] object_filter
|
1904
|
+
# Applies a filter to the response to include profile objects with the
|
1905
|
+
# specified index values. This filter is only supported for
|
1906
|
+
# ObjectTypeName \_asset and \_case.
|
1907
|
+
# @return [Types::ObjectFilter]
|
1908
|
+
#
|
1650
1909
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectsRequest AWS API Documentation
|
1651
1910
|
#
|
1652
1911
|
class ListProfileObjectsRequest < Struct.new(
|
@@ -1654,7 +1913,8 @@ module Aws::CustomerProfiles
|
|
1654
1913
|
:max_results,
|
1655
1914
|
:domain_name,
|
1656
1915
|
:object_type_name,
|
1657
|
-
:profile_id
|
1916
|
+
:profile_id,
|
1917
|
+
:object_filter)
|
1658
1918
|
SENSITIVE = []
|
1659
1919
|
include Aws::Structure
|
1660
1920
|
end
|
@@ -1730,6 +1990,168 @@ module Aws::CustomerProfiles
|
|
1730
1990
|
include Aws::Structure
|
1731
1991
|
end
|
1732
1992
|
|
1993
|
+
# The Match group object.
|
1994
|
+
#
|
1995
|
+
# @!attribute [rw] match_id
|
1996
|
+
# The unique identifiers for this group of profiles that match.
|
1997
|
+
# @return [String]
|
1998
|
+
#
|
1999
|
+
# @!attribute [rw] profile_ids
|
2000
|
+
# A list of identifiers for profiles that match.
|
2001
|
+
# @return [Array<String>]
|
2002
|
+
#
|
2003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MatchItem AWS API Documentation
|
2004
|
+
#
|
2005
|
+
class MatchItem < Struct.new(
|
2006
|
+
:match_id,
|
2007
|
+
:profile_ids)
|
2008
|
+
SENSITIVE = []
|
2009
|
+
include Aws::Structure
|
2010
|
+
end
|
2011
|
+
|
2012
|
+
# The flag that enables the matching process of duplicate profiles.
|
2013
|
+
#
|
2014
|
+
# @note When making an API call, you may pass MatchingRequest
|
2015
|
+
# data as a hash:
|
2016
|
+
#
|
2017
|
+
# {
|
2018
|
+
# enabled: false, # required
|
2019
|
+
# }
|
2020
|
+
#
|
2021
|
+
# @!attribute [rw] enabled
|
2022
|
+
# The flag that enables the matching process of duplicate profiles.
|
2023
|
+
# @return [Boolean]
|
2024
|
+
#
|
2025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MatchingRequest AWS API Documentation
|
2026
|
+
#
|
2027
|
+
class MatchingRequest < Struct.new(
|
2028
|
+
:enabled)
|
2029
|
+
SENSITIVE = []
|
2030
|
+
include Aws::Structure
|
2031
|
+
end
|
2032
|
+
|
2033
|
+
# The flag that enables the matching process of duplicate profiles.
|
2034
|
+
#
|
2035
|
+
# @!attribute [rw] enabled
|
2036
|
+
# The flag that enables the matching process of duplicate profiles.
|
2037
|
+
# @return [Boolean]
|
2038
|
+
#
|
2039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MatchingResponse AWS API Documentation
|
2040
|
+
#
|
2041
|
+
class MatchingResponse < Struct.new(
|
2042
|
+
:enabled)
|
2043
|
+
SENSITIVE = []
|
2044
|
+
include Aws::Structure
|
2045
|
+
end
|
2046
|
+
|
2047
|
+
# @note When making an API call, you may pass MergeProfilesRequest
|
2048
|
+
# data as a hash:
|
2049
|
+
#
|
2050
|
+
# {
|
2051
|
+
# domain_name: "name", # required
|
2052
|
+
# main_profile_id: "uuid", # required
|
2053
|
+
# profile_ids_to_be_merged: ["uuid"], # required
|
2054
|
+
# field_source_profile_ids: {
|
2055
|
+
# account_number: "uuid",
|
2056
|
+
# additional_information: "uuid",
|
2057
|
+
# party_type: "uuid",
|
2058
|
+
# business_name: "uuid",
|
2059
|
+
# first_name: "uuid",
|
2060
|
+
# middle_name: "uuid",
|
2061
|
+
# last_name: "uuid",
|
2062
|
+
# birth_date: "uuid",
|
2063
|
+
# gender: "uuid",
|
2064
|
+
# phone_number: "uuid",
|
2065
|
+
# mobile_phone_number: "uuid",
|
2066
|
+
# home_phone_number: "uuid",
|
2067
|
+
# business_phone_number: "uuid",
|
2068
|
+
# email_address: "uuid",
|
2069
|
+
# personal_email_address: "uuid",
|
2070
|
+
# business_email_address: "uuid",
|
2071
|
+
# address: "uuid",
|
2072
|
+
# shipping_address: "uuid",
|
2073
|
+
# mailing_address: "uuid",
|
2074
|
+
# billing_address: "uuid",
|
2075
|
+
# attributes: {
|
2076
|
+
# "string1To255" => "uuid",
|
2077
|
+
# },
|
2078
|
+
# },
|
2079
|
+
# }
|
2080
|
+
#
|
2081
|
+
# @!attribute [rw] domain_name
|
2082
|
+
# The unique name of the domain.
|
2083
|
+
# @return [String]
|
2084
|
+
#
|
2085
|
+
# @!attribute [rw] main_profile_id
|
2086
|
+
# The identifier of the profile to be taken.
|
2087
|
+
# @return [String]
|
2088
|
+
#
|
2089
|
+
# @!attribute [rw] profile_ids_to_be_merged
|
2090
|
+
# The identifier of the profile to be merged into MainProfileId.
|
2091
|
+
# @return [Array<String>]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] field_source_profile_ids
|
2094
|
+
# The identifiers of the fields in the profile that has the
|
2095
|
+
# information you want to apply to the merge. For example, say you
|
2096
|
+
# want to merge EmailAddress from Profile1 into MainProfile. This
|
2097
|
+
# would be the identifier of the EmailAddress field in Profile1.
|
2098
|
+
# @return [Types::FieldSourceProfileIds]
|
2099
|
+
#
|
2100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MergeProfilesRequest AWS API Documentation
|
2101
|
+
#
|
2102
|
+
class MergeProfilesRequest < Struct.new(
|
2103
|
+
:domain_name,
|
2104
|
+
:main_profile_id,
|
2105
|
+
:profile_ids_to_be_merged,
|
2106
|
+
:field_source_profile_ids)
|
2107
|
+
SENSITIVE = []
|
2108
|
+
include Aws::Structure
|
2109
|
+
end
|
2110
|
+
|
2111
|
+
# @!attribute [rw] message
|
2112
|
+
# A message that indicates the merge request is complete.
|
2113
|
+
# @return [String]
|
2114
|
+
#
|
2115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MergeProfilesResponse AWS API Documentation
|
2116
|
+
#
|
2117
|
+
class MergeProfilesResponse < Struct.new(
|
2118
|
+
:message)
|
2119
|
+
SENSITIVE = []
|
2120
|
+
include Aws::Structure
|
2121
|
+
end
|
2122
|
+
|
2123
|
+
# The filter applied to ListProfileObjects response to include profile
|
2124
|
+
# objects with the specified index values. This filter is only supported
|
2125
|
+
# for ObjectTypeName \_asset and \_case.
|
2126
|
+
#
|
2127
|
+
# @note When making an API call, you may pass ObjectFilter
|
2128
|
+
# data as a hash:
|
2129
|
+
#
|
2130
|
+
# {
|
2131
|
+
# key_name: "name", # required
|
2132
|
+
# values: ["string1To255"], # required
|
2133
|
+
# }
|
2134
|
+
#
|
2135
|
+
# @!attribute [rw] key_name
|
2136
|
+
# A searchable identifier of a standard profile object. The predefined
|
2137
|
+
# keys you can use to search for \_asset include: \_assetId,
|
2138
|
+
# \_assetName, \_serialNumber. The predefined keys you can use to
|
2139
|
+
# search for \_case include: \_caseId.
|
2140
|
+
# @return [String]
|
2141
|
+
#
|
2142
|
+
# @!attribute [rw] values
|
2143
|
+
# A list of key values.
|
2144
|
+
# @return [Array<String>]
|
2145
|
+
#
|
2146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ObjectFilter AWS API Documentation
|
2147
|
+
#
|
2148
|
+
class ObjectFilter < Struct.new(
|
2149
|
+
:key_name,
|
2150
|
+
:values)
|
2151
|
+
SENSITIVE = []
|
2152
|
+
include Aws::Structure
|
2153
|
+
end
|
2154
|
+
|
1733
2155
|
# Represents a field in a ProfileObjectType.
|
1734
2156
|
#
|
1735
2157
|
# @note When making an API call, you may pass ObjectTypeField
|
@@ -1774,21 +2196,22 @@ module Aws::CustomerProfiles
|
|
1774
2196
|
# data as a hash:
|
1775
2197
|
#
|
1776
2198
|
# {
|
1777
|
-
# standard_identifiers: ["PROFILE"], # accepts PROFILE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
2199
|
+
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
1778
2200
|
# field_names: ["name"],
|
1779
2201
|
# }
|
1780
2202
|
#
|
1781
2203
|
# @!attribute [rw] standard_identifiers
|
1782
2204
|
# The types of keys that a ProfileObject can have. Each ProfileObject
|
1783
|
-
# can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE
|
1784
|
-
# that this key can be used to tie an object to a
|
1785
|
-
#
|
1786
|
-
#
|
1787
|
-
#
|
1788
|
-
#
|
1789
|
-
#
|
1790
|
-
# profile
|
1791
|
-
#
|
2205
|
+
# can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET
|
2206
|
+
# or CASE means that this key can be used to tie an object to a
|
2207
|
+
# PROFILE, ASSET or CASE respectively. UNIQUE means that it can be
|
2208
|
+
# used to uniquely identify an object. If a key a is marked as
|
2209
|
+
# SECONDARY, it will be used to search for profiles after all other
|
2210
|
+
# PROFILE keys have been searched. A LOOKUP\_ONLY key is only used to
|
2211
|
+
# match a profile but is not persisted to be used for searching of the
|
2212
|
+
# profile. A NEW\_ONLY key is only used if the profile does not
|
2213
|
+
# already exist before the object is ingested, otherwise it is only
|
2214
|
+
# used for matching objects to profiles.
|
1792
2215
|
# @return [Array<String>]
|
1793
2216
|
#
|
1794
2217
|
# @!attribute [rw] field_names
|
@@ -1815,7 +2238,7 @@ module Aws::CustomerProfiles
|
|
1815
2238
|
# @return [String]
|
1816
2239
|
#
|
1817
2240
|
# @!attribute [rw] additional_information
|
1818
|
-
# Any additional information relevant to the customer
|
2241
|
+
# Any additional information relevant to the customer’s profile.
|
1819
2242
|
# @return [String]
|
1820
2243
|
#
|
1821
2244
|
# @!attribute [rw] party_type
|
@@ -1864,7 +2287,7 @@ module Aws::CustomerProfiles
|
|
1864
2287
|
# @return [String]
|
1865
2288
|
#
|
1866
2289
|
# @!attribute [rw] email_address
|
1867
|
-
# The customer
|
2290
|
+
# The customer’s email address, which has not been specified as a
|
1868
2291
|
# personal or business address.
|
1869
2292
|
# @return [String]
|
1870
2293
|
#
|
@@ -2138,7 +2561,7 @@ module Aws::CustomerProfiles
|
|
2138
2561
|
# keys: {
|
2139
2562
|
# "name" => [
|
2140
2563
|
# {
|
2141
|
-
# standard_identifiers: ["PROFILE"], # accepts PROFILE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
2564
|
+
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
2142
2565
|
# field_names: ["name"],
|
2143
2566
|
# },
|
2144
2567
|
# ],
|
@@ -2925,13 +3348,16 @@ module Aws::CustomerProfiles
|
|
2925
3348
|
# default_expiration_days: 1,
|
2926
3349
|
# default_encryption_key: "encryptionKey",
|
2927
3350
|
# dead_letter_queue_url: "sqsQueueUrl",
|
3351
|
+
# matching: {
|
3352
|
+
# enabled: false, # required
|
3353
|
+
# },
|
2928
3354
|
# tags: {
|
2929
3355
|
# "TagKey" => "TagValue",
|
2930
3356
|
# },
|
2931
3357
|
# }
|
2932
3358
|
#
|
2933
3359
|
# @!attribute [rw] domain_name
|
2934
|
-
# The unique name
|
3360
|
+
# The unique name of the domain.
|
2935
3361
|
# @return [String]
|
2936
3362
|
#
|
2937
3363
|
# @!attribute [rw] default_expiration_days
|
@@ -2955,6 +3381,18 @@ module Aws::CustomerProfiles
|
|
2955
3381
|
# messages to the DeadLetterQueue.
|
2956
3382
|
# @return [String]
|
2957
3383
|
#
|
3384
|
+
# @!attribute [rw] matching
|
3385
|
+
# The process of matching duplicate profiles. If Matching = true,
|
3386
|
+
# Amazon Connect Customer Profiles starts a weekly batch process every
|
3387
|
+
# Saturday at 12AM UTC to detect duplicate profiles in your domains.
|
3388
|
+
# After that batch process completes, use the [GetMatches][1] API to
|
3389
|
+
# return and review the results.
|
3390
|
+
#
|
3391
|
+
#
|
3392
|
+
#
|
3393
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
3394
|
+
# @return [Types::MatchingRequest]
|
3395
|
+
#
|
2958
3396
|
# @!attribute [rw] tags
|
2959
3397
|
# The tags used to organize, track, or control access for this
|
2960
3398
|
# resource.
|
@@ -2967,13 +3405,14 @@ module Aws::CustomerProfiles
|
|
2967
3405
|
:default_expiration_days,
|
2968
3406
|
:default_encryption_key,
|
2969
3407
|
:dead_letter_queue_url,
|
3408
|
+
:matching,
|
2970
3409
|
:tags)
|
2971
3410
|
SENSITIVE = []
|
2972
3411
|
include Aws::Structure
|
2973
3412
|
end
|
2974
3413
|
|
2975
3414
|
# @!attribute [rw] domain_name
|
2976
|
-
# The unique name
|
3415
|
+
# The unique name of the domain.
|
2977
3416
|
# @return [String]
|
2978
3417
|
#
|
2979
3418
|
# @!attribute [rw] default_expiration_days
|
@@ -2992,6 +3431,18 @@ module Aws::CustomerProfiles
|
|
2992
3431
|
# errors associated with ingesting data from third party applications.
|
2993
3432
|
# @return [String]
|
2994
3433
|
#
|
3434
|
+
# @!attribute [rw] matching
|
3435
|
+
# The process of matching duplicate profiles. If Matching = true,
|
3436
|
+
# Amazon Connect Customer Profiles starts a weekly batch process every
|
3437
|
+
# Saturday at 12AM UTC to detect duplicate profiles in your domains.
|
3438
|
+
# After that batch process completes, use the [GetMatches][1] API to
|
3439
|
+
# return and review the results.
|
3440
|
+
#
|
3441
|
+
#
|
3442
|
+
#
|
3443
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
|
3444
|
+
# @return [Types::MatchingResponse]
|
3445
|
+
#
|
2995
3446
|
# @!attribute [rw] created_at
|
2996
3447
|
# The timestamp of when the domain was created.
|
2997
3448
|
# @return [Time]
|
@@ -3012,6 +3463,7 @@ module Aws::CustomerProfiles
|
|
3012
3463
|
:default_expiration_days,
|
3013
3464
|
:default_encryption_key,
|
3014
3465
|
:dead_letter_queue_url,
|
3466
|
+
:matching,
|
3015
3467
|
:created_at,
|
3016
3468
|
:last_updated_at,
|
3017
3469
|
:tags)
|
@@ -3103,7 +3555,7 @@ module Aws::CustomerProfiles
|
|
3103
3555
|
# @return [String]
|
3104
3556
|
#
|
3105
3557
|
# @!attribute [rw] additional_information
|
3106
|
-
# Any additional information relevant to the customer
|
3558
|
+
# Any additional information relevant to the customer’s profile.
|
3107
3559
|
# @return [String]
|
3108
3560
|
#
|
3109
3561
|
# @!attribute [rw] account_number
|
@@ -3139,7 +3591,7 @@ module Aws::CustomerProfiles
|
|
3139
3591
|
# @return [String]
|
3140
3592
|
#
|
3141
3593
|
# @!attribute [rw] phone_number
|
3142
|
-
# The customer
|
3594
|
+
# The customer’s phone number, which has not been specified as a
|
3143
3595
|
# mobile, home, or business number.
|
3144
3596
|
# @return [String]
|
3145
3597
|
#
|
@@ -3156,7 +3608,7 @@ module Aws::CustomerProfiles
|
|
3156
3608
|
# @return [String]
|
3157
3609
|
#
|
3158
3610
|
# @!attribute [rw] email_address
|
3159
|
-
# The customer
|
3611
|
+
# The customer’s email address, which has not been specified as a
|
3160
3612
|
# personal or business address.
|
3161
3613
|
# @return [String]
|
3162
3614
|
#
|