aws-sdk-customerprofiles 1.18.0 → 1.21.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +371 -5
- data/lib/aws-sdk-customerprofiles/client_api.rb +210 -0
- data/lib/aws-sdk-customerprofiles/types.rb +878 -12
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- metadata +4 -4
@@ -38,7 +38,13 @@ module Aws::CustomerProfiles
|
|
38
38
|
# @return [String]
|
39
39
|
#
|
40
40
|
# @!attribute [rw] key_name
|
41
|
-
# A searchable identifier of a customer profile.
|
41
|
+
# A searchable identifier of a customer profile. The predefined keys
|
42
|
+
# you can use include: \_account, \_profileId, \_assetId, \_caseId,
|
43
|
+
# \_orderId, \_fullName, \_phone, \_email, \_ctrContactId,
|
44
|
+
# \_marketoLeadId, \_salesforceAccountId, \_salesforceContactId,
|
45
|
+
# \_salesforceAssetId, \_zendeskUserId, \_zendeskExternalId,
|
46
|
+
# \_zendeskTicketId, \_serviceNowSystemId, \_serviceNowIncidentId,
|
47
|
+
# \_segmentUserId, \_shopifyCustomerId, \_shopifyOrderId.
|
42
48
|
# @return [String]
|
43
49
|
#
|
44
50
|
# @!attribute [rw] values
|
@@ -153,6 +159,212 @@ module Aws::CustomerProfiles
|
|
153
159
|
include Aws::Structure
|
154
160
|
end
|
155
161
|
|
162
|
+
# Details for workflow of type `APPFLOW_INTEGRATION`.
|
163
|
+
#
|
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
|
+
# @!attribute [rw] flow_definition
|
240
|
+
# The configurations that control how Customer Profiles retrieves data
|
241
|
+
# from the source, Amazon AppFlow. Customer Profiles uses this
|
242
|
+
# information to create an AppFlow flow on behalf of customers.
|
243
|
+
# @return [Types::FlowDefinition]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] batches
|
246
|
+
# Batches in workflow of type `APPFLOW_INTEGRATION`.
|
247
|
+
# @return [Array<Types::Batch>]
|
248
|
+
#
|
249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AppflowIntegration AWS API Documentation
|
250
|
+
#
|
251
|
+
class AppflowIntegration < Struct.new(
|
252
|
+
:flow_definition,
|
253
|
+
:batches)
|
254
|
+
SENSITIVE = []
|
255
|
+
include Aws::Structure
|
256
|
+
end
|
257
|
+
|
258
|
+
# Structure holding all `APPFLOW_INTEGRATION` specific workflow
|
259
|
+
# attributes.
|
260
|
+
#
|
261
|
+
# @!attribute [rw] source_connector_type
|
262
|
+
# Specifies the source connector type, such as Salesforce, ServiceNow,
|
263
|
+
# and Marketo. Indicates source of ingestion.
|
264
|
+
# @return [String]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] connector_profile_name
|
267
|
+
# The name of the AppFlow connector profile used for ingestion.
|
268
|
+
# @return [String]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] role_arn
|
271
|
+
# The Amazon Resource Name (ARN) of the IAM role. Customer Profiles
|
272
|
+
# assumes this role to create resources on your behalf as part of
|
273
|
+
# workflow execution.
|
274
|
+
# @return [String]
|
275
|
+
#
|
276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AppflowIntegrationWorkflowAttributes AWS API Documentation
|
277
|
+
#
|
278
|
+
class AppflowIntegrationWorkflowAttributes < Struct.new(
|
279
|
+
:source_connector_type,
|
280
|
+
:connector_profile_name,
|
281
|
+
:role_arn)
|
282
|
+
SENSITIVE = []
|
283
|
+
include Aws::Structure
|
284
|
+
end
|
285
|
+
|
286
|
+
# Workflow specific execution metrics for `APPFLOW_INTEGRATION`
|
287
|
+
# workflow.
|
288
|
+
#
|
289
|
+
# @!attribute [rw] records_processed
|
290
|
+
# Number of records processed in `APPFLOW_INTEGRATION` workflow.
|
291
|
+
# @return [Integer]
|
292
|
+
#
|
293
|
+
# @!attribute [rw] steps_completed
|
294
|
+
# Total steps completed in `APPFLOW_INTEGRATION` workflow.
|
295
|
+
# @return [Integer]
|
296
|
+
#
|
297
|
+
# @!attribute [rw] total_steps
|
298
|
+
# Total steps in `APPFLOW_INTEGRATION` workflow.
|
299
|
+
# @return [Integer]
|
300
|
+
#
|
301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AppflowIntegrationWorkflowMetrics AWS API Documentation
|
302
|
+
#
|
303
|
+
class AppflowIntegrationWorkflowMetrics < Struct.new(
|
304
|
+
:records_processed,
|
305
|
+
:steps_completed,
|
306
|
+
:total_steps)
|
307
|
+
SENSITIVE = []
|
308
|
+
include Aws::Structure
|
309
|
+
end
|
310
|
+
|
311
|
+
# Workflow step details for `APPFLOW_INTEGRATION` workflow.
|
312
|
+
#
|
313
|
+
# @!attribute [rw] flow_name
|
314
|
+
# Name of the flow created during execution of workflow step.
|
315
|
+
# `APPFLOW_INTEGRATION` workflow type creates an appflow flow during
|
316
|
+
# workflow step execution on the customers behalf.
|
317
|
+
# @return [String]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] status
|
320
|
+
# Workflow step status for `APPFLOW_INTEGRATION` workflow.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] execution_message
|
324
|
+
# Message indicating execution of workflow step for
|
325
|
+
# `APPFLOW_INTEGRATION` workflow.
|
326
|
+
# @return [String]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] records_processed
|
329
|
+
# Total number of records processed during execution of workflow step
|
330
|
+
# for `APPFLOW_INTEGRATION` workflow.
|
331
|
+
# @return [Integer]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] batch_records_start_time
|
334
|
+
# Start datetime of records pulled in batch during execution of
|
335
|
+
# workflow step for `APPFLOW_INTEGRATION` workflow.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] batch_records_end_time
|
339
|
+
# End datetime of records pulled in batch during execution of workflow
|
340
|
+
# step for `APPFLOW_INTEGRATION` workflow.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] created_at
|
344
|
+
# Creation timestamp of workflow step for `APPFLOW_INTEGRATION`
|
345
|
+
# workflow.
|
346
|
+
# @return [Time]
|
347
|
+
#
|
348
|
+
# @!attribute [rw] last_updated_at
|
349
|
+
# Last updated timestamp for workflow step for `APPFLOW_INTEGRATION`
|
350
|
+
# workflow.
|
351
|
+
# @return [Time]
|
352
|
+
#
|
353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AppflowIntegrationWorkflowStep AWS API Documentation
|
354
|
+
#
|
355
|
+
class AppflowIntegrationWorkflowStep < Struct.new(
|
356
|
+
:flow_name,
|
357
|
+
:status,
|
358
|
+
:execution_message,
|
359
|
+
:records_processed,
|
360
|
+
:batch_records_start_time,
|
361
|
+
:batch_records_end_time,
|
362
|
+
:created_at,
|
363
|
+
:last_updated_at)
|
364
|
+
SENSITIVE = []
|
365
|
+
include Aws::Structure
|
366
|
+
end
|
367
|
+
|
156
368
|
# Configuration settings for how to perform the auto-merging of
|
157
369
|
# profiles.
|
158
370
|
#
|
@@ -170,6 +382,7 @@ module Aws::CustomerProfiles
|
|
170
382
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
171
383
|
# source_name: "string1To255",
|
172
384
|
# },
|
385
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
173
386
|
# }
|
174
387
|
#
|
175
388
|
# @!attribute [rw] enabled
|
@@ -189,12 +402,20 @@ module Aws::CustomerProfiles
|
|
189
402
|
# which `EmailAddress` should be used?
|
190
403
|
# @return [Types::ConflictResolution]
|
191
404
|
#
|
405
|
+
# @!attribute [rw] min_allowed_confidence_score_for_merging
|
406
|
+
# A number between 0 and 1 that represents the minimum confidence
|
407
|
+
# score required for profiles within a matching group to be merged
|
408
|
+
# during the auto-merge process. A higher score means higher
|
409
|
+
# similarity required to merge profiles.
|
410
|
+
# @return [Float]
|
411
|
+
#
|
192
412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AutoMerging AWS API Documentation
|
193
413
|
#
|
194
414
|
class AutoMerging < Struct.new(
|
195
415
|
:enabled,
|
196
416
|
:consolidation,
|
197
|
-
:conflict_resolution
|
417
|
+
:conflict_resolution,
|
418
|
+
:min_allowed_confidence_score_for_merging)
|
198
419
|
SENSITIVE = []
|
199
420
|
include Aws::Structure
|
200
421
|
end
|
@@ -212,6 +433,35 @@ module Aws::CustomerProfiles
|
|
212
433
|
include Aws::Structure
|
213
434
|
end
|
214
435
|
|
436
|
+
# Batch defines the boundaries for ingestion for each step in
|
437
|
+
# `APPFLOW_INTEGRATION` workflow. `APPFLOW_INTEGRATION` workflow splits
|
438
|
+
# ingestion based on these boundaries.
|
439
|
+
#
|
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
|
+
# @!attribute [rw] start_time
|
449
|
+
# Start time of batch to split ingestion.
|
450
|
+
# @return [Time]
|
451
|
+
#
|
452
|
+
# @!attribute [rw] end_time
|
453
|
+
# End time of batch to split ingestion.
|
454
|
+
# @return [Time]
|
455
|
+
#
|
456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Batch AWS API Documentation
|
457
|
+
#
|
458
|
+
class Batch < Struct.new(
|
459
|
+
:start_time,
|
460
|
+
:end_time)
|
461
|
+
SENSITIVE = []
|
462
|
+
include Aws::Structure
|
463
|
+
end
|
464
|
+
|
215
465
|
# How the auto-merging process should resolve conflicts between
|
216
466
|
# different profiles.
|
217
467
|
#
|
@@ -345,6 +595,7 @@ module Aws::CustomerProfiles
|
|
345
595
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
346
596
|
# source_name: "string1To255",
|
347
597
|
# },
|
598
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
348
599
|
# },
|
349
600
|
# exporting_config: {
|
350
601
|
# s3_exporting: {
|
@@ -481,6 +732,150 @@ module Aws::CustomerProfiles
|
|
481
732
|
include Aws::Structure
|
482
733
|
end
|
483
734
|
|
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
|
+
# @!attribute [rw] domain_name
|
822
|
+
# The unique name of the domain.
|
823
|
+
# @return [String]
|
824
|
+
#
|
825
|
+
# @!attribute [rw] workflow_type
|
826
|
+
# The type of workflow. The only supported value is
|
827
|
+
# APPFLOW\_INTEGRATION.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] integration_config
|
831
|
+
# Configuration data for integration workflow.
|
832
|
+
# @return [Types::IntegrationConfig]
|
833
|
+
#
|
834
|
+
# @!attribute [rw] object_type_name
|
835
|
+
# The name of the profile object type.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] role_arn
|
839
|
+
# The Amazon Resource Name (ARN) of the IAM role. Customer Profiles
|
840
|
+
# assumes this role to create resources on your behalf as part of
|
841
|
+
# workflow execution.
|
842
|
+
# @return [String]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] tags
|
845
|
+
# The tags used to organize, track, or control access for this
|
846
|
+
# resource.
|
847
|
+
# @return [Hash<String,String>]
|
848
|
+
#
|
849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateIntegrationWorkflowRequest AWS API Documentation
|
850
|
+
#
|
851
|
+
class CreateIntegrationWorkflowRequest < Struct.new(
|
852
|
+
:domain_name,
|
853
|
+
:workflow_type,
|
854
|
+
:integration_config,
|
855
|
+
:object_type_name,
|
856
|
+
:role_arn,
|
857
|
+
:tags)
|
858
|
+
SENSITIVE = []
|
859
|
+
include Aws::Structure
|
860
|
+
end
|
861
|
+
|
862
|
+
# @!attribute [rw] workflow_id
|
863
|
+
# Unique identifier for the workflow.
|
864
|
+
# @return [String]
|
865
|
+
#
|
866
|
+
# @!attribute [rw] message
|
867
|
+
# A message indicating create request was received.
|
868
|
+
# @return [String]
|
869
|
+
#
|
870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateIntegrationWorkflowResponse AWS API Documentation
|
871
|
+
#
|
872
|
+
class CreateIntegrationWorkflowResponse < Struct.new(
|
873
|
+
:workflow_id,
|
874
|
+
:message)
|
875
|
+
SENSITIVE = []
|
876
|
+
include Aws::Structure
|
877
|
+
end
|
878
|
+
|
484
879
|
# @note When making an API call, you may pass CreateProfileRequest
|
485
880
|
# data as a hash:
|
486
881
|
#
|
@@ -928,6 +1323,35 @@ module Aws::CustomerProfiles
|
|
928
1323
|
include Aws::Structure
|
929
1324
|
end
|
930
1325
|
|
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
|
+
# @!attribute [rw] domain_name
|
1335
|
+
# The unique name of the domain.
|
1336
|
+
# @return [String]
|
1337
|
+
#
|
1338
|
+
# @!attribute [rw] workflow_id
|
1339
|
+
# Unique identifier for the workflow.
|
1340
|
+
# @return [String]
|
1341
|
+
#
|
1342
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteWorkflowRequest AWS API Documentation
|
1343
|
+
#
|
1344
|
+
class DeleteWorkflowRequest < Struct.new(
|
1345
|
+
:domain_name,
|
1346
|
+
:workflow_id)
|
1347
|
+
SENSITIVE = []
|
1348
|
+
include Aws::Structure
|
1349
|
+
end
|
1350
|
+
|
1351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteWorkflowResponse AWS API Documentation
|
1352
|
+
#
|
1353
|
+
class DeleteWorkflowResponse < Aws::EmptyStructure; end
|
1354
|
+
|
931
1355
|
# Usage-specific statistics about the domain.
|
932
1356
|
#
|
933
1357
|
# @!attribute [rw] profile_count
|
@@ -1283,6 +1707,7 @@ module Aws::CustomerProfiles
|
|
1283
1707
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
1284
1708
|
# source_name: "string1To255",
|
1285
1709
|
# },
|
1710
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
1286
1711
|
# }
|
1287
1712
|
#
|
1288
1713
|
# @!attribute [rw] domain_name
|
@@ -1298,12 +1723,18 @@ module Aws::CustomerProfiles
|
|
1298
1723
|
# different profiles.
|
1299
1724
|
# @return [Types::ConflictResolution]
|
1300
1725
|
#
|
1726
|
+
# @!attribute [rw] min_allowed_confidence_score_for_merging
|
1727
|
+
# Minimum confidence score required for profiles within a matching
|
1728
|
+
# group to be merged during the auto-merge process.
|
1729
|
+
# @return [Float]
|
1730
|
+
#
|
1301
1731
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetAutoMergingPreviewRequest AWS API Documentation
|
1302
1732
|
#
|
1303
1733
|
class GetAutoMergingPreviewRequest < Struct.new(
|
1304
1734
|
:domain_name,
|
1305
1735
|
:consolidation,
|
1306
|
-
:conflict_resolution
|
1736
|
+
:conflict_resolution,
|
1737
|
+
:min_allowed_confidence_score_for_merging)
|
1307
1738
|
SENSITIVE = []
|
1308
1739
|
include Aws::Structure
|
1309
1740
|
end
|
@@ -1601,6 +2032,10 @@ module Aws::CustomerProfiles
|
|
1601
2032
|
# `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`.
|
1602
2033
|
# @return [Hash<String,String>]
|
1603
2034
|
#
|
2035
|
+
# @!attribute [rw] workflow_id
|
2036
|
+
# Unique identifier for the workflow.
|
2037
|
+
# @return [String]
|
2038
|
+
#
|
1604
2039
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegrationResponse AWS API Documentation
|
1605
2040
|
#
|
1606
2041
|
class GetIntegrationResponse < Struct.new(
|
@@ -1610,7 +2045,8 @@ module Aws::CustomerProfiles
|
|
1610
2045
|
:created_at,
|
1611
2046
|
:last_updated_at,
|
1612
2047
|
:tags,
|
1613
|
-
:object_type_names
|
2048
|
+
:object_type_names,
|
2049
|
+
:workflow_id)
|
1614
2050
|
SENSITIVE = []
|
1615
2051
|
include Aws::Structure
|
1616
2052
|
end
|
@@ -1843,6 +2279,147 @@ module Aws::CustomerProfiles
|
|
1843
2279
|
include Aws::Structure
|
1844
2280
|
end
|
1845
2281
|
|
2282
|
+
# @note When making an API call, you may pass GetWorkflowRequest
|
2283
|
+
# data as a hash:
|
2284
|
+
#
|
2285
|
+
# {
|
2286
|
+
# domain_name: "name", # required
|
2287
|
+
# workflow_id: "uuid", # required
|
2288
|
+
# }
|
2289
|
+
#
|
2290
|
+
# @!attribute [rw] domain_name
|
2291
|
+
# The unique name of the domain.
|
2292
|
+
# @return [String]
|
2293
|
+
#
|
2294
|
+
# @!attribute [rw] workflow_id
|
2295
|
+
# Unique identifier for the workflow.
|
2296
|
+
# @return [String]
|
2297
|
+
#
|
2298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetWorkflowRequest AWS API Documentation
|
2299
|
+
#
|
2300
|
+
class GetWorkflowRequest < Struct.new(
|
2301
|
+
:domain_name,
|
2302
|
+
:workflow_id)
|
2303
|
+
SENSITIVE = []
|
2304
|
+
include Aws::Structure
|
2305
|
+
end
|
2306
|
+
|
2307
|
+
# @!attribute [rw] workflow_id
|
2308
|
+
# Unique identifier for the workflow.
|
2309
|
+
# @return [String]
|
2310
|
+
#
|
2311
|
+
# @!attribute [rw] workflow_type
|
2312
|
+
# The type of workflow. The only supported value is
|
2313
|
+
# APPFLOW\_INTEGRATION.
|
2314
|
+
# @return [String]
|
2315
|
+
#
|
2316
|
+
# @!attribute [rw] status
|
2317
|
+
# Status of workflow execution.
|
2318
|
+
# @return [String]
|
2319
|
+
#
|
2320
|
+
# @!attribute [rw] error_description
|
2321
|
+
# Workflow error messages during execution (if any).
|
2322
|
+
# @return [String]
|
2323
|
+
#
|
2324
|
+
# @!attribute [rw] start_date
|
2325
|
+
# The timestamp that represents when workflow execution started.
|
2326
|
+
# @return [Time]
|
2327
|
+
#
|
2328
|
+
# @!attribute [rw] last_updated_at
|
2329
|
+
# The timestamp that represents when workflow execution last updated.
|
2330
|
+
# @return [Time]
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] attributes
|
2333
|
+
# Attributes provided for workflow execution.
|
2334
|
+
# @return [Types::WorkflowAttributes]
|
2335
|
+
#
|
2336
|
+
# @!attribute [rw] metrics
|
2337
|
+
# Workflow specific execution metrics.
|
2338
|
+
# @return [Types::WorkflowMetrics]
|
2339
|
+
#
|
2340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetWorkflowResponse AWS API Documentation
|
2341
|
+
#
|
2342
|
+
class GetWorkflowResponse < Struct.new(
|
2343
|
+
:workflow_id,
|
2344
|
+
:workflow_type,
|
2345
|
+
:status,
|
2346
|
+
:error_description,
|
2347
|
+
:start_date,
|
2348
|
+
:last_updated_at,
|
2349
|
+
:attributes,
|
2350
|
+
:metrics)
|
2351
|
+
SENSITIVE = []
|
2352
|
+
include Aws::Structure
|
2353
|
+
end
|
2354
|
+
|
2355
|
+
# @note When making an API call, you may pass GetWorkflowStepsRequest
|
2356
|
+
# data as a hash:
|
2357
|
+
#
|
2358
|
+
# {
|
2359
|
+
# domain_name: "name", # required
|
2360
|
+
# workflow_id: "uuid", # required
|
2361
|
+
# next_token: "token",
|
2362
|
+
# max_results: 1,
|
2363
|
+
# }
|
2364
|
+
#
|
2365
|
+
# @!attribute [rw] domain_name
|
2366
|
+
# The unique name of the domain.
|
2367
|
+
# @return [String]
|
2368
|
+
#
|
2369
|
+
# @!attribute [rw] workflow_id
|
2370
|
+
# Unique identifier for the workflow.
|
2371
|
+
# @return [String]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] next_token
|
2374
|
+
# The token for the next set of results. Use the value returned in the
|
2375
|
+
# previous response in the next request to retrieve the next set of
|
2376
|
+
# results.
|
2377
|
+
# @return [String]
|
2378
|
+
#
|
2379
|
+
# @!attribute [rw] max_results
|
2380
|
+
# The maximum number of results to return per page.
|
2381
|
+
# @return [Integer]
|
2382
|
+
#
|
2383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetWorkflowStepsRequest AWS API Documentation
|
2384
|
+
#
|
2385
|
+
class GetWorkflowStepsRequest < Struct.new(
|
2386
|
+
:domain_name,
|
2387
|
+
:workflow_id,
|
2388
|
+
:next_token,
|
2389
|
+
:max_results)
|
2390
|
+
SENSITIVE = []
|
2391
|
+
include Aws::Structure
|
2392
|
+
end
|
2393
|
+
|
2394
|
+
# @!attribute [rw] workflow_id
|
2395
|
+
# Unique identifier for the workflow.
|
2396
|
+
# @return [String]
|
2397
|
+
#
|
2398
|
+
# @!attribute [rw] workflow_type
|
2399
|
+
# The type of workflow. The only supported value is
|
2400
|
+
# APPFLOW\_INTEGRATION.
|
2401
|
+
# @return [String]
|
2402
|
+
#
|
2403
|
+
# @!attribute [rw] items
|
2404
|
+
# List containing workflow step details.
|
2405
|
+
# @return [Array<Types::WorkflowStepItem>]
|
2406
|
+
#
|
2407
|
+
# @!attribute [rw] next_token
|
2408
|
+
# If there are additional results, this is the token for the next set
|
2409
|
+
# of results.
|
2410
|
+
# @return [String]
|
2411
|
+
#
|
2412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetWorkflowStepsResponse AWS API Documentation
|
2413
|
+
#
|
2414
|
+
class GetWorkflowStepsResponse < Struct.new(
|
2415
|
+
:workflow_id,
|
2416
|
+
:workflow_type,
|
2417
|
+
:items,
|
2418
|
+
:next_token)
|
2419
|
+
SENSITIVE = []
|
2420
|
+
include Aws::Structure
|
2421
|
+
end
|
2422
|
+
|
1846
2423
|
# Information about the Identity Resolution Job.
|
1847
2424
|
#
|
1848
2425
|
# @!attribute [rw] domain_name
|
@@ -1940,6 +2517,97 @@ module Aws::CustomerProfiles
|
|
1940
2517
|
include Aws::Structure
|
1941
2518
|
end
|
1942
2519
|
|
2520
|
+
# Configuration data for integration workflow.
|
2521
|
+
#
|
2522
|
+
# @note When making an API call, you may pass IntegrationConfig
|
2523
|
+
# data as a hash:
|
2524
|
+
#
|
2525
|
+
# {
|
2526
|
+
# appflow_integration: {
|
2527
|
+
# flow_definition: { # required
|
2528
|
+
# description: "FlowDescription",
|
2529
|
+
# flow_name: "FlowName", # required
|
2530
|
+
# kms_arn: "KmsArn", # required
|
2531
|
+
# source_flow_config: { # required
|
2532
|
+
# connector_profile_name: "ConnectorProfileName",
|
2533
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
2534
|
+
# incremental_pull_config: {
|
2535
|
+
# datetime_type_field_name: "DatetimeTypeFieldName",
|
2536
|
+
# },
|
2537
|
+
# source_connector_properties: { # required
|
2538
|
+
# marketo: {
|
2539
|
+
# object: "Object", # required
|
2540
|
+
# },
|
2541
|
+
# s3: {
|
2542
|
+
# bucket_name: "BucketName", # required
|
2543
|
+
# bucket_prefix: "BucketPrefix",
|
2544
|
+
# },
|
2545
|
+
# salesforce: {
|
2546
|
+
# object: "Object", # required
|
2547
|
+
# enable_dynamic_field_update: false,
|
2548
|
+
# include_deleted_records: false,
|
2549
|
+
# },
|
2550
|
+
# service_now: {
|
2551
|
+
# object: "Object", # required
|
2552
|
+
# },
|
2553
|
+
# zendesk: {
|
2554
|
+
# object: "Object", # required
|
2555
|
+
# },
|
2556
|
+
# },
|
2557
|
+
# },
|
2558
|
+
# tasks: [ # required
|
2559
|
+
# {
|
2560
|
+
# connector_operator: {
|
2561
|
+
# 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
|
2562
|
+
# 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
|
2563
|
+
# 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
|
2564
|
+
# 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
|
2565
|
+
# 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
|
2566
|
+
# },
|
2567
|
+
# destination_field: "DestinationField",
|
2568
|
+
# source_fields: ["stringTo2048"], # required
|
2569
|
+
# task_properties: {
|
2570
|
+
# "VALUE" => "Property",
|
2571
|
+
# },
|
2572
|
+
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
2573
|
+
# },
|
2574
|
+
# ],
|
2575
|
+
# trigger_config: { # required
|
2576
|
+
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
2577
|
+
# trigger_properties: {
|
2578
|
+
# scheduled: {
|
2579
|
+
# schedule_expression: "ScheduleExpression", # required
|
2580
|
+
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
2581
|
+
# schedule_start_time: Time.now,
|
2582
|
+
# schedule_end_time: Time.now,
|
2583
|
+
# timezone: "Timezone",
|
2584
|
+
# schedule_offset: 1,
|
2585
|
+
# first_execution_from: Time.now,
|
2586
|
+
# },
|
2587
|
+
# },
|
2588
|
+
# },
|
2589
|
+
# },
|
2590
|
+
# batches: [
|
2591
|
+
# {
|
2592
|
+
# start_time: Time.now, # required
|
2593
|
+
# end_time: Time.now, # required
|
2594
|
+
# },
|
2595
|
+
# ],
|
2596
|
+
# },
|
2597
|
+
# }
|
2598
|
+
#
|
2599
|
+
# @!attribute [rw] appflow_integration
|
2600
|
+
# Configuration data for `APPFLOW_INTEGRATION` workflow type.
|
2601
|
+
# @return [Types::AppflowIntegration]
|
2602
|
+
#
|
2603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/IntegrationConfig AWS API Documentation
|
2604
|
+
#
|
2605
|
+
class IntegrationConfig < Struct.new(
|
2606
|
+
:appflow_integration)
|
2607
|
+
SENSITIVE = []
|
2608
|
+
include Aws::Structure
|
2609
|
+
end
|
2610
|
+
|
1943
2611
|
# An internal service error occurred.
|
1944
2612
|
#
|
1945
2613
|
# @!attribute [rw] message
|
@@ -2012,6 +2680,7 @@ module Aws::CustomerProfiles
|
|
2012
2680
|
# uri: "string1To255", # required
|
2013
2681
|
# next_token: "token",
|
2014
2682
|
# max_results: 1,
|
2683
|
+
# include_hidden: false,
|
2015
2684
|
# }
|
2016
2685
|
#
|
2017
2686
|
# @!attribute [rw] uri
|
@@ -2027,12 +2696,18 @@ module Aws::CustomerProfiles
|
|
2027
2696
|
# The maximum number of objects returned per page.
|
2028
2697
|
# @return [Integer]
|
2029
2698
|
#
|
2699
|
+
# @!attribute [rw] include_hidden
|
2700
|
+
# Boolean to indicate if hidden integration should be returned.
|
2701
|
+
# Defaults to `False`.
|
2702
|
+
# @return [Boolean]
|
2703
|
+
#
|
2030
2704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListAccountIntegrationsRequest AWS API Documentation
|
2031
2705
|
#
|
2032
2706
|
class ListAccountIntegrationsRequest < Struct.new(
|
2033
2707
|
:uri,
|
2034
2708
|
:next_token,
|
2035
|
-
:max_results
|
2709
|
+
:max_results,
|
2710
|
+
:include_hidden)
|
2036
2711
|
SENSITIVE = []
|
2037
2712
|
include Aws::Structure
|
2038
2713
|
end
|
@@ -2215,6 +2890,10 @@ module Aws::CustomerProfiles
|
|
2215
2890
|
# `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`.
|
2216
2891
|
# @return [Hash<String,String>]
|
2217
2892
|
#
|
2893
|
+
# @!attribute [rw] workflow_id
|
2894
|
+
# Unique identifier for the workflow.
|
2895
|
+
# @return [String]
|
2896
|
+
#
|
2218
2897
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationItem AWS API Documentation
|
2219
2898
|
#
|
2220
2899
|
class ListIntegrationItem < Struct.new(
|
@@ -2224,7 +2903,8 @@ module Aws::CustomerProfiles
|
|
2224
2903
|
:created_at,
|
2225
2904
|
:last_updated_at,
|
2226
2905
|
:tags,
|
2227
|
-
:object_type_names
|
2906
|
+
:object_type_names,
|
2907
|
+
:workflow_id)
|
2228
2908
|
SENSITIVE = []
|
2229
2909
|
include Aws::Structure
|
2230
2910
|
end
|
@@ -2236,6 +2916,7 @@ module Aws::CustomerProfiles
|
|
2236
2916
|
# domain_name: "name", # required
|
2237
2917
|
# next_token: "token",
|
2238
2918
|
# max_results: 1,
|
2919
|
+
# include_hidden: false,
|
2239
2920
|
# }
|
2240
2921
|
#
|
2241
2922
|
# @!attribute [rw] domain_name
|
@@ -2250,12 +2931,18 @@ module Aws::CustomerProfiles
|
|
2250
2931
|
# The maximum number of objects returned per page.
|
2251
2932
|
# @return [Integer]
|
2252
2933
|
#
|
2934
|
+
# @!attribute [rw] include_hidden
|
2935
|
+
# Boolean to indicate if hidden integration should be returned.
|
2936
|
+
# Defaults to `False`.
|
2937
|
+
# @return [Boolean]
|
2938
|
+
#
|
2253
2939
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsRequest AWS API Documentation
|
2254
2940
|
#
|
2255
2941
|
class ListIntegrationsRequest < Struct.new(
|
2256
2942
|
:domain_name,
|
2257
2943
|
:next_token,
|
2258
|
-
:max_results
|
2944
|
+
:max_results,
|
2945
|
+
:include_hidden)
|
2259
2946
|
SENSITIVE = []
|
2260
2947
|
include Aws::Structure
|
2261
2948
|
end
|
@@ -2556,6 +3243,122 @@ module Aws::CustomerProfiles
|
|
2556
3243
|
include Aws::Structure
|
2557
3244
|
end
|
2558
3245
|
|
3246
|
+
# A workflow in list of workflows.
|
3247
|
+
#
|
3248
|
+
# @!attribute [rw] workflow_type
|
3249
|
+
# The type of workflow. The only supported value is
|
3250
|
+
# APPFLOW\_INTEGRATION.
|
3251
|
+
# @return [String]
|
3252
|
+
#
|
3253
|
+
# @!attribute [rw] workflow_id
|
3254
|
+
# Unique identifier for the workflow.
|
3255
|
+
# @return [String]
|
3256
|
+
#
|
3257
|
+
# @!attribute [rw] status
|
3258
|
+
# Status of workflow execution.
|
3259
|
+
# @return [String]
|
3260
|
+
#
|
3261
|
+
# @!attribute [rw] status_description
|
3262
|
+
# Description for workflow execution status.
|
3263
|
+
# @return [String]
|
3264
|
+
#
|
3265
|
+
# @!attribute [rw] created_at
|
3266
|
+
# Creation timestamp for workflow.
|
3267
|
+
# @return [Time]
|
3268
|
+
#
|
3269
|
+
# @!attribute [rw] last_updated_at
|
3270
|
+
# Last updated timestamp for workflow.
|
3271
|
+
# @return [Time]
|
3272
|
+
#
|
3273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListWorkflowsItem AWS API Documentation
|
3274
|
+
#
|
3275
|
+
class ListWorkflowsItem < Struct.new(
|
3276
|
+
:workflow_type,
|
3277
|
+
:workflow_id,
|
3278
|
+
:status,
|
3279
|
+
:status_description,
|
3280
|
+
:created_at,
|
3281
|
+
:last_updated_at)
|
3282
|
+
SENSITIVE = []
|
3283
|
+
include Aws::Structure
|
3284
|
+
end
|
3285
|
+
|
3286
|
+
# @note When making an API call, you may pass ListWorkflowsRequest
|
3287
|
+
# data as a hash:
|
3288
|
+
#
|
3289
|
+
# {
|
3290
|
+
# domain_name: "name", # required
|
3291
|
+
# workflow_type: "APPFLOW_INTEGRATION", # accepts APPFLOW_INTEGRATION
|
3292
|
+
# status: "NOT_STARTED", # accepts NOT_STARTED, IN_PROGRESS, COMPLETE, FAILED, SPLIT, RETRY, CANCELLED
|
3293
|
+
# query_start_date: Time.now,
|
3294
|
+
# query_end_date: Time.now,
|
3295
|
+
# next_token: "token",
|
3296
|
+
# max_results: 1,
|
3297
|
+
# }
|
3298
|
+
#
|
3299
|
+
# @!attribute [rw] domain_name
|
3300
|
+
# The unique name of the domain.
|
3301
|
+
# @return [String]
|
3302
|
+
#
|
3303
|
+
# @!attribute [rw] workflow_type
|
3304
|
+
# The type of workflow. The only supported value is
|
3305
|
+
# APPFLOW\_INTEGRATION.
|
3306
|
+
# @return [String]
|
3307
|
+
#
|
3308
|
+
# @!attribute [rw] status
|
3309
|
+
# Status of workflow execution.
|
3310
|
+
# @return [String]
|
3311
|
+
#
|
3312
|
+
# @!attribute [rw] query_start_date
|
3313
|
+
# Retrieve workflows started after timestamp.
|
3314
|
+
# @return [Time]
|
3315
|
+
#
|
3316
|
+
# @!attribute [rw] query_end_date
|
3317
|
+
# Retrieve workflows ended after timestamp.
|
3318
|
+
# @return [Time]
|
3319
|
+
#
|
3320
|
+
# @!attribute [rw] next_token
|
3321
|
+
# The token for the next set of results. Use the value returned in the
|
3322
|
+
# previous response in the next request to retrieve the next set of
|
3323
|
+
# results.
|
3324
|
+
# @return [String]
|
3325
|
+
#
|
3326
|
+
# @!attribute [rw] max_results
|
3327
|
+
# The maximum number of results to return per page.
|
3328
|
+
# @return [Integer]
|
3329
|
+
#
|
3330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListWorkflowsRequest AWS API Documentation
|
3331
|
+
#
|
3332
|
+
class ListWorkflowsRequest < Struct.new(
|
3333
|
+
:domain_name,
|
3334
|
+
:workflow_type,
|
3335
|
+
:status,
|
3336
|
+
:query_start_date,
|
3337
|
+
:query_end_date,
|
3338
|
+
:next_token,
|
3339
|
+
:max_results)
|
3340
|
+
SENSITIVE = []
|
3341
|
+
include Aws::Structure
|
3342
|
+
end
|
3343
|
+
|
3344
|
+
# @!attribute [rw] items
|
3345
|
+
# List containing workflow details.
|
3346
|
+
# @return [Array<Types::ListWorkflowsItem>]
|
3347
|
+
#
|
3348
|
+
# @!attribute [rw] next_token
|
3349
|
+
# If there are additional results, this is the token for the next set
|
3350
|
+
# of results.
|
3351
|
+
# @return [String]
|
3352
|
+
#
|
3353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListWorkflowsResponse AWS API Documentation
|
3354
|
+
#
|
3355
|
+
class ListWorkflowsResponse < Struct.new(
|
3356
|
+
:items,
|
3357
|
+
:next_token)
|
3358
|
+
SENSITIVE = []
|
3359
|
+
include Aws::Structure
|
3360
|
+
end
|
3361
|
+
|
2559
3362
|
# The properties that are applied when Marketo is being used as a
|
2560
3363
|
# source.
|
2561
3364
|
#
|
@@ -2589,9 +3392,15 @@ module Aws::CustomerProfiles
|
|
2589
3392
|
# @return [Array<String>]
|
2590
3393
|
#
|
2591
3394
|
# @!attribute [rw] confidence_score
|
2592
|
-
# A number between 0 and 1
|
2593
|
-
#
|
2594
|
-
#
|
3395
|
+
# A number between 0 and 1, where a higher score means higher
|
3396
|
+
# similarity. Examining match confidence scores lets you distinguish
|
3397
|
+
# between groups of similar records in which the system is highly
|
3398
|
+
# confident (which you may decide to merge), groups of similar records
|
3399
|
+
# about which the system is uncertain (which you may decide to have
|
3400
|
+
# reviewed by a human), and groups of similar records that the system
|
3401
|
+
# deems to be unlikely (which you may decide to reject). Given
|
3402
|
+
# confidence scores vary as per the data input, it should not be used
|
3403
|
+
# an absolute measure of matching quality.
|
2595
3404
|
# @return [Float]
|
2596
3405
|
#
|
2597
3406
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MatchItem AWS API Documentation
|
@@ -2626,6 +3435,7 @@ module Aws::CustomerProfiles
|
|
2626
3435
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
2627
3436
|
# source_name: "string1To255",
|
2628
3437
|
# },
|
3438
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
2629
3439
|
# },
|
2630
3440
|
# exporting_config: {
|
2631
3441
|
# s3_exporting: {
|
@@ -3159,6 +3969,10 @@ module Aws::CustomerProfiles
|
|
3159
3969
|
# `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`.
|
3160
3970
|
# @return [Hash<String,String>]
|
3161
3971
|
#
|
3972
|
+
# @!attribute [rw] workflow_id
|
3973
|
+
# Unique identifier for the workflow.
|
3974
|
+
# @return [String]
|
3975
|
+
#
|
3162
3976
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegrationResponse AWS API Documentation
|
3163
3977
|
#
|
3164
3978
|
class PutIntegrationResponse < Struct.new(
|
@@ -3168,7 +3982,8 @@ module Aws::CustomerProfiles
|
|
3168
3982
|
:created_at,
|
3169
3983
|
:last_updated_at,
|
3170
3984
|
:tags,
|
3171
|
-
:object_type_names
|
3985
|
+
:object_type_names,
|
3986
|
+
:workflow_id)
|
3172
3987
|
SENSITIVE = []
|
3173
3988
|
include Aws::Structure
|
3174
3989
|
end
|
@@ -3262,7 +4077,14 @@ module Aws::CustomerProfiles
|
|
3262
4077
|
# @return [String]
|
3263
4078
|
#
|
3264
4079
|
# @!attribute [rw] template_id
|
3265
|
-
# A unique identifier for the object template.
|
4080
|
+
# A unique identifier for the object template. For some attributes in
|
4081
|
+
# the request, the service will use the default value from the object
|
4082
|
+
# template when TemplateId is present. If these attributes are present
|
4083
|
+
# in the request, the service may return a `BadRequestException`.
|
4084
|
+
# These attributes include: AllowProfileCreation,
|
4085
|
+
# SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
|
4086
|
+
# AllowProfileCreation is set to true when TemplateId is set, the
|
4087
|
+
# service may return a `BadRequestException`.
|
3266
4088
|
# @return [String]
|
3267
4089
|
#
|
3268
4090
|
# @!attribute [rw] expiration_days
|
@@ -4114,6 +4936,7 @@ module Aws::CustomerProfiles
|
|
4114
4936
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
4115
4937
|
# source_name: "string1To255",
|
4116
4938
|
# },
|
4939
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
4117
4940
|
# },
|
4118
4941
|
# exporting_config: {
|
4119
4942
|
# s3_exporting: {
|
@@ -4464,6 +5287,49 @@ module Aws::CustomerProfiles
|
|
4464
5287
|
include Aws::Structure
|
4465
5288
|
end
|
4466
5289
|
|
5290
|
+
# Structure to hold workflow attributes.
|
5291
|
+
#
|
5292
|
+
# @!attribute [rw] appflow_integration
|
5293
|
+
# Workflow attributes specific to `APPFLOW_INTEGRATION` workflow.
|
5294
|
+
# @return [Types::AppflowIntegrationWorkflowAttributes]
|
5295
|
+
#
|
5296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/WorkflowAttributes AWS API Documentation
|
5297
|
+
#
|
5298
|
+
class WorkflowAttributes < Struct.new(
|
5299
|
+
:appflow_integration)
|
5300
|
+
SENSITIVE = []
|
5301
|
+
include Aws::Structure
|
5302
|
+
end
|
5303
|
+
|
5304
|
+
# Generic object containing workflow execution metrics.
|
5305
|
+
#
|
5306
|
+
# @!attribute [rw] appflow_integration
|
5307
|
+
# Workflow execution metrics for `APPFLOW_INTEGRATION` workflow.
|
5308
|
+
# @return [Types::AppflowIntegrationWorkflowMetrics]
|
5309
|
+
#
|
5310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/WorkflowMetrics AWS API Documentation
|
5311
|
+
#
|
5312
|
+
class WorkflowMetrics < Struct.new(
|
5313
|
+
:appflow_integration)
|
5314
|
+
SENSITIVE = []
|
5315
|
+
include Aws::Structure
|
5316
|
+
end
|
5317
|
+
|
5318
|
+
# List containing steps in workflow.
|
5319
|
+
#
|
5320
|
+
# @!attribute [rw] appflow_integration
|
5321
|
+
# Workflow step information specific to `APPFLOW_INTEGRATION`
|
5322
|
+
# workflow.
|
5323
|
+
# @return [Types::AppflowIntegrationWorkflowStep]
|
5324
|
+
#
|
5325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/WorkflowStepItem AWS API Documentation
|
5326
|
+
#
|
5327
|
+
class WorkflowStepItem < Struct.new(
|
5328
|
+
:appflow_integration)
|
5329
|
+
SENSITIVE = []
|
5330
|
+
include Aws::Structure
|
5331
|
+
end
|
5332
|
+
|
4467
5333
|
# The properties that are applied when using Zendesk as a flow source.
|
4468
5334
|
#
|
4469
5335
|
# @note When making an API call, you may pass ZendeskSourceProperties
|