aws-sdk-customerprofiles 1.23.0 → 1.25.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +65 -3
- data/lib/aws-sdk-customerprofiles/client_api.rb +24 -0
- data/lib/aws-sdk-customerprofiles/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-customerprofiles/endpoint_provider.rb +73 -74
- data/lib/aws-sdk-customerprofiles/types.rb +137 -1317
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- metadata +2 -2
@@ -23,16 +23,6 @@ module Aws::CustomerProfiles
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
-
# @note When making an API call, you may pass AddProfileKeyRequest
|
27
|
-
# data as a hash:
|
28
|
-
#
|
29
|
-
# {
|
30
|
-
# profile_id: "uuid", # required
|
31
|
-
# key_name: "name", # required
|
32
|
-
# values: ["string1To255"], # required
|
33
|
-
# domain_name: "name", # required
|
34
|
-
# }
|
35
|
-
#
|
36
26
|
# @!attribute [rw] profile_id
|
37
27
|
# The unique identifier of a customer profile.
|
38
28
|
# @return [String]
|
@@ -83,25 +73,36 @@ module Aws::CustomerProfiles
|
|
83
73
|
include Aws::Structure
|
84
74
|
end
|
85
75
|
|
76
|
+
# A data type pair that consists of a `KeyName` and `Values` list that
|
77
|
+
# is used in conjunction with the [KeyName][1] and [Values][2]
|
78
|
+
# parameters to search for profiles using the [SearchProfiles][3] API.
|
79
|
+
#
|
80
|
+
#
|
81
|
+
#
|
82
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName
|
83
|
+
# [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values
|
84
|
+
# [3]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
|
85
|
+
#
|
86
|
+
# @!attribute [rw] key_name
|
87
|
+
# A searchable identifier of a customer profile.
|
88
|
+
# @return [String]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] values
|
91
|
+
# A list of key values.
|
92
|
+
# @return [Array<String>]
|
93
|
+
#
|
94
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AdditionalSearchKey AWS API Documentation
|
95
|
+
#
|
96
|
+
class AdditionalSearchKey < Struct.new(
|
97
|
+
:key_name,
|
98
|
+
:values)
|
99
|
+
SENSITIVE = []
|
100
|
+
include Aws::Structure
|
101
|
+
end
|
102
|
+
|
86
103
|
# A generic address associated with the customer that is not mailing,
|
87
104
|
# shipping, or billing.
|
88
105
|
#
|
89
|
-
# @note When making an API call, you may pass Address
|
90
|
-
# data as a hash:
|
91
|
-
#
|
92
|
-
# {
|
93
|
-
# address_1: "string1To255",
|
94
|
-
# address_2: "string1To255",
|
95
|
-
# address_3: "string1To255",
|
96
|
-
# address_4: "string1To255",
|
97
|
-
# city: "string1To255",
|
98
|
-
# county: "string1To255",
|
99
|
-
# state: "string1To255",
|
100
|
-
# province: "string1To255",
|
101
|
-
# country: "string1To255",
|
102
|
-
# postal_code: "string1To255",
|
103
|
-
# }
|
104
|
-
#
|
105
106
|
# @!attribute [rw] address_1
|
106
107
|
# The first line of a customer address.
|
107
108
|
# @return [String]
|
@@ -161,81 +162,6 @@ module Aws::CustomerProfiles
|
|
161
162
|
|
162
163
|
# Details for workflow of type `APPFLOW_INTEGRATION`.
|
163
164
|
#
|
164
|
-
# @note When making an API call, you may pass AppflowIntegration
|
165
|
-
# data as a hash:
|
166
|
-
#
|
167
|
-
# {
|
168
|
-
# flow_definition: { # required
|
169
|
-
# description: "FlowDescription",
|
170
|
-
# flow_name: "FlowName", # required
|
171
|
-
# kms_arn: "KmsArn", # required
|
172
|
-
# source_flow_config: { # required
|
173
|
-
# connector_profile_name: "ConnectorProfileName",
|
174
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
175
|
-
# incremental_pull_config: {
|
176
|
-
# datetime_type_field_name: "DatetimeTypeFieldName",
|
177
|
-
# },
|
178
|
-
# source_connector_properties: { # required
|
179
|
-
# marketo: {
|
180
|
-
# object: "Object", # required
|
181
|
-
# },
|
182
|
-
# s3: {
|
183
|
-
# bucket_name: "BucketName", # required
|
184
|
-
# bucket_prefix: "BucketPrefix",
|
185
|
-
# },
|
186
|
-
# salesforce: {
|
187
|
-
# object: "Object", # required
|
188
|
-
# enable_dynamic_field_update: false,
|
189
|
-
# include_deleted_records: false,
|
190
|
-
# },
|
191
|
-
# service_now: {
|
192
|
-
# object: "Object", # required
|
193
|
-
# },
|
194
|
-
# zendesk: {
|
195
|
-
# object: "Object", # required
|
196
|
-
# },
|
197
|
-
# },
|
198
|
-
# },
|
199
|
-
# tasks: [ # required
|
200
|
-
# {
|
201
|
-
# connector_operator: {
|
202
|
-
# marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
203
|
-
# s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
204
|
-
# salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
205
|
-
# service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
206
|
-
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
207
|
-
# },
|
208
|
-
# destination_field: "DestinationField",
|
209
|
-
# source_fields: ["stringTo2048"], # required
|
210
|
-
# task_properties: {
|
211
|
-
# "VALUE" => "Property",
|
212
|
-
# },
|
213
|
-
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
214
|
-
# },
|
215
|
-
# ],
|
216
|
-
# trigger_config: { # required
|
217
|
-
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
218
|
-
# trigger_properties: {
|
219
|
-
# scheduled: {
|
220
|
-
# schedule_expression: "ScheduleExpression", # required
|
221
|
-
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
222
|
-
# schedule_start_time: Time.now,
|
223
|
-
# schedule_end_time: Time.now,
|
224
|
-
# timezone: "Timezone",
|
225
|
-
# schedule_offset: 1,
|
226
|
-
# first_execution_from: Time.now,
|
227
|
-
# },
|
228
|
-
# },
|
229
|
-
# },
|
230
|
-
# },
|
231
|
-
# batches: [
|
232
|
-
# {
|
233
|
-
# start_time: Time.now, # required
|
234
|
-
# end_time: Time.now, # required
|
235
|
-
# },
|
236
|
-
# ],
|
237
|
-
# }
|
238
|
-
#
|
239
165
|
# @!attribute [rw] flow_definition
|
240
166
|
# The configurations that control how Customer Profiles retrieves data
|
241
167
|
# from the source, Amazon AppFlow. Customer Profiles uses this
|
@@ -368,23 +294,6 @@ module Aws::CustomerProfiles
|
|
368
294
|
# Configuration settings for how to perform the auto-merging of
|
369
295
|
# profiles.
|
370
296
|
#
|
371
|
-
# @note When making an API call, you may pass AutoMerging
|
372
|
-
# data as a hash:
|
373
|
-
#
|
374
|
-
# {
|
375
|
-
# enabled: false, # required
|
376
|
-
# consolidation: {
|
377
|
-
# matching_attributes_list: [ # required
|
378
|
-
# ["string1To255"],
|
379
|
-
# ],
|
380
|
-
# },
|
381
|
-
# conflict_resolution: {
|
382
|
-
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
383
|
-
# source_name: "string1To255",
|
384
|
-
# },
|
385
|
-
# min_allowed_confidence_score_for_merging: 1.0,
|
386
|
-
# }
|
387
|
-
#
|
388
297
|
# @!attribute [rw] enabled
|
389
298
|
# The flag that enables the auto-merging of duplicate profiles.
|
390
299
|
# @return [Boolean]
|
@@ -437,14 +346,6 @@ module Aws::CustomerProfiles
|
|
437
346
|
# `APPFLOW_INTEGRATION` workflow. `APPFLOW_INTEGRATION` workflow splits
|
438
347
|
# ingestion based on these boundaries.
|
439
348
|
#
|
440
|
-
# @note When making an API call, you may pass Batch
|
441
|
-
# data as a hash:
|
442
|
-
#
|
443
|
-
# {
|
444
|
-
# start_time: Time.now, # required
|
445
|
-
# end_time: Time.now, # required
|
446
|
-
# }
|
447
|
-
#
|
448
349
|
# @!attribute [rw] start_time
|
449
350
|
# Start time of batch to split ingestion.
|
450
351
|
# @return [Time]
|
@@ -465,14 +366,6 @@ module Aws::CustomerProfiles
|
|
465
366
|
# How the auto-merging process should resolve conflicts between
|
466
367
|
# different profiles.
|
467
368
|
#
|
468
|
-
# @note When making an API call, you may pass ConflictResolution
|
469
|
-
# data as a hash:
|
470
|
-
#
|
471
|
-
# {
|
472
|
-
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
473
|
-
# source_name: "string1To255",
|
474
|
-
# }
|
475
|
-
#
|
476
369
|
# @!attribute [rw] conflict_resolving_model
|
477
370
|
# How the auto-merging process should resolve conflicts between
|
478
371
|
# different profiles.
|
@@ -501,17 +394,6 @@ module Aws::CustomerProfiles
|
|
501
394
|
|
502
395
|
# The operation to be performed on the provided source fields.
|
503
396
|
#
|
504
|
-
# @note When making an API call, you may pass ConnectorOperator
|
505
|
-
# data as a hash:
|
506
|
-
#
|
507
|
-
# {
|
508
|
-
# marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
509
|
-
# s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
510
|
-
# salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
511
|
-
# service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
512
|
-
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
513
|
-
# }
|
514
|
-
#
|
515
397
|
# @!attribute [rw] marketo
|
516
398
|
# The operation to be performed on the provided Marketo source fields.
|
517
399
|
# @return [String]
|
@@ -549,15 +431,6 @@ module Aws::CustomerProfiles
|
|
549
431
|
|
550
432
|
# The matching criteria to be used during the auto-merging process.
|
551
433
|
#
|
552
|
-
# @note When making an API call, you may pass Consolidation
|
553
|
-
# data as a hash:
|
554
|
-
#
|
555
|
-
# {
|
556
|
-
# matching_attributes_list: [ # required
|
557
|
-
# ["string1To255"],
|
558
|
-
# ],
|
559
|
-
# }
|
560
|
-
#
|
561
434
|
# @!attribute [rw] matching_attributes_list
|
562
435
|
# A list of matching criteria.
|
563
436
|
# @return [Array<Array<String>>]
|
@@ -570,45 +443,6 @@ module Aws::CustomerProfiles
|
|
570
443
|
include Aws::Structure
|
571
444
|
end
|
572
445
|
|
573
|
-
# @note When making an API call, you may pass CreateDomainRequest
|
574
|
-
# data as a hash:
|
575
|
-
#
|
576
|
-
# {
|
577
|
-
# domain_name: "name", # required
|
578
|
-
# default_expiration_days: 1, # required
|
579
|
-
# default_encryption_key: "encryptionKey",
|
580
|
-
# dead_letter_queue_url: "sqsQueueUrl",
|
581
|
-
# matching: {
|
582
|
-
# enabled: false, # required
|
583
|
-
# job_schedule: {
|
584
|
-
# day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
585
|
-
# time: "JobScheduleTime", # required
|
586
|
-
# },
|
587
|
-
# auto_merging: {
|
588
|
-
# enabled: false, # required
|
589
|
-
# consolidation: {
|
590
|
-
# matching_attributes_list: [ # required
|
591
|
-
# ["string1To255"],
|
592
|
-
# ],
|
593
|
-
# },
|
594
|
-
# conflict_resolution: {
|
595
|
-
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
596
|
-
# source_name: "string1To255",
|
597
|
-
# },
|
598
|
-
# min_allowed_confidence_score_for_merging: 1.0,
|
599
|
-
# },
|
600
|
-
# exporting_config: {
|
601
|
-
# s3_exporting: {
|
602
|
-
# s3_bucket_name: "s3BucketName", # required
|
603
|
-
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
604
|
-
# },
|
605
|
-
# },
|
606
|
-
# },
|
607
|
-
# tags: {
|
608
|
-
# "TagKey" => "TagValue",
|
609
|
-
# },
|
610
|
-
# }
|
611
|
-
#
|
612
446
|
# @!attribute [rw] domain_name
|
613
447
|
# The unique name of the domain.
|
614
448
|
# @return [String]
|
@@ -732,92 +566,6 @@ module Aws::CustomerProfiles
|
|
732
566
|
include Aws::Structure
|
733
567
|
end
|
734
568
|
|
735
|
-
# @note When making an API call, you may pass CreateIntegrationWorkflowRequest
|
736
|
-
# data as a hash:
|
737
|
-
#
|
738
|
-
# {
|
739
|
-
# domain_name: "name", # required
|
740
|
-
# workflow_type: "APPFLOW_INTEGRATION", # required, accepts APPFLOW_INTEGRATION
|
741
|
-
# integration_config: { # required
|
742
|
-
# appflow_integration: {
|
743
|
-
# flow_definition: { # required
|
744
|
-
# description: "FlowDescription",
|
745
|
-
# flow_name: "FlowName", # required
|
746
|
-
# kms_arn: "KmsArn", # required
|
747
|
-
# source_flow_config: { # required
|
748
|
-
# connector_profile_name: "ConnectorProfileName",
|
749
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
750
|
-
# incremental_pull_config: {
|
751
|
-
# datetime_type_field_name: "DatetimeTypeFieldName",
|
752
|
-
# },
|
753
|
-
# source_connector_properties: { # required
|
754
|
-
# marketo: {
|
755
|
-
# object: "Object", # required
|
756
|
-
# },
|
757
|
-
# s3: {
|
758
|
-
# bucket_name: "BucketName", # required
|
759
|
-
# bucket_prefix: "BucketPrefix",
|
760
|
-
# },
|
761
|
-
# salesforce: {
|
762
|
-
# object: "Object", # required
|
763
|
-
# enable_dynamic_field_update: false,
|
764
|
-
# include_deleted_records: false,
|
765
|
-
# },
|
766
|
-
# service_now: {
|
767
|
-
# object: "Object", # required
|
768
|
-
# },
|
769
|
-
# zendesk: {
|
770
|
-
# object: "Object", # required
|
771
|
-
# },
|
772
|
-
# },
|
773
|
-
# },
|
774
|
-
# tasks: [ # required
|
775
|
-
# {
|
776
|
-
# connector_operator: {
|
777
|
-
# marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
778
|
-
# s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
779
|
-
# salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
780
|
-
# service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
781
|
-
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
782
|
-
# },
|
783
|
-
# destination_field: "DestinationField",
|
784
|
-
# source_fields: ["stringTo2048"], # required
|
785
|
-
# task_properties: {
|
786
|
-
# "VALUE" => "Property",
|
787
|
-
# },
|
788
|
-
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
789
|
-
# },
|
790
|
-
# ],
|
791
|
-
# trigger_config: { # required
|
792
|
-
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
793
|
-
# trigger_properties: {
|
794
|
-
# scheduled: {
|
795
|
-
# schedule_expression: "ScheduleExpression", # required
|
796
|
-
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
797
|
-
# schedule_start_time: Time.now,
|
798
|
-
# schedule_end_time: Time.now,
|
799
|
-
# timezone: "Timezone",
|
800
|
-
# schedule_offset: 1,
|
801
|
-
# first_execution_from: Time.now,
|
802
|
-
# },
|
803
|
-
# },
|
804
|
-
# },
|
805
|
-
# },
|
806
|
-
# batches: [
|
807
|
-
# {
|
808
|
-
# start_time: Time.now, # required
|
809
|
-
# end_time: Time.now, # required
|
810
|
-
# },
|
811
|
-
# ],
|
812
|
-
# },
|
813
|
-
# },
|
814
|
-
# object_type_name: "typeName", # required
|
815
|
-
# role_arn: "RoleArn", # required
|
816
|
-
# tags: {
|
817
|
-
# "TagKey" => "TagValue",
|
818
|
-
# },
|
819
|
-
# }
|
820
|
-
#
|
821
569
|
# @!attribute [rw] domain_name
|
822
570
|
# The unique name of the domain.
|
823
571
|
# @return [String]
|
@@ -876,80 +624,6 @@ module Aws::CustomerProfiles
|
|
876
624
|
include Aws::Structure
|
877
625
|
end
|
878
626
|
|
879
|
-
# @note When making an API call, you may pass CreateProfileRequest
|
880
|
-
# data as a hash:
|
881
|
-
#
|
882
|
-
# {
|
883
|
-
# domain_name: "name", # required
|
884
|
-
# account_number: "string1To255",
|
885
|
-
# additional_information: "string1To1000",
|
886
|
-
# party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
|
887
|
-
# business_name: "string1To255",
|
888
|
-
# first_name: "string1To255",
|
889
|
-
# middle_name: "string1To255",
|
890
|
-
# last_name: "string1To255",
|
891
|
-
# birth_date: "string1To255",
|
892
|
-
# gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
|
893
|
-
# phone_number: "string1To255",
|
894
|
-
# mobile_phone_number: "string1To255",
|
895
|
-
# home_phone_number: "string1To255",
|
896
|
-
# business_phone_number: "string1To255",
|
897
|
-
# email_address: "string1To255",
|
898
|
-
# personal_email_address: "string1To255",
|
899
|
-
# business_email_address: "string1To255",
|
900
|
-
# address: {
|
901
|
-
# address_1: "string1To255",
|
902
|
-
# address_2: "string1To255",
|
903
|
-
# address_3: "string1To255",
|
904
|
-
# address_4: "string1To255",
|
905
|
-
# city: "string1To255",
|
906
|
-
# county: "string1To255",
|
907
|
-
# state: "string1To255",
|
908
|
-
# province: "string1To255",
|
909
|
-
# country: "string1To255",
|
910
|
-
# postal_code: "string1To255",
|
911
|
-
# },
|
912
|
-
# shipping_address: {
|
913
|
-
# address_1: "string1To255",
|
914
|
-
# address_2: "string1To255",
|
915
|
-
# address_3: "string1To255",
|
916
|
-
# address_4: "string1To255",
|
917
|
-
# city: "string1To255",
|
918
|
-
# county: "string1To255",
|
919
|
-
# state: "string1To255",
|
920
|
-
# province: "string1To255",
|
921
|
-
# country: "string1To255",
|
922
|
-
# postal_code: "string1To255",
|
923
|
-
# },
|
924
|
-
# mailing_address: {
|
925
|
-
# address_1: "string1To255",
|
926
|
-
# address_2: "string1To255",
|
927
|
-
# address_3: "string1To255",
|
928
|
-
# address_4: "string1To255",
|
929
|
-
# city: "string1To255",
|
930
|
-
# county: "string1To255",
|
931
|
-
# state: "string1To255",
|
932
|
-
# province: "string1To255",
|
933
|
-
# country: "string1To255",
|
934
|
-
# postal_code: "string1To255",
|
935
|
-
# },
|
936
|
-
# billing_address: {
|
937
|
-
# address_1: "string1To255",
|
938
|
-
# address_2: "string1To255",
|
939
|
-
# address_3: "string1To255",
|
940
|
-
# address_4: "string1To255",
|
941
|
-
# city: "string1To255",
|
942
|
-
# county: "string1To255",
|
943
|
-
# state: "string1To255",
|
944
|
-
# province: "string1To255",
|
945
|
-
# country: "string1To255",
|
946
|
-
# postal_code: "string1To255",
|
947
|
-
# },
|
948
|
-
# attributes: {
|
949
|
-
# "string1To255" => "string1To255",
|
950
|
-
# },
|
951
|
-
# }
|
952
|
-
#
|
953
627
|
# @!attribute [rw] domain_name
|
954
628
|
# The unique name of the domain.
|
955
629
|
# @return [String]
|
@@ -1041,6 +715,14 @@ module Aws::CustomerProfiles
|
|
1041
715
|
# A key value pair of attributes of a customer profile.
|
1042
716
|
# @return [Hash<String,String>]
|
1043
717
|
#
|
718
|
+
# @!attribute [rw] party_type_string
|
719
|
+
# An alternative to `PartyType` which accepts any string as input.
|
720
|
+
# @return [String]
|
721
|
+
#
|
722
|
+
# @!attribute [rw] gender_string
|
723
|
+
# An alternative to `Gender` which accepts any string as input.
|
724
|
+
# @return [String]
|
725
|
+
#
|
1044
726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateProfileRequest AWS API Documentation
|
1045
727
|
#
|
1046
728
|
class CreateProfileRequest < Struct.new(
|
@@ -1065,7 +747,9 @@ module Aws::CustomerProfiles
|
|
1065
747
|
:shipping_address,
|
1066
748
|
:mailing_address,
|
1067
749
|
:billing_address,
|
1068
|
-
:attributes
|
750
|
+
:attributes,
|
751
|
+
:party_type_string,
|
752
|
+
:gender_string)
|
1069
753
|
SENSITIVE = []
|
1070
754
|
include Aws::Structure
|
1071
755
|
end
|
@@ -1082,13 +766,6 @@ module Aws::CustomerProfiles
|
|
1082
766
|
include Aws::Structure
|
1083
767
|
end
|
1084
768
|
|
1085
|
-
# @note When making an API call, you may pass DeleteDomainRequest
|
1086
|
-
# data as a hash:
|
1087
|
-
#
|
1088
|
-
# {
|
1089
|
-
# domain_name: "name", # required
|
1090
|
-
# }
|
1091
|
-
#
|
1092
769
|
# @!attribute [rw] domain_name
|
1093
770
|
# The unique name of the domain.
|
1094
771
|
# @return [String]
|
@@ -1113,14 +790,6 @@ module Aws::CustomerProfiles
|
|
1113
790
|
include Aws::Structure
|
1114
791
|
end
|
1115
792
|
|
1116
|
-
# @note When making an API call, you may pass DeleteIntegrationRequest
|
1117
|
-
# data as a hash:
|
1118
|
-
#
|
1119
|
-
# {
|
1120
|
-
# domain_name: "name", # required
|
1121
|
-
# uri: "string1To255", # required
|
1122
|
-
# }
|
1123
|
-
#
|
1124
793
|
# @!attribute [rw] domain_name
|
1125
794
|
# The unique name of the domain.
|
1126
795
|
# @return [String]
|
@@ -1150,16 +819,6 @@ module Aws::CustomerProfiles
|
|
1150
819
|
include Aws::Structure
|
1151
820
|
end
|
1152
821
|
|
1153
|
-
# @note When making an API call, you may pass DeleteProfileKeyRequest
|
1154
|
-
# data as a hash:
|
1155
|
-
#
|
1156
|
-
# {
|
1157
|
-
# profile_id: "uuid", # required
|
1158
|
-
# key_name: "name", # required
|
1159
|
-
# values: ["string1To255"], # required
|
1160
|
-
# domain_name: "name", # required
|
1161
|
-
# }
|
1162
|
-
#
|
1163
822
|
# @!attribute [rw] profile_id
|
1164
823
|
# The unique identifier of a customer profile.
|
1165
824
|
# @return [String]
|
@@ -1199,16 +858,6 @@ module Aws::CustomerProfiles
|
|
1199
858
|
include Aws::Structure
|
1200
859
|
end
|
1201
860
|
|
1202
|
-
# @note When making an API call, you may pass DeleteProfileObjectRequest
|
1203
|
-
# data as a hash:
|
1204
|
-
#
|
1205
|
-
# {
|
1206
|
-
# profile_id: "uuid", # required
|
1207
|
-
# profile_object_unique_key: "string1To255", # required
|
1208
|
-
# object_type_name: "typeName", # required
|
1209
|
-
# domain_name: "name", # required
|
1210
|
-
# }
|
1211
|
-
#
|
1212
861
|
# @!attribute [rw] profile_id
|
1213
862
|
# The unique identifier of a customer profile.
|
1214
863
|
# @return [String]
|
@@ -1249,14 +898,6 @@ module Aws::CustomerProfiles
|
|
1249
898
|
include Aws::Structure
|
1250
899
|
end
|
1251
900
|
|
1252
|
-
# @note When making an API call, you may pass DeleteProfileObjectTypeRequest
|
1253
|
-
# data as a hash:
|
1254
|
-
#
|
1255
|
-
# {
|
1256
|
-
# domain_name: "name", # required
|
1257
|
-
# object_type_name: "typeName", # required
|
1258
|
-
# }
|
1259
|
-
#
|
1260
901
|
# @!attribute [rw] domain_name
|
1261
902
|
# The unique name of the domain.
|
1262
903
|
# @return [String]
|
@@ -1286,14 +927,6 @@ module Aws::CustomerProfiles
|
|
1286
927
|
include Aws::Structure
|
1287
928
|
end
|
1288
929
|
|
1289
|
-
# @note When making an API call, you may pass DeleteProfileRequest
|
1290
|
-
# data as a hash:
|
1291
|
-
#
|
1292
|
-
# {
|
1293
|
-
# profile_id: "uuid", # required
|
1294
|
-
# domain_name: "name", # required
|
1295
|
-
# }
|
1296
|
-
#
|
1297
930
|
# @!attribute [rw] profile_id
|
1298
931
|
# The unique identifier of a customer profile.
|
1299
932
|
# @return [String]
|
@@ -1323,14 +956,6 @@ module Aws::CustomerProfiles
|
|
1323
956
|
include Aws::Structure
|
1324
957
|
end
|
1325
958
|
|
1326
|
-
# @note When making an API call, you may pass DeleteWorkflowRequest
|
1327
|
-
# data as a hash:
|
1328
|
-
#
|
1329
|
-
# {
|
1330
|
-
# domain_name: "name", # required
|
1331
|
-
# workflow_id: "string1To255", # required
|
1332
|
-
# }
|
1333
|
-
#
|
1334
959
|
# @!attribute [rw] domain_name
|
1335
960
|
# The unique name of the domain.
|
1336
961
|
# @return [String]
|
@@ -1398,16 +1023,6 @@ module Aws::CustomerProfiles
|
|
1398
1023
|
#
|
1399
1024
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service
|
1400
1025
|
#
|
1401
|
-
# @note When making an API call, you may pass ExportingConfig
|
1402
|
-
# data as a hash:
|
1403
|
-
#
|
1404
|
-
# {
|
1405
|
-
# s3_exporting: {
|
1406
|
-
# s3_bucket_name: "s3BucketName", # required
|
1407
|
-
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
1408
|
-
# },
|
1409
|
-
# }
|
1410
|
-
#
|
1411
1026
|
# @!attribute [rw] s3_exporting
|
1412
1027
|
# The S3 location where Identity Resolution Jobs write result files.
|
1413
1028
|
# @return [Types::S3ExportingConfig]
|
@@ -1437,35 +1052,6 @@ module Aws::CustomerProfiles
|
|
1437
1052
|
|
1438
1053
|
# A duplicate customer profile that is to be merged into a main profile.
|
1439
1054
|
#
|
1440
|
-
# @note When making an API call, you may pass FieldSourceProfileIds
|
1441
|
-
# data as a hash:
|
1442
|
-
#
|
1443
|
-
# {
|
1444
|
-
# account_number: "uuid",
|
1445
|
-
# additional_information: "uuid",
|
1446
|
-
# party_type: "uuid",
|
1447
|
-
# business_name: "uuid",
|
1448
|
-
# first_name: "uuid",
|
1449
|
-
# middle_name: "uuid",
|
1450
|
-
# last_name: "uuid",
|
1451
|
-
# birth_date: "uuid",
|
1452
|
-
# gender: "uuid",
|
1453
|
-
# phone_number: "uuid",
|
1454
|
-
# mobile_phone_number: "uuid",
|
1455
|
-
# home_phone_number: "uuid",
|
1456
|
-
# business_phone_number: "uuid",
|
1457
|
-
# email_address: "uuid",
|
1458
|
-
# personal_email_address: "uuid",
|
1459
|
-
# business_email_address: "uuid",
|
1460
|
-
# address: "uuid",
|
1461
|
-
# shipping_address: "uuid",
|
1462
|
-
# mailing_address: "uuid",
|
1463
|
-
# billing_address: "uuid",
|
1464
|
-
# attributes: {
|
1465
|
-
# "string1To255" => "uuid",
|
1466
|
-
# },
|
1467
|
-
# }
|
1468
|
-
#
|
1469
1055
|
# @!attribute [rw] account_number
|
1470
1056
|
# A unique identifier for the account number field to be merged.
|
1471
1057
|
# @return [String]
|
@@ -1585,73 +1171,6 @@ module Aws::CustomerProfiles
|
|
1585
1171
|
# from the source, Amazon AppFlow. Customer Profiles uses this
|
1586
1172
|
# information to create an AppFlow flow on behalf of customers.
|
1587
1173
|
#
|
1588
|
-
# @note When making an API call, you may pass FlowDefinition
|
1589
|
-
# data as a hash:
|
1590
|
-
#
|
1591
|
-
# {
|
1592
|
-
# description: "FlowDescription",
|
1593
|
-
# flow_name: "FlowName", # required
|
1594
|
-
# kms_arn: "KmsArn", # required
|
1595
|
-
# source_flow_config: { # required
|
1596
|
-
# connector_profile_name: "ConnectorProfileName",
|
1597
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
1598
|
-
# incremental_pull_config: {
|
1599
|
-
# datetime_type_field_name: "DatetimeTypeFieldName",
|
1600
|
-
# },
|
1601
|
-
# source_connector_properties: { # required
|
1602
|
-
# marketo: {
|
1603
|
-
# object: "Object", # required
|
1604
|
-
# },
|
1605
|
-
# s3: {
|
1606
|
-
# bucket_name: "BucketName", # required
|
1607
|
-
# bucket_prefix: "BucketPrefix",
|
1608
|
-
# },
|
1609
|
-
# salesforce: {
|
1610
|
-
# object: "Object", # required
|
1611
|
-
# enable_dynamic_field_update: false,
|
1612
|
-
# include_deleted_records: false,
|
1613
|
-
# },
|
1614
|
-
# service_now: {
|
1615
|
-
# object: "Object", # required
|
1616
|
-
# },
|
1617
|
-
# zendesk: {
|
1618
|
-
# object: "Object", # required
|
1619
|
-
# },
|
1620
|
-
# },
|
1621
|
-
# },
|
1622
|
-
# tasks: [ # required
|
1623
|
-
# {
|
1624
|
-
# connector_operator: {
|
1625
|
-
# marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
1626
|
-
# s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
1627
|
-
# salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
1628
|
-
# service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
1629
|
-
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
1630
|
-
# },
|
1631
|
-
# destination_field: "DestinationField",
|
1632
|
-
# source_fields: ["stringTo2048"], # required
|
1633
|
-
# task_properties: {
|
1634
|
-
# "VALUE" => "Property",
|
1635
|
-
# },
|
1636
|
-
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
1637
|
-
# },
|
1638
|
-
# ],
|
1639
|
-
# trigger_config: { # required
|
1640
|
-
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
1641
|
-
# trigger_properties: {
|
1642
|
-
# scheduled: {
|
1643
|
-
# schedule_expression: "ScheduleExpression", # required
|
1644
|
-
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
1645
|
-
# schedule_start_time: Time.now,
|
1646
|
-
# schedule_end_time: Time.now,
|
1647
|
-
# timezone: "Timezone",
|
1648
|
-
# schedule_offset: 1,
|
1649
|
-
# first_execution_from: Time.now,
|
1650
|
-
# },
|
1651
|
-
# },
|
1652
|
-
# },
|
1653
|
-
# }
|
1654
|
-
#
|
1655
1174
|
# @!attribute [rw] description
|
1656
1175
|
# A description of the flow you want to create.
|
1657
1176
|
# @return [String]
|
@@ -1693,23 +1212,31 @@ module Aws::CustomerProfiles
|
|
1693
1212
|
include Aws::Structure
|
1694
1213
|
end
|
1695
1214
|
|
1696
|
-
#
|
1697
|
-
#
|
1215
|
+
# A data type pair that consists of a `KeyName` and `Values` list that
|
1216
|
+
# were used to find a profile returned in response to a
|
1217
|
+
# [SearchProfiles][1] request.
|
1218
|
+
#
|
1219
|
+
#
|
1698
1220
|
#
|
1699
|
-
#
|
1700
|
-
#
|
1701
|
-
#
|
1702
|
-
#
|
1703
|
-
#
|
1704
|
-
#
|
1705
|
-
#
|
1706
|
-
#
|
1707
|
-
#
|
1708
|
-
# source_name: "string1To255",
|
1709
|
-
# },
|
1710
|
-
# min_allowed_confidence_score_for_merging: 1.0,
|
1711
|
-
# }
|
1221
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
|
1222
|
+
#
|
1223
|
+
# @!attribute [rw] key_name
|
1224
|
+
# A searchable identifier of a customer profile.
|
1225
|
+
# @return [String]
|
1226
|
+
#
|
1227
|
+
# @!attribute [rw] values
|
1228
|
+
# A list of key values.
|
1229
|
+
# @return [Array<String>]
|
1712
1230
|
#
|
1231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FoundByKeyValue AWS API Documentation
|
1232
|
+
#
|
1233
|
+
class FoundByKeyValue < Struct.new(
|
1234
|
+
:key_name,
|
1235
|
+
:values)
|
1236
|
+
SENSITIVE = []
|
1237
|
+
include Aws::Structure
|
1238
|
+
end
|
1239
|
+
|
1713
1240
|
# @!attribute [rw] domain_name
|
1714
1241
|
# The unique name of the domain.
|
1715
1242
|
# @return [String]
|
@@ -1768,13 +1295,6 @@ module Aws::CustomerProfiles
|
|
1768
1295
|
include Aws::Structure
|
1769
1296
|
end
|
1770
1297
|
|
1771
|
-
# @note When making an API call, you may pass GetDomainRequest
|
1772
|
-
# data as a hash:
|
1773
|
-
#
|
1774
|
-
# {
|
1775
|
-
# domain_name: "name", # required
|
1776
|
-
# }
|
1777
|
-
#
|
1778
1298
|
# @!attribute [rw] domain_name
|
1779
1299
|
# The unique name of the domain.
|
1780
1300
|
# @return [String]
|
@@ -1857,14 +1377,6 @@ module Aws::CustomerProfiles
|
|
1857
1377
|
include Aws::Structure
|
1858
1378
|
end
|
1859
1379
|
|
1860
|
-
# @note When making an API call, you may pass GetIdentityResolutionJobRequest
|
1861
|
-
# data as a hash:
|
1862
|
-
#
|
1863
|
-
# {
|
1864
|
-
# domain_name: "name", # required
|
1865
|
-
# job_id: "uuid", # required
|
1866
|
-
# }
|
1867
|
-
#
|
1868
1380
|
# @!attribute [rw] domain_name
|
1869
1381
|
# The unique name of the domain.
|
1870
1382
|
# @return [String]
|
@@ -1972,14 +1484,6 @@ module Aws::CustomerProfiles
|
|
1972
1484
|
include Aws::Structure
|
1973
1485
|
end
|
1974
1486
|
|
1975
|
-
# @note When making an API call, you may pass GetIntegrationRequest
|
1976
|
-
# data as a hash:
|
1977
|
-
#
|
1978
|
-
# {
|
1979
|
-
# domain_name: "name", # required
|
1980
|
-
# uri: "string1To255", # required
|
1981
|
-
# }
|
1982
|
-
#
|
1983
1487
|
# @!attribute [rw] domain_name
|
1984
1488
|
# The unique name of the domain.
|
1985
1489
|
# @return [String]
|
@@ -2058,15 +1562,6 @@ module Aws::CustomerProfiles
|
|
2058
1562
|
include Aws::Structure
|
2059
1563
|
end
|
2060
1564
|
|
2061
|
-
# @note When making an API call, you may pass GetMatchesRequest
|
2062
|
-
# data as a hash:
|
2063
|
-
#
|
2064
|
-
# {
|
2065
|
-
# next_token: "token",
|
2066
|
-
# max_results: 1,
|
2067
|
-
# domain_name: "name", # required
|
2068
|
-
# }
|
2069
|
-
#
|
2070
1565
|
# @!attribute [rw] next_token
|
2071
1566
|
# The token for the next set of results. Use the value returned in the
|
2072
1567
|
# previous response in the next request to retrieve the next set of
|
@@ -2119,14 +1614,6 @@ module Aws::CustomerProfiles
|
|
2119
1614
|
include Aws::Structure
|
2120
1615
|
end
|
2121
1616
|
|
2122
|
-
# @note When making an API call, you may pass GetProfileObjectTypeRequest
|
2123
|
-
# data as a hash:
|
2124
|
-
#
|
2125
|
-
# {
|
2126
|
-
# domain_name: "name", # required
|
2127
|
-
# object_type_name: "typeName", # required
|
2128
|
-
# }
|
2129
|
-
#
|
2130
1617
|
# @!attribute [rw] domain_name
|
2131
1618
|
# The unique name of the domain.
|
2132
1619
|
# @return [String]
|
@@ -2219,13 +1706,6 @@ module Aws::CustomerProfiles
|
|
2219
1706
|
include Aws::Structure
|
2220
1707
|
end
|
2221
1708
|
|
2222
|
-
# @note When making an API call, you may pass GetProfileObjectTypeTemplateRequest
|
2223
|
-
# data as a hash:
|
2224
|
-
#
|
2225
|
-
# {
|
2226
|
-
# template_id: "name", # required
|
2227
|
-
# }
|
2228
|
-
#
|
2229
1709
|
# @!attribute [rw] template_id
|
2230
1710
|
# A unique identifier for the object template.
|
2231
1711
|
# @return [String]
|
@@ -2286,14 +1766,6 @@ module Aws::CustomerProfiles
|
|
2286
1766
|
include Aws::Structure
|
2287
1767
|
end
|
2288
1768
|
|
2289
|
-
# @note When making an API call, you may pass GetWorkflowRequest
|
2290
|
-
# data as a hash:
|
2291
|
-
#
|
2292
|
-
# {
|
2293
|
-
# domain_name: "name", # required
|
2294
|
-
# workflow_id: "uuid", # required
|
2295
|
-
# }
|
2296
|
-
#
|
2297
1769
|
# @!attribute [rw] domain_name
|
2298
1770
|
# The unique name of the domain.
|
2299
1771
|
# @return [String]
|
@@ -2359,16 +1831,6 @@ module Aws::CustomerProfiles
|
|
2359
1831
|
include Aws::Structure
|
2360
1832
|
end
|
2361
1833
|
|
2362
|
-
# @note When making an API call, you may pass GetWorkflowStepsRequest
|
2363
|
-
# data as a hash:
|
2364
|
-
#
|
2365
|
-
# {
|
2366
|
-
# domain_name: "name", # required
|
2367
|
-
# workflow_id: "uuid", # required
|
2368
|
-
# next_token: "token",
|
2369
|
-
# max_results: 1,
|
2370
|
-
# }
|
2371
|
-
#
|
2372
1834
|
# @!attribute [rw] domain_name
|
2373
1835
|
# The unique name of the domain.
|
2374
1836
|
# @return [String]
|
@@ -2504,13 +1966,6 @@ module Aws::CustomerProfiles
|
|
2504
1966
|
# Specifies the configuration used when importing incremental records
|
2505
1967
|
# from the source.
|
2506
1968
|
#
|
2507
|
-
# @note When making an API call, you may pass IncrementalPullConfig
|
2508
|
-
# data as a hash:
|
2509
|
-
#
|
2510
|
-
# {
|
2511
|
-
# datetime_type_field_name: "DatetimeTypeFieldName",
|
2512
|
-
# }
|
2513
|
-
#
|
2514
1969
|
# @!attribute [rw] datetime_type_field_name
|
2515
1970
|
# A field that specifies the date time or timestamp field as the
|
2516
1971
|
# criteria to use when importing incremental records from the source.
|
@@ -2526,83 +1981,6 @@ module Aws::CustomerProfiles
|
|
2526
1981
|
|
2527
1982
|
# Configuration data for integration workflow.
|
2528
1983
|
#
|
2529
|
-
# @note When making an API call, you may pass IntegrationConfig
|
2530
|
-
# data as a hash:
|
2531
|
-
#
|
2532
|
-
# {
|
2533
|
-
# appflow_integration: {
|
2534
|
-
# flow_definition: { # required
|
2535
|
-
# description: "FlowDescription",
|
2536
|
-
# flow_name: "FlowName", # required
|
2537
|
-
# kms_arn: "KmsArn", # required
|
2538
|
-
# source_flow_config: { # required
|
2539
|
-
# connector_profile_name: "ConnectorProfileName",
|
2540
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
2541
|
-
# incremental_pull_config: {
|
2542
|
-
# datetime_type_field_name: "DatetimeTypeFieldName",
|
2543
|
-
# },
|
2544
|
-
# source_connector_properties: { # required
|
2545
|
-
# marketo: {
|
2546
|
-
# object: "Object", # required
|
2547
|
-
# },
|
2548
|
-
# s3: {
|
2549
|
-
# bucket_name: "BucketName", # required
|
2550
|
-
# bucket_prefix: "BucketPrefix",
|
2551
|
-
# },
|
2552
|
-
# salesforce: {
|
2553
|
-
# object: "Object", # required
|
2554
|
-
# enable_dynamic_field_update: false,
|
2555
|
-
# include_deleted_records: false,
|
2556
|
-
# },
|
2557
|
-
# service_now: {
|
2558
|
-
# object: "Object", # required
|
2559
|
-
# },
|
2560
|
-
# zendesk: {
|
2561
|
-
# object: "Object", # required
|
2562
|
-
# },
|
2563
|
-
# },
|
2564
|
-
# },
|
2565
|
-
# tasks: [ # required
|
2566
|
-
# {
|
2567
|
-
# connector_operator: {
|
2568
|
-
# marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
2569
|
-
# s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
2570
|
-
# salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
2571
|
-
# service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
2572
|
-
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
2573
|
-
# },
|
2574
|
-
# destination_field: "DestinationField",
|
2575
|
-
# source_fields: ["stringTo2048"], # required
|
2576
|
-
# task_properties: {
|
2577
|
-
# "VALUE" => "Property",
|
2578
|
-
# },
|
2579
|
-
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
2580
|
-
# },
|
2581
|
-
# ],
|
2582
|
-
# trigger_config: { # required
|
2583
|
-
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
2584
|
-
# trigger_properties: {
|
2585
|
-
# scheduled: {
|
2586
|
-
# schedule_expression: "ScheduleExpression", # required
|
2587
|
-
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
2588
|
-
# schedule_start_time: Time.now,
|
2589
|
-
# schedule_end_time: Time.now,
|
2590
|
-
# timezone: "Timezone",
|
2591
|
-
# schedule_offset: 1,
|
2592
|
-
# first_execution_from: Time.now,
|
2593
|
-
# },
|
2594
|
-
# },
|
2595
|
-
# },
|
2596
|
-
# },
|
2597
|
-
# batches: [
|
2598
|
-
# {
|
2599
|
-
# start_time: Time.now, # required
|
2600
|
-
# end_time: Time.now, # required
|
2601
|
-
# },
|
2602
|
-
# ],
|
2603
|
-
# },
|
2604
|
-
# }
|
2605
|
-
#
|
2606
1984
|
# @!attribute [rw] appflow_integration
|
2607
1985
|
# Configuration data for `APPFLOW_INTEGRATION` workflow type.
|
2608
1986
|
# @return [Types::AppflowIntegration]
|
@@ -2631,14 +2009,6 @@ module Aws::CustomerProfiles
|
|
2631
2009
|
# The day and time when do you want to start the Identity Resolution Job
|
2632
2010
|
# every week.
|
2633
2011
|
#
|
2634
|
-
# @note When making an API call, you may pass JobSchedule
|
2635
|
-
# data as a hash:
|
2636
|
-
#
|
2637
|
-
# {
|
2638
|
-
# day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
2639
|
-
# time: "JobScheduleTime", # required
|
2640
|
-
# }
|
2641
|
-
#
|
2642
2012
|
# @!attribute [rw] day_of_the_week
|
2643
2013
|
# The day when the Identity Resolution Job should run every week.
|
2644
2014
|
# @return [String]
|
@@ -2680,16 +2050,6 @@ module Aws::CustomerProfiles
|
|
2680
2050
|
include Aws::Structure
|
2681
2051
|
end
|
2682
2052
|
|
2683
|
-
# @note When making an API call, you may pass ListAccountIntegrationsRequest
|
2684
|
-
# data as a hash:
|
2685
|
-
#
|
2686
|
-
# {
|
2687
|
-
# uri: "string1To255", # required
|
2688
|
-
# next_token: "token",
|
2689
|
-
# max_results: 1,
|
2690
|
-
# include_hidden: false,
|
2691
|
-
# }
|
2692
|
-
#
|
2693
2053
|
# @!attribute [rw] uri
|
2694
2054
|
# The URI of the S3 bucket or any other type of data source.
|
2695
2055
|
# @return [String]
|
@@ -2767,14 +2127,6 @@ module Aws::CustomerProfiles
|
|
2767
2127
|
include Aws::Structure
|
2768
2128
|
end
|
2769
2129
|
|
2770
|
-
# @note When making an API call, you may pass ListDomainsRequest
|
2771
|
-
# data as a hash:
|
2772
|
-
#
|
2773
|
-
# {
|
2774
|
-
# next_token: "token",
|
2775
|
-
# max_results: 1,
|
2776
|
-
# }
|
2777
|
-
#
|
2778
2130
|
# @!attribute [rw] next_token
|
2779
2131
|
# The pagination token from the previous ListDomain API call.
|
2780
2132
|
# @return [String]
|
@@ -2809,15 +2161,6 @@ module Aws::CustomerProfiles
|
|
2809
2161
|
include Aws::Structure
|
2810
2162
|
end
|
2811
2163
|
|
2812
|
-
# @note When making an API call, you may pass ListIdentityResolutionJobsRequest
|
2813
|
-
# data as a hash:
|
2814
|
-
#
|
2815
|
-
# {
|
2816
|
-
# domain_name: "name", # required
|
2817
|
-
# next_token: "token",
|
2818
|
-
# max_results: 1,
|
2819
|
-
# }
|
2820
|
-
#
|
2821
2164
|
# @!attribute [rw] domain_name
|
2822
2165
|
# The unique name of the domain.
|
2823
2166
|
# @return [String]
|
@@ -2923,16 +2266,6 @@ module Aws::CustomerProfiles
|
|
2923
2266
|
include Aws::Structure
|
2924
2267
|
end
|
2925
2268
|
|
2926
|
-
# @note When making an API call, you may pass ListIntegrationsRequest
|
2927
|
-
# data as a hash:
|
2928
|
-
#
|
2929
|
-
# {
|
2930
|
-
# domain_name: "name", # required
|
2931
|
-
# next_token: "token",
|
2932
|
-
# max_results: 1,
|
2933
|
-
# include_hidden: false,
|
2934
|
-
# }
|
2935
|
-
#
|
2936
2269
|
# @!attribute [rw] domain_name
|
2937
2270
|
# The unique name of the domain.
|
2938
2271
|
# @return [String]
|
@@ -3037,14 +2370,6 @@ module Aws::CustomerProfiles
|
|
3037
2370
|
include Aws::Structure
|
3038
2371
|
end
|
3039
2372
|
|
3040
|
-
# @note When making an API call, you may pass ListProfileObjectTypeTemplatesRequest
|
3041
|
-
# data as a hash:
|
3042
|
-
#
|
3043
|
-
# {
|
3044
|
-
# next_token: "token",
|
3045
|
-
# max_results: 1,
|
3046
|
-
# }
|
3047
|
-
#
|
3048
2373
|
# @!attribute [rw] next_token
|
3049
2374
|
# The pagination token from the previous ListObjectTypeTemplates API
|
3050
2375
|
# call.
|
@@ -3081,15 +2406,6 @@ module Aws::CustomerProfiles
|
|
3081
2406
|
include Aws::Structure
|
3082
2407
|
end
|
3083
2408
|
|
3084
|
-
# @note When making an API call, you may pass ListProfileObjectTypesRequest
|
3085
|
-
# data as a hash:
|
3086
|
-
#
|
3087
|
-
# {
|
3088
|
-
# domain_name: "name", # required
|
3089
|
-
# next_token: "token",
|
3090
|
-
# max_results: 1,
|
3091
|
-
# }
|
3092
|
-
#
|
3093
2409
|
# @!attribute [rw] domain_name
|
3094
2410
|
# The unique name of the domain.
|
3095
2411
|
# @return [String]
|
@@ -3154,21 +2470,6 @@ module Aws::CustomerProfiles
|
|
3154
2470
|
include Aws::Structure
|
3155
2471
|
end
|
3156
2472
|
|
3157
|
-
# @note When making an API call, you may pass ListProfileObjectsRequest
|
3158
|
-
# data as a hash:
|
3159
|
-
#
|
3160
|
-
# {
|
3161
|
-
# next_token: "token",
|
3162
|
-
# max_results: 1,
|
3163
|
-
# domain_name: "name", # required
|
3164
|
-
# object_type_name: "typeName", # required
|
3165
|
-
# profile_id: "uuid", # required
|
3166
|
-
# object_filter: {
|
3167
|
-
# key_name: "name", # required
|
3168
|
-
# values: ["string1To255"], # required
|
3169
|
-
# },
|
3170
|
-
# }
|
3171
|
-
#
|
3172
2473
|
# @!attribute [rw] next_token
|
3173
2474
|
# The pagination token from the previous call to ListProfileObjects.
|
3174
2475
|
# @return [String]
|
@@ -3225,13 +2526,6 @@ module Aws::CustomerProfiles
|
|
3225
2526
|
include Aws::Structure
|
3226
2527
|
end
|
3227
2528
|
|
3228
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
3229
|
-
# data as a hash:
|
3230
|
-
#
|
3231
|
-
# {
|
3232
|
-
# resource_arn: "TagArn", # required
|
3233
|
-
# }
|
3234
|
-
#
|
3235
2529
|
# @!attribute [rw] resource_arn
|
3236
2530
|
# The ARN of the resource for which you want to view tags.
|
3237
2531
|
# @return [String]
|
@@ -3297,19 +2591,6 @@ module Aws::CustomerProfiles
|
|
3297
2591
|
include Aws::Structure
|
3298
2592
|
end
|
3299
2593
|
|
3300
|
-
# @note When making an API call, you may pass ListWorkflowsRequest
|
3301
|
-
# data as a hash:
|
3302
|
-
#
|
3303
|
-
# {
|
3304
|
-
# domain_name: "name", # required
|
3305
|
-
# workflow_type: "APPFLOW_INTEGRATION", # accepts APPFLOW_INTEGRATION
|
3306
|
-
# status: "NOT_STARTED", # accepts NOT_STARTED, IN_PROGRESS, COMPLETE, FAILED, SPLIT, RETRY, CANCELLED
|
3307
|
-
# query_start_date: Time.now,
|
3308
|
-
# query_end_date: Time.now,
|
3309
|
-
# next_token: "token",
|
3310
|
-
# max_results: 1,
|
3311
|
-
# }
|
3312
|
-
#
|
3313
2594
|
# @!attribute [rw] domain_name
|
3314
2595
|
# The unique name of the domain.
|
3315
2596
|
# @return [String]
|
@@ -3376,13 +2657,6 @@ module Aws::CustomerProfiles
|
|
3376
2657
|
# The properties that are applied when Marketo is being used as a
|
3377
2658
|
# source.
|
3378
2659
|
#
|
3379
|
-
# @note When making an API call, you may pass MarketoSourceProperties
|
3380
|
-
# data as a hash:
|
3381
|
-
#
|
3382
|
-
# {
|
3383
|
-
# object: "Object", # required
|
3384
|
-
# }
|
3385
|
-
#
|
3386
2660
|
# @!attribute [rw] object
|
3387
2661
|
# The object specified in the Marketo flow source.
|
3388
2662
|
# @return [String]
|
@@ -3429,36 +2703,6 @@ module Aws::CustomerProfiles
|
|
3429
2703
|
|
3430
2704
|
# The flag that enables the matching process of duplicate profiles.
|
3431
2705
|
#
|
3432
|
-
# @note When making an API call, you may pass MatchingRequest
|
3433
|
-
# data as a hash:
|
3434
|
-
#
|
3435
|
-
# {
|
3436
|
-
# enabled: false, # required
|
3437
|
-
# job_schedule: {
|
3438
|
-
# day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
3439
|
-
# time: "JobScheduleTime", # required
|
3440
|
-
# },
|
3441
|
-
# auto_merging: {
|
3442
|
-
# enabled: false, # required
|
3443
|
-
# consolidation: {
|
3444
|
-
# matching_attributes_list: [ # required
|
3445
|
-
# ["string1To255"],
|
3446
|
-
# ],
|
3447
|
-
# },
|
3448
|
-
# conflict_resolution: {
|
3449
|
-
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
3450
|
-
# source_name: "string1To255",
|
3451
|
-
# },
|
3452
|
-
# min_allowed_confidence_score_for_merging: 1.0,
|
3453
|
-
# },
|
3454
|
-
# exporting_config: {
|
3455
|
-
# s3_exporting: {
|
3456
|
-
# s3_bucket_name: "s3BucketName", # required
|
3457
|
-
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
3458
|
-
# },
|
3459
|
-
# },
|
3460
|
-
# }
|
3461
|
-
#
|
3462
2706
|
# @!attribute [rw] enabled
|
3463
2707
|
# The flag that enables the matching process of duplicate profiles.
|
3464
2708
|
# @return [Boolean]
|
@@ -3519,40 +2763,6 @@ module Aws::CustomerProfiles
|
|
3519
2763
|
include Aws::Structure
|
3520
2764
|
end
|
3521
2765
|
|
3522
|
-
# @note When making an API call, you may pass MergeProfilesRequest
|
3523
|
-
# data as a hash:
|
3524
|
-
#
|
3525
|
-
# {
|
3526
|
-
# domain_name: "name", # required
|
3527
|
-
# main_profile_id: "uuid", # required
|
3528
|
-
# profile_ids_to_be_merged: ["uuid"], # required
|
3529
|
-
# field_source_profile_ids: {
|
3530
|
-
# account_number: "uuid",
|
3531
|
-
# additional_information: "uuid",
|
3532
|
-
# party_type: "uuid",
|
3533
|
-
# business_name: "uuid",
|
3534
|
-
# first_name: "uuid",
|
3535
|
-
# middle_name: "uuid",
|
3536
|
-
# last_name: "uuid",
|
3537
|
-
# birth_date: "uuid",
|
3538
|
-
# gender: "uuid",
|
3539
|
-
# phone_number: "uuid",
|
3540
|
-
# mobile_phone_number: "uuid",
|
3541
|
-
# home_phone_number: "uuid",
|
3542
|
-
# business_phone_number: "uuid",
|
3543
|
-
# email_address: "uuid",
|
3544
|
-
# personal_email_address: "uuid",
|
3545
|
-
# business_email_address: "uuid",
|
3546
|
-
# address: "uuid",
|
3547
|
-
# shipping_address: "uuid",
|
3548
|
-
# mailing_address: "uuid",
|
3549
|
-
# billing_address: "uuid",
|
3550
|
-
# attributes: {
|
3551
|
-
# "string1To255" => "uuid",
|
3552
|
-
# },
|
3553
|
-
# },
|
3554
|
-
# }
|
3555
|
-
#
|
3556
2766
|
# @!attribute [rw] domain_name
|
3557
2767
|
# The unique name of the domain.
|
3558
2768
|
# @return [String]
|
@@ -3599,14 +2809,6 @@ module Aws::CustomerProfiles
|
|
3599
2809
|
# objects with the specified index values. This filter is only supported
|
3600
2810
|
# for ObjectTypeName \_asset, \_case and \_order.
|
3601
2811
|
#
|
3602
|
-
# @note When making an API call, you may pass ObjectFilter
|
3603
|
-
# data as a hash:
|
3604
|
-
#
|
3605
|
-
# {
|
3606
|
-
# key_name: "name", # required
|
3607
|
-
# values: ["string1To255"], # required
|
3608
|
-
# }
|
3609
|
-
#
|
3610
2812
|
# @!attribute [rw] key_name
|
3611
2813
|
# A searchable identifier of a standard profile object. The predefined
|
3612
2814
|
# keys you can use to search for \_asset include: \_assetId,
|
@@ -3630,15 +2832,6 @@ module Aws::CustomerProfiles
|
|
3630
2832
|
|
3631
2833
|
# Represents a field in a ProfileObjectType.
|
3632
2834
|
#
|
3633
|
-
# @note When making an API call, you may pass ObjectTypeField
|
3634
|
-
# data as a hash:
|
3635
|
-
#
|
3636
|
-
# {
|
3637
|
-
# source: "text",
|
3638
|
-
# target: "text",
|
3639
|
-
# content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
|
3640
|
-
# }
|
3641
|
-
#
|
3642
2835
|
# @!attribute [rw] source
|
3643
2836
|
# A field of a ProfileObject. For example: \_source.FirstName, where
|
3644
2837
|
# “\_source” is a ProfileObjectType of a Zendesk user and “FirstName”
|
@@ -3668,14 +2861,6 @@ module Aws::CustomerProfiles
|
|
3668
2861
|
# An object that defines the Key element of a ProfileObject. A Key is a
|
3669
2862
|
# special element that can be used to search for a customer profile.
|
3670
2863
|
#
|
3671
|
-
# @note When making an API call, you may pass ObjectTypeKey
|
3672
|
-
# data as a hash:
|
3673
|
-
#
|
3674
|
-
# {
|
3675
|
-
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY, ORDER
|
3676
|
-
# field_names: ["name"],
|
3677
|
-
# }
|
3678
|
-
#
|
3679
2864
|
# @!attribute [rw] standard_identifiers
|
3680
2865
|
# The types of keys that a ProfileObject can have. Each ProfileObject
|
3681
2866
|
# can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE,
|
@@ -3796,6 +2981,34 @@ module Aws::CustomerProfiles
|
|
3796
2981
|
# A key value pair of attributes of a customer profile.
|
3797
2982
|
# @return [Hash<String,String>]
|
3798
2983
|
#
|
2984
|
+
# @!attribute [rw] found_by_items
|
2985
|
+
# A list of items used to find a profile returned in a
|
2986
|
+
# [SearchProfiles][1] response. An item is a key-value(s) pair that
|
2987
|
+
# matches an attribute in the profile.
|
2988
|
+
#
|
2989
|
+
# If the optional `AdditionalSearchKeys` parameter was included in the
|
2990
|
+
# [SearchProfiles][1] request, the `FoundByItems` list should be
|
2991
|
+
# interpreted based on the `LogicalOperator` used in the request:
|
2992
|
+
#
|
2993
|
+
# * `AND` - The profile included in the response matched all of the
|
2994
|
+
# search keys specified in the request. The `FoundByItems` will
|
2995
|
+
# include all of the key-value(s) pairs that were specified in the
|
2996
|
+
# request (as this is a requirement of `AND` search logic).
|
2997
|
+
#
|
2998
|
+
# * `OR` - The profile included in the response matched at least one
|
2999
|
+
# of the search keys specified in the request. The `FoundByItems`
|
3000
|
+
# will include each of the key-value(s) pairs that the profile was
|
3001
|
+
# found by.
|
3002
|
+
#
|
3003
|
+
# The `OR` relationship is the default behavior if the
|
3004
|
+
# `LogicalOperator` parameter is not included in the
|
3005
|
+
# [SearchProfiles][1] request.
|
3006
|
+
#
|
3007
|
+
#
|
3008
|
+
#
|
3009
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
|
3010
|
+
# @return [Array<Types::FoundByKeyValue>]
|
3011
|
+
#
|
3799
3012
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Profile AWS API Documentation
|
3800
3013
|
#
|
3801
3014
|
class Profile < Struct.new(
|
@@ -3820,89 +3033,12 @@ module Aws::CustomerProfiles
|
|
3820
3033
|
:shipping_address,
|
3821
3034
|
:mailing_address,
|
3822
3035
|
:billing_address,
|
3823
|
-
:attributes
|
3036
|
+
:attributes,
|
3037
|
+
:found_by_items)
|
3824
3038
|
SENSITIVE = []
|
3825
3039
|
include Aws::Structure
|
3826
3040
|
end
|
3827
3041
|
|
3828
|
-
# @note When making an API call, you may pass PutIntegrationRequest
|
3829
|
-
# data as a hash:
|
3830
|
-
#
|
3831
|
-
# {
|
3832
|
-
# domain_name: "name", # required
|
3833
|
-
# uri: "string1To255",
|
3834
|
-
# object_type_name: "typeName",
|
3835
|
-
# tags: {
|
3836
|
-
# "TagKey" => "TagValue",
|
3837
|
-
# },
|
3838
|
-
# flow_definition: {
|
3839
|
-
# description: "FlowDescription",
|
3840
|
-
# flow_name: "FlowName", # required
|
3841
|
-
# kms_arn: "KmsArn", # required
|
3842
|
-
# source_flow_config: { # required
|
3843
|
-
# connector_profile_name: "ConnectorProfileName",
|
3844
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
3845
|
-
# incremental_pull_config: {
|
3846
|
-
# datetime_type_field_name: "DatetimeTypeFieldName",
|
3847
|
-
# },
|
3848
|
-
# source_connector_properties: { # required
|
3849
|
-
# marketo: {
|
3850
|
-
# object: "Object", # required
|
3851
|
-
# },
|
3852
|
-
# s3: {
|
3853
|
-
# bucket_name: "BucketName", # required
|
3854
|
-
# bucket_prefix: "BucketPrefix",
|
3855
|
-
# },
|
3856
|
-
# salesforce: {
|
3857
|
-
# object: "Object", # required
|
3858
|
-
# enable_dynamic_field_update: false,
|
3859
|
-
# include_deleted_records: false,
|
3860
|
-
# },
|
3861
|
-
# service_now: {
|
3862
|
-
# object: "Object", # required
|
3863
|
-
# },
|
3864
|
-
# zendesk: {
|
3865
|
-
# object: "Object", # required
|
3866
|
-
# },
|
3867
|
-
# },
|
3868
|
-
# },
|
3869
|
-
# tasks: [ # required
|
3870
|
-
# {
|
3871
|
-
# connector_operator: {
|
3872
|
-
# marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
3873
|
-
# s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
3874
|
-
# salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
3875
|
-
# service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
3876
|
-
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
3877
|
-
# },
|
3878
|
-
# destination_field: "DestinationField",
|
3879
|
-
# source_fields: ["stringTo2048"], # required
|
3880
|
-
# task_properties: {
|
3881
|
-
# "VALUE" => "Property",
|
3882
|
-
# },
|
3883
|
-
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
3884
|
-
# },
|
3885
|
-
# ],
|
3886
|
-
# trigger_config: { # required
|
3887
|
-
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
3888
|
-
# trigger_properties: {
|
3889
|
-
# scheduled: {
|
3890
|
-
# schedule_expression: "ScheduleExpression", # required
|
3891
|
-
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
3892
|
-
# schedule_start_time: Time.now,
|
3893
|
-
# schedule_end_time: Time.now,
|
3894
|
-
# timezone: "Timezone",
|
3895
|
-
# schedule_offset: 1,
|
3896
|
-
# first_execution_from: Time.now,
|
3897
|
-
# },
|
3898
|
-
# },
|
3899
|
-
# },
|
3900
|
-
# },
|
3901
|
-
# object_type_names: {
|
3902
|
-
# "string1To255" => "typeName",
|
3903
|
-
# },
|
3904
|
-
# }
|
3905
|
-
#
|
3906
3042
|
# @!attribute [rw] domain_name
|
3907
3043
|
# The unique name of the domain.
|
3908
3044
|
# @return [String]
|
@@ -4009,15 +3145,6 @@ module Aws::CustomerProfiles
|
|
4009
3145
|
include Aws::Structure
|
4010
3146
|
end
|
4011
3147
|
|
4012
|
-
# @note When making an API call, you may pass PutProfileObjectRequest
|
4013
|
-
# data as a hash:
|
4014
|
-
#
|
4015
|
-
# {
|
4016
|
-
# object_type_name: "typeName", # required
|
4017
|
-
# object: "stringifiedJson", # required
|
4018
|
-
# domain_name: "name", # required
|
4019
|
-
# }
|
4020
|
-
#
|
4021
3148
|
# @!attribute [rw] object_type_name
|
4022
3149
|
# The name of the profile object type.
|
4023
3150
|
# @return [String]
|
@@ -4053,38 +3180,6 @@ module Aws::CustomerProfiles
|
|
4053
3180
|
include Aws::Structure
|
4054
3181
|
end
|
4055
3182
|
|
4056
|
-
# @note When making an API call, you may pass PutProfileObjectTypeRequest
|
4057
|
-
# data as a hash:
|
4058
|
-
#
|
4059
|
-
# {
|
4060
|
-
# domain_name: "name", # required
|
4061
|
-
# object_type_name: "typeName", # required
|
4062
|
-
# description: "text", # required
|
4063
|
-
# template_id: "name",
|
4064
|
-
# expiration_days: 1,
|
4065
|
-
# encryption_key: "encryptionKey",
|
4066
|
-
# allow_profile_creation: false,
|
4067
|
-
# source_last_updated_timestamp_format: "string1To255",
|
4068
|
-
# fields: {
|
4069
|
-
# "name" => {
|
4070
|
-
# source: "text",
|
4071
|
-
# target: "text",
|
4072
|
-
# content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
|
4073
|
-
# },
|
4074
|
-
# },
|
4075
|
-
# keys: {
|
4076
|
-
# "name" => [
|
4077
|
-
# {
|
4078
|
-
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY, ORDER
|
4079
|
-
# field_names: ["name"],
|
4080
|
-
# },
|
4081
|
-
# ],
|
4082
|
-
# },
|
4083
|
-
# tags: {
|
4084
|
-
# "TagKey" => "TagValue",
|
4085
|
-
# },
|
4086
|
-
# }
|
4087
|
-
#
|
4088
3183
|
# @!attribute [rw] domain_name
|
4089
3184
|
# The unique name of the domain.
|
4090
3185
|
# @return [String]
|
@@ -4259,14 +3354,6 @@ module Aws::CustomerProfiles
|
|
4259
3354
|
# Configuration information about the S3 bucket where Identity
|
4260
3355
|
# Resolution Jobs write result files.
|
4261
3356
|
#
|
4262
|
-
# @note When making an API call, you may pass S3ExportingConfig
|
4263
|
-
# data as a hash:
|
4264
|
-
#
|
4265
|
-
# {
|
4266
|
-
# s3_bucket_name: "s3BucketName", # required
|
4267
|
-
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
4268
|
-
# }
|
4269
|
-
#
|
4270
3357
|
# @!attribute [rw] s3_bucket_name
|
4271
3358
|
# The name of the S3 bucket where Identity Resolution Jobs write
|
4272
3359
|
# result files.
|
@@ -4310,14 +3397,6 @@ module Aws::CustomerProfiles
|
|
4310
3397
|
# The properties that are applied when Amazon S3 is being used as the
|
4311
3398
|
# flow source.
|
4312
3399
|
#
|
4313
|
-
# @note When making an API call, you may pass S3SourceProperties
|
4314
|
-
# data as a hash:
|
4315
|
-
#
|
4316
|
-
# {
|
4317
|
-
# bucket_name: "BucketName", # required
|
4318
|
-
# bucket_prefix: "BucketPrefix",
|
4319
|
-
# }
|
4320
|
-
#
|
4321
3400
|
# @!attribute [rw] bucket_name
|
4322
3401
|
# The Amazon S3 bucket name where the source files are stored.
|
4323
3402
|
# @return [String]
|
@@ -4339,15 +3418,6 @@ module Aws::CustomerProfiles
|
|
4339
3418
|
# The properties that are applied when Salesforce is being used as a
|
4340
3419
|
# source.
|
4341
3420
|
#
|
4342
|
-
# @note When making an API call, you may pass SalesforceSourceProperties
|
4343
|
-
# data as a hash:
|
4344
|
-
#
|
4345
|
-
# {
|
4346
|
-
# object: "Object", # required
|
4347
|
-
# enable_dynamic_field_update: false,
|
4348
|
-
# include_deleted_records: false,
|
4349
|
-
# }
|
4350
|
-
#
|
4351
3421
|
# @!attribute [rw] object
|
4352
3422
|
# The object specified in the Salesforce flow source.
|
4353
3423
|
# @return [String]
|
@@ -4376,19 +3446,6 @@ module Aws::CustomerProfiles
|
|
4376
3446
|
# you define. Currently, these settings only apply to the
|
4377
3447
|
# scheduled-trigger type.
|
4378
3448
|
#
|
4379
|
-
# @note When making an API call, you may pass ScheduledTriggerProperties
|
4380
|
-
# data as a hash:
|
4381
|
-
#
|
4382
|
-
# {
|
4383
|
-
# schedule_expression: "ScheduleExpression", # required
|
4384
|
-
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
4385
|
-
# schedule_start_time: Time.now,
|
4386
|
-
# schedule_end_time: Time.now,
|
4387
|
-
# timezone: "Timezone",
|
4388
|
-
# schedule_offset: 1,
|
4389
|
-
# first_execution_from: Time.now,
|
4390
|
-
# }
|
4391
|
-
#
|
4392
3449
|
# @!attribute [rw] schedule_expression
|
4393
3450
|
# The scheduling expression that determines the rate at which the
|
4394
3451
|
# schedule will run, for example rate (5 minutes).
|
@@ -4436,23 +3493,14 @@ module Aws::CustomerProfiles
|
|
4436
3493
|
include Aws::Structure
|
4437
3494
|
end
|
4438
3495
|
|
4439
|
-
# @note When making an API call, you may pass SearchProfilesRequest
|
4440
|
-
# data as a hash:
|
4441
|
-
#
|
4442
|
-
# {
|
4443
|
-
# next_token: "token",
|
4444
|
-
# max_results: 1,
|
4445
|
-
# domain_name: "name", # required
|
4446
|
-
# key_name: "name", # required
|
4447
|
-
# values: ["string1To255"], # required
|
4448
|
-
# }
|
4449
|
-
#
|
4450
3496
|
# @!attribute [rw] next_token
|
4451
3497
|
# The pagination token from the previous SearchProfiles API call.
|
4452
3498
|
# @return [String]
|
4453
3499
|
#
|
4454
3500
|
# @!attribute [rw] max_results
|
4455
3501
|
# The maximum number of objects returned per page.
|
3502
|
+
#
|
3503
|
+
# The default is 20 if this parameter is not included in the request.
|
4456
3504
|
# @return [Integer]
|
4457
3505
|
#
|
4458
3506
|
# @!attribute [rw] domain_name
|
@@ -4473,6 +3521,35 @@ module Aws::CustomerProfiles
|
|
4473
3521
|
# A list of key values.
|
4474
3522
|
# @return [Array<String>]
|
4475
3523
|
#
|
3524
|
+
# @!attribute [rw] additional_search_keys
|
3525
|
+
# A list of `AdditionalSearchKey` objects that are each searchable
|
3526
|
+
# identifiers of a profile. Each `AdditionalSearchKey` object contains
|
3527
|
+
# a `KeyName` and a list of `Values` associated with that specific key
|
3528
|
+
# (i.e., a key-value(s) pair). These additional search keys will be
|
3529
|
+
# used in conjunction with the `LogicalOperator` and the required
|
3530
|
+
# `KeyName` and `Values` parameters to search for profiles that
|
3531
|
+
# satisfy the search criteria.
|
3532
|
+
# @return [Array<Types::AdditionalSearchKey>]
|
3533
|
+
#
|
3534
|
+
# @!attribute [rw] logical_operator
|
3535
|
+
# Relationship between all specified search keys that will be used to
|
3536
|
+
# search for profiles. This includes the required `KeyName` and
|
3537
|
+
# `Values` parameters as well as any key-value(s) pairs specified in
|
3538
|
+
# the `AdditionalSearchKeys` list.
|
3539
|
+
#
|
3540
|
+
# This parameter influences which profiles will be returned in the
|
3541
|
+
# response in the following manner:
|
3542
|
+
#
|
3543
|
+
# * `AND` - The response only includes profiles that match all of the
|
3544
|
+
# search keys.
|
3545
|
+
#
|
3546
|
+
# * `OR` - The response includes profiles that match at least one of
|
3547
|
+
# the search keys.
|
3548
|
+
#
|
3549
|
+
# The `OR` relationship is the default behavior if this parameter is
|
3550
|
+
# not included in the request.
|
3551
|
+
# @return [String]
|
3552
|
+
#
|
4476
3553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchProfilesRequest AWS API Documentation
|
4477
3554
|
#
|
4478
3555
|
class SearchProfilesRequest < Struct.new(
|
@@ -4480,13 +3557,15 @@ module Aws::CustomerProfiles
|
|
4480
3557
|
:max_results,
|
4481
3558
|
:domain_name,
|
4482
3559
|
:key_name,
|
4483
|
-
:values
|
3560
|
+
:values,
|
3561
|
+
:additional_search_keys,
|
3562
|
+
:logical_operator)
|
4484
3563
|
SENSITIVE = []
|
4485
3564
|
include Aws::Structure
|
4486
3565
|
end
|
4487
3566
|
|
4488
3567
|
# @!attribute [rw] items
|
4489
|
-
# The list of
|
3568
|
+
# The list of Profiles matching the search criteria.
|
4490
3569
|
# @return [Array<Types::Profile>]
|
4491
3570
|
#
|
4492
3571
|
# @!attribute [rw] next_token
|
@@ -4505,13 +3584,6 @@ module Aws::CustomerProfiles
|
|
4505
3584
|
# The properties that are applied when ServiceNow is being used as a
|
4506
3585
|
# source.
|
4507
3586
|
#
|
4508
|
-
# @note When making an API call, you may pass ServiceNowSourceProperties
|
4509
|
-
# data as a hash:
|
4510
|
-
#
|
4511
|
-
# {
|
4512
|
-
# object: "Object", # required
|
4513
|
-
# }
|
4514
|
-
#
|
4515
3587
|
# @!attribute [rw] object
|
4516
3588
|
# The object specified in the ServiceNow flow source.
|
4517
3589
|
# @return [String]
|
@@ -4528,30 +3600,6 @@ module Aws::CustomerProfiles
|
|
4528
3600
|
# Amazon AppFlow connector. Customer Profiles supports Salesforce,
|
4529
3601
|
# Zendesk, Marketo, ServiceNow and Amazon S3.
|
4530
3602
|
#
|
4531
|
-
# @note When making an API call, you may pass SourceConnectorProperties
|
4532
|
-
# data as a hash:
|
4533
|
-
#
|
4534
|
-
# {
|
4535
|
-
# marketo: {
|
4536
|
-
# object: "Object", # required
|
4537
|
-
# },
|
4538
|
-
# s3: {
|
4539
|
-
# bucket_name: "BucketName", # required
|
4540
|
-
# bucket_prefix: "BucketPrefix",
|
4541
|
-
# },
|
4542
|
-
# salesforce: {
|
4543
|
-
# object: "Object", # required
|
4544
|
-
# enable_dynamic_field_update: false,
|
4545
|
-
# include_deleted_records: false,
|
4546
|
-
# },
|
4547
|
-
# service_now: {
|
4548
|
-
# object: "Object", # required
|
4549
|
-
# },
|
4550
|
-
# zendesk: {
|
4551
|
-
# object: "Object", # required
|
4552
|
-
# },
|
4553
|
-
# }
|
4554
|
-
#
|
4555
3603
|
# @!attribute [rw] marketo
|
4556
3604
|
# The properties that are applied when Marketo is being used as a
|
4557
3605
|
# source.
|
@@ -4591,37 +3639,6 @@ module Aws::CustomerProfiles
|
|
4591
3639
|
# Contains information about the configuration of the source connector
|
4592
3640
|
# used in the flow.
|
4593
3641
|
#
|
4594
|
-
# @note When making an API call, you may pass SourceFlowConfig
|
4595
|
-
# data as a hash:
|
4596
|
-
#
|
4597
|
-
# {
|
4598
|
-
# connector_profile_name: "ConnectorProfileName",
|
4599
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
4600
|
-
# incremental_pull_config: {
|
4601
|
-
# datetime_type_field_name: "DatetimeTypeFieldName",
|
4602
|
-
# },
|
4603
|
-
# source_connector_properties: { # required
|
4604
|
-
# marketo: {
|
4605
|
-
# object: "Object", # required
|
4606
|
-
# },
|
4607
|
-
# s3: {
|
4608
|
-
# bucket_name: "BucketName", # required
|
4609
|
-
# bucket_prefix: "BucketPrefix",
|
4610
|
-
# },
|
4611
|
-
# salesforce: {
|
4612
|
-
# object: "Object", # required
|
4613
|
-
# enable_dynamic_field_update: false,
|
4614
|
-
# include_deleted_records: false,
|
4615
|
-
# },
|
4616
|
-
# service_now: {
|
4617
|
-
# object: "Object", # required
|
4618
|
-
# },
|
4619
|
-
# zendesk: {
|
4620
|
-
# object: "Object", # required
|
4621
|
-
# },
|
4622
|
-
# },
|
4623
|
-
# }
|
4624
|
-
#
|
4625
3642
|
# @!attribute [rw] connector_profile_name
|
4626
3643
|
# The name of the AppFlow connector profile. This name must be unique
|
4627
3644
|
# for each connector profile in the AWS account.
|
@@ -4653,16 +3670,6 @@ module Aws::CustomerProfiles
|
|
4653
3670
|
include Aws::Structure
|
4654
3671
|
end
|
4655
3672
|
|
4656
|
-
# @note When making an API call, you may pass TagResourceRequest
|
4657
|
-
# data as a hash:
|
4658
|
-
#
|
4659
|
-
# {
|
4660
|
-
# resource_arn: "TagArn", # required
|
4661
|
-
# tags: { # required
|
4662
|
-
# "TagKey" => "TagValue",
|
4663
|
-
# },
|
4664
|
-
# }
|
4665
|
-
#
|
4666
3673
|
# @!attribute [rw] resource_arn
|
4667
3674
|
# The ARN of the resource that you're adding tags to.
|
4668
3675
|
# @return [String]
|
@@ -4688,25 +3695,6 @@ module Aws::CustomerProfiles
|
|
4688
3695
|
# A class for modeling different type of tasks. Task implementation
|
4689
3696
|
# varies based on the TaskType.
|
4690
3697
|
#
|
4691
|
-
# @note When making an API call, you may pass Task
|
4692
|
-
# data as a hash:
|
4693
|
-
#
|
4694
|
-
# {
|
4695
|
-
# connector_operator: {
|
4696
|
-
# marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
4697
|
-
# s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
4698
|
-
# salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
4699
|
-
# service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
4700
|
-
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
4701
|
-
# },
|
4702
|
-
# destination_field: "DestinationField",
|
4703
|
-
# source_fields: ["stringTo2048"], # required
|
4704
|
-
# task_properties: {
|
4705
|
-
# "VALUE" => "Property",
|
4706
|
-
# },
|
4707
|
-
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
4708
|
-
# }
|
4709
|
-
#
|
4710
3698
|
# @!attribute [rw] connector_operator
|
4711
3699
|
# The operation to be performed on the provided source fields.
|
4712
3700
|
# @return [Types::ConnectorOperator]
|
@@ -4758,24 +3746,6 @@ module Aws::CustomerProfiles
|
|
4758
3746
|
# The trigger settings that determine how and when Amazon AppFlow runs
|
4759
3747
|
# the specified flow.
|
4760
3748
|
#
|
4761
|
-
# @note When making an API call, you may pass TriggerConfig
|
4762
|
-
# data as a hash:
|
4763
|
-
#
|
4764
|
-
# {
|
4765
|
-
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
4766
|
-
# trigger_properties: {
|
4767
|
-
# scheduled: {
|
4768
|
-
# schedule_expression: "ScheduleExpression", # required
|
4769
|
-
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
4770
|
-
# schedule_start_time: Time.now,
|
4771
|
-
# schedule_end_time: Time.now,
|
4772
|
-
# timezone: "Timezone",
|
4773
|
-
# schedule_offset: 1,
|
4774
|
-
# first_execution_from: Time.now,
|
4775
|
-
# },
|
4776
|
-
# },
|
4777
|
-
# }
|
4778
|
-
#
|
4779
3749
|
# @!attribute [rw] trigger_type
|
4780
3750
|
# Specifies the type of flow trigger. It can be OnDemand, Scheduled,
|
4781
3751
|
# or Event.
|
@@ -4800,21 +3770,6 @@ module Aws::CustomerProfiles
|
|
4800
3770
|
# flow. Currently, these settings only apply to the Scheduled trigger
|
4801
3771
|
# type.
|
4802
3772
|
#
|
4803
|
-
# @note When making an API call, you may pass TriggerProperties
|
4804
|
-
# data as a hash:
|
4805
|
-
#
|
4806
|
-
# {
|
4807
|
-
# scheduled: {
|
4808
|
-
# schedule_expression: "ScheduleExpression", # required
|
4809
|
-
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
4810
|
-
# schedule_start_time: Time.now,
|
4811
|
-
# schedule_end_time: Time.now,
|
4812
|
-
# timezone: "Timezone",
|
4813
|
-
# schedule_offset: 1,
|
4814
|
-
# first_execution_from: Time.now,
|
4815
|
-
# },
|
4816
|
-
# }
|
4817
|
-
#
|
4818
3773
|
# @!attribute [rw] scheduled
|
4819
3774
|
# Specifies the configuration details of a schedule-triggered flow
|
4820
3775
|
# that you define.
|
@@ -4828,14 +3783,6 @@ module Aws::CustomerProfiles
|
|
4828
3783
|
include Aws::Structure
|
4829
3784
|
end
|
4830
3785
|
|
4831
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
4832
|
-
# data as a hash:
|
4833
|
-
#
|
4834
|
-
# {
|
4835
|
-
# resource_arn: "TagArn", # required
|
4836
|
-
# tag_keys: ["TagKey"], # required
|
4837
|
-
# }
|
4838
|
-
#
|
4839
3786
|
# @!attribute [rw] resource_arn
|
4840
3787
|
# The ARN of the resource from which you are removing tags.
|
4841
3788
|
# @return [String]
|
@@ -4859,22 +3806,6 @@ module Aws::CustomerProfiles
|
|
4859
3806
|
|
4860
3807
|
# Updates associated with the address properties of a customer profile.
|
4861
3808
|
#
|
4862
|
-
# @note When making an API call, you may pass UpdateAddress
|
4863
|
-
# data as a hash:
|
4864
|
-
#
|
4865
|
-
# {
|
4866
|
-
# address_1: "string0To255",
|
4867
|
-
# address_2: "string0To255",
|
4868
|
-
# address_3: "string0To255",
|
4869
|
-
# address_4: "string0To255",
|
4870
|
-
# city: "string0To255",
|
4871
|
-
# county: "string0To255",
|
4872
|
-
# state: "string0To255",
|
4873
|
-
# province: "string0To255",
|
4874
|
-
# country: "string0To255",
|
4875
|
-
# postal_code: "string0To255",
|
4876
|
-
# }
|
4877
|
-
#
|
4878
3809
|
# @!attribute [rw] address_1
|
4879
3810
|
# The first line of a customer address.
|
4880
3811
|
# @return [String]
|
@@ -4932,45 +3863,6 @@ module Aws::CustomerProfiles
|
|
4932
3863
|
include Aws::Structure
|
4933
3864
|
end
|
4934
3865
|
|
4935
|
-
# @note When making an API call, you may pass UpdateDomainRequest
|
4936
|
-
# data as a hash:
|
4937
|
-
#
|
4938
|
-
# {
|
4939
|
-
# domain_name: "name", # required
|
4940
|
-
# default_expiration_days: 1,
|
4941
|
-
# default_encryption_key: "encryptionKey",
|
4942
|
-
# dead_letter_queue_url: "sqsQueueUrl",
|
4943
|
-
# matching: {
|
4944
|
-
# enabled: false, # required
|
4945
|
-
# job_schedule: {
|
4946
|
-
# day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
4947
|
-
# time: "JobScheduleTime", # required
|
4948
|
-
# },
|
4949
|
-
# auto_merging: {
|
4950
|
-
# enabled: false, # required
|
4951
|
-
# consolidation: {
|
4952
|
-
# matching_attributes_list: [ # required
|
4953
|
-
# ["string1To255"],
|
4954
|
-
# ],
|
4955
|
-
# },
|
4956
|
-
# conflict_resolution: {
|
4957
|
-
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
4958
|
-
# source_name: "string1To255",
|
4959
|
-
# },
|
4960
|
-
# min_allowed_confidence_score_for_merging: 1.0,
|
4961
|
-
# },
|
4962
|
-
# exporting_config: {
|
4963
|
-
# s3_exporting: {
|
4964
|
-
# s3_bucket_name: "s3BucketName", # required
|
4965
|
-
# s3_key_name: "s3KeyNameCustomerOutputConfig",
|
4966
|
-
# },
|
4967
|
-
# },
|
4968
|
-
# },
|
4969
|
-
# tags: {
|
4970
|
-
# "TagKey" => "TagValue",
|
4971
|
-
# },
|
4972
|
-
# }
|
4973
|
-
#
|
4974
3866
|
# @!attribute [rw] domain_name
|
4975
3867
|
# The unique name of the domain.
|
4976
3868
|
# @return [String]
|
@@ -5096,81 +3988,6 @@ module Aws::CustomerProfiles
|
|
5096
3988
|
include Aws::Structure
|
5097
3989
|
end
|
5098
3990
|
|
5099
|
-
# @note When making an API call, you may pass UpdateProfileRequest
|
5100
|
-
# data as a hash:
|
5101
|
-
#
|
5102
|
-
# {
|
5103
|
-
# domain_name: "name", # required
|
5104
|
-
# profile_id: "uuid", # required
|
5105
|
-
# additional_information: "string0To1000",
|
5106
|
-
# account_number: "string0To255",
|
5107
|
-
# party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
|
5108
|
-
# business_name: "string0To255",
|
5109
|
-
# first_name: "string0To255",
|
5110
|
-
# middle_name: "string0To255",
|
5111
|
-
# last_name: "string0To255",
|
5112
|
-
# birth_date: "string0To255",
|
5113
|
-
# gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
|
5114
|
-
# phone_number: "string0To255",
|
5115
|
-
# mobile_phone_number: "string0To255",
|
5116
|
-
# home_phone_number: "string0To255",
|
5117
|
-
# business_phone_number: "string0To255",
|
5118
|
-
# email_address: "string0To255",
|
5119
|
-
# personal_email_address: "string0To255",
|
5120
|
-
# business_email_address: "string0To255",
|
5121
|
-
# address: {
|
5122
|
-
# address_1: "string0To255",
|
5123
|
-
# address_2: "string0To255",
|
5124
|
-
# address_3: "string0To255",
|
5125
|
-
# address_4: "string0To255",
|
5126
|
-
# city: "string0To255",
|
5127
|
-
# county: "string0To255",
|
5128
|
-
# state: "string0To255",
|
5129
|
-
# province: "string0To255",
|
5130
|
-
# country: "string0To255",
|
5131
|
-
# postal_code: "string0To255",
|
5132
|
-
# },
|
5133
|
-
# shipping_address: {
|
5134
|
-
# address_1: "string0To255",
|
5135
|
-
# address_2: "string0To255",
|
5136
|
-
# address_3: "string0To255",
|
5137
|
-
# address_4: "string0To255",
|
5138
|
-
# city: "string0To255",
|
5139
|
-
# county: "string0To255",
|
5140
|
-
# state: "string0To255",
|
5141
|
-
# province: "string0To255",
|
5142
|
-
# country: "string0To255",
|
5143
|
-
# postal_code: "string0To255",
|
5144
|
-
# },
|
5145
|
-
# mailing_address: {
|
5146
|
-
# address_1: "string0To255",
|
5147
|
-
# address_2: "string0To255",
|
5148
|
-
# address_3: "string0To255",
|
5149
|
-
# address_4: "string0To255",
|
5150
|
-
# city: "string0To255",
|
5151
|
-
# county: "string0To255",
|
5152
|
-
# state: "string0To255",
|
5153
|
-
# province: "string0To255",
|
5154
|
-
# country: "string0To255",
|
5155
|
-
# postal_code: "string0To255",
|
5156
|
-
# },
|
5157
|
-
# billing_address: {
|
5158
|
-
# address_1: "string0To255",
|
5159
|
-
# address_2: "string0To255",
|
5160
|
-
# address_3: "string0To255",
|
5161
|
-
# address_4: "string0To255",
|
5162
|
-
# city: "string0To255",
|
5163
|
-
# county: "string0To255",
|
5164
|
-
# state: "string0To255",
|
5165
|
-
# province: "string0To255",
|
5166
|
-
# country: "string0To255",
|
5167
|
-
# postal_code: "string0To255",
|
5168
|
-
# },
|
5169
|
-
# attributes: {
|
5170
|
-
# "string1To255" => "string0To255",
|
5171
|
-
# },
|
5172
|
-
# }
|
5173
|
-
#
|
5174
3991
|
# @!attribute [rw] domain_name
|
5175
3992
|
# The unique name of the domain.
|
5176
3993
|
# @return [String]
|
@@ -5266,6 +4083,14 @@ module Aws::CustomerProfiles
|
|
5266
4083
|
# A key value pair of attributes of a customer profile.
|
5267
4084
|
# @return [Hash<String,String>]
|
5268
4085
|
#
|
4086
|
+
# @!attribute [rw] party_type_string
|
4087
|
+
# An alternative to `PartyType` which accepts any string as input.
|
4088
|
+
# @return [String]
|
4089
|
+
#
|
4090
|
+
# @!attribute [rw] gender_string
|
4091
|
+
# An alternative to `Gender` which accepts any string as input.
|
4092
|
+
# @return [String]
|
4093
|
+
#
|
5269
4094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateProfileRequest AWS API Documentation
|
5270
4095
|
#
|
5271
4096
|
class UpdateProfileRequest < Struct.new(
|
@@ -5291,7 +4116,9 @@ module Aws::CustomerProfiles
|
|
5291
4116
|
:shipping_address,
|
5292
4117
|
:mailing_address,
|
5293
4118
|
:billing_address,
|
5294
|
-
:attributes
|
4119
|
+
:attributes,
|
4120
|
+
:party_type_string,
|
4121
|
+
:gender_string)
|
5295
4122
|
SENSITIVE = []
|
5296
4123
|
include Aws::Structure
|
5297
4124
|
end
|
@@ -5353,13 +4180,6 @@ module Aws::CustomerProfiles
|
|
5353
4180
|
|
5354
4181
|
# The properties that are applied when using Zendesk as a flow source.
|
5355
4182
|
#
|
5356
|
-
# @note When making an API call, you may pass ZendeskSourceProperties
|
5357
|
-
# data as a hash:
|
5358
|
-
#
|
5359
|
-
# {
|
5360
|
-
# object: "Object", # required
|
5361
|
-
# }
|
5362
|
-
#
|
5363
4183
|
# @!attribute [rw] object
|
5364
4184
|
# The object specified in the Zendesk flow source.
|
5365
4185
|
# @return [String]
|