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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1cf8252e3e392e9db017f0496fb466f12e1e6c4175df18911628f7204d7fee3f
|
4
|
+
data.tar.gz: e574411ae7d0fb5fffc597863a7147b0e03a368efeea1d54a3d5615c7f7c66b6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7ed826c479c4f35dccb78b28c13a14f4b4cc90b9c2fcf2a210f9769b4675aa80b255f65d14855d3940db0125b39aa2809bcda94acc0e2a51a1287f18be91d057
|
7
|
+
data.tar.gz: 3e837f6b804a568c1bf6b4bf541979e51eeaaee932226f64e8e6c22b0c7e78d558e4096146dbed7638c991c6149c7c37b4a54153345d79bfc8b7c0ceb1e9b74d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.21.0 (2022-06-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds the optional MinAllowedConfidenceScoreForMerging parameter to the CreateDomain, UpdateDomain, and GetAutoMergingPreview APIs in Customer Profiles. This parameter is used as a threshold to influence the profile auto-merging step of the Identity Resolution process.
|
8
|
+
|
9
|
+
1.20.0 (2022-02-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.19.0 (2022-02-21)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release introduces apis CreateIntegrationWorkflow, DeleteWorkflow, ListWorkflows, GetWorkflow and GetWorkflowSteps. These apis are used to manage and view integration workflows.
|
18
|
+
|
4
19
|
1.18.0 (2022-02-03)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.21.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
@@ -75,6 +76,7 @@ module Aws::CustomerProfiles
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
@@ -360,7 +362,13 @@ module Aws::CustomerProfiles
|
|
360
362
|
# The unique identifier of a customer profile.
|
361
363
|
#
|
362
364
|
# @option params [required, String] :key_name
|
363
|
-
# A searchable identifier of a customer profile.
|
365
|
+
# A searchable identifier of a customer profile. The predefined keys you
|
366
|
+
# can use include: \_account, \_profileId, \_assetId, \_caseId,
|
367
|
+
# \_orderId, \_fullName, \_phone, \_email, \_ctrContactId,
|
368
|
+
# \_marketoLeadId, \_salesforceAccountId, \_salesforceContactId,
|
369
|
+
# \_salesforceAssetId, \_zendeskUserId, \_zendeskExternalId,
|
370
|
+
# \_zendeskTicketId, \_serviceNowSystemId, \_serviceNowIncidentId,
|
371
|
+
# \_segmentUserId, \_shopifyCustomerId, \_shopifyOrderId.
|
364
372
|
#
|
365
373
|
# @option params [required, Array<String>] :values
|
366
374
|
# A list of key values.
|
@@ -490,6 +498,7 @@ module Aws::CustomerProfiles
|
|
490
498
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
491
499
|
# source_name: "string1To255",
|
492
500
|
# },
|
501
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
493
502
|
# },
|
494
503
|
# exporting_config: {
|
495
504
|
# s3_exporting: {
|
@@ -518,6 +527,7 @@ module Aws::CustomerProfiles
|
|
518
527
|
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
519
528
|
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
520
529
|
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
530
|
+
# resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
|
521
531
|
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
522
532
|
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
523
533
|
# resp.created_at #=> Time
|
@@ -534,6 +544,136 @@ module Aws::CustomerProfiles
|
|
534
544
|
req.send_request(options)
|
535
545
|
end
|
536
546
|
|
547
|
+
# Creates an integration workflow. An integration workflow is an async
|
548
|
+
# process which ingests historic data and sets up an integration for
|
549
|
+
# ongoing updates. The supported Amazon AppFlow sources are Salesforce,
|
550
|
+
# ServiceNow, and Marketo.
|
551
|
+
#
|
552
|
+
# @option params [required, String] :domain_name
|
553
|
+
# The unique name of the domain.
|
554
|
+
#
|
555
|
+
# @option params [required, String] :workflow_type
|
556
|
+
# The type of workflow. The only supported value is
|
557
|
+
# APPFLOW\_INTEGRATION.
|
558
|
+
#
|
559
|
+
# @option params [required, Types::IntegrationConfig] :integration_config
|
560
|
+
# Configuration data for integration workflow.
|
561
|
+
#
|
562
|
+
# @option params [required, String] :object_type_name
|
563
|
+
# The name of the profile object type.
|
564
|
+
#
|
565
|
+
# @option params [required, String] :role_arn
|
566
|
+
# The Amazon Resource Name (ARN) of the IAM role. Customer Profiles
|
567
|
+
# assumes this role to create resources on your behalf as part of
|
568
|
+
# workflow execution.
|
569
|
+
#
|
570
|
+
# @option params [Hash<String,String>] :tags
|
571
|
+
# The tags used to organize, track, or control access for this resource.
|
572
|
+
#
|
573
|
+
# @return [Types::CreateIntegrationWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
574
|
+
#
|
575
|
+
# * {Types::CreateIntegrationWorkflowResponse#workflow_id #workflow_id} => String
|
576
|
+
# * {Types::CreateIntegrationWorkflowResponse#message #message} => String
|
577
|
+
#
|
578
|
+
# @example Request syntax with placeholder values
|
579
|
+
#
|
580
|
+
# resp = client.create_integration_workflow({
|
581
|
+
# domain_name: "name", # required
|
582
|
+
# workflow_type: "APPFLOW_INTEGRATION", # required, accepts APPFLOW_INTEGRATION
|
583
|
+
# integration_config: { # required
|
584
|
+
# appflow_integration: {
|
585
|
+
# flow_definition: { # required
|
586
|
+
# description: "FlowDescription",
|
587
|
+
# flow_name: "FlowName", # required
|
588
|
+
# kms_arn: "KmsArn", # required
|
589
|
+
# source_flow_config: { # required
|
590
|
+
# connector_profile_name: "ConnectorProfileName",
|
591
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
592
|
+
# incremental_pull_config: {
|
593
|
+
# datetime_type_field_name: "DatetimeTypeFieldName",
|
594
|
+
# },
|
595
|
+
# source_connector_properties: { # required
|
596
|
+
# marketo: {
|
597
|
+
# object: "Object", # required
|
598
|
+
# },
|
599
|
+
# s3: {
|
600
|
+
# bucket_name: "BucketName", # required
|
601
|
+
# bucket_prefix: "BucketPrefix",
|
602
|
+
# },
|
603
|
+
# salesforce: {
|
604
|
+
# object: "Object", # required
|
605
|
+
# enable_dynamic_field_update: false,
|
606
|
+
# include_deleted_records: false,
|
607
|
+
# },
|
608
|
+
# service_now: {
|
609
|
+
# object: "Object", # required
|
610
|
+
# },
|
611
|
+
# zendesk: {
|
612
|
+
# object: "Object", # required
|
613
|
+
# },
|
614
|
+
# },
|
615
|
+
# },
|
616
|
+
# tasks: [ # required
|
617
|
+
# {
|
618
|
+
# connector_operator: {
|
619
|
+
# 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
|
620
|
+
# 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
|
621
|
+
# 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
|
622
|
+
# 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
|
623
|
+
# 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
|
624
|
+
# },
|
625
|
+
# destination_field: "DestinationField",
|
626
|
+
# source_fields: ["stringTo2048"], # required
|
627
|
+
# task_properties: {
|
628
|
+
# "VALUE" => "Property",
|
629
|
+
# },
|
630
|
+
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
631
|
+
# },
|
632
|
+
# ],
|
633
|
+
# trigger_config: { # required
|
634
|
+
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
635
|
+
# trigger_properties: {
|
636
|
+
# scheduled: {
|
637
|
+
# schedule_expression: "ScheduleExpression", # required
|
638
|
+
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
639
|
+
# schedule_start_time: Time.now,
|
640
|
+
# schedule_end_time: Time.now,
|
641
|
+
# timezone: "Timezone",
|
642
|
+
# schedule_offset: 1,
|
643
|
+
# first_execution_from: Time.now,
|
644
|
+
# },
|
645
|
+
# },
|
646
|
+
# },
|
647
|
+
# },
|
648
|
+
# batches: [
|
649
|
+
# {
|
650
|
+
# start_time: Time.now, # required
|
651
|
+
# end_time: Time.now, # required
|
652
|
+
# },
|
653
|
+
# ],
|
654
|
+
# },
|
655
|
+
# },
|
656
|
+
# object_type_name: "typeName", # required
|
657
|
+
# role_arn: "RoleArn", # required
|
658
|
+
# tags: {
|
659
|
+
# "TagKey" => "TagValue",
|
660
|
+
# },
|
661
|
+
# })
|
662
|
+
#
|
663
|
+
# @example Response structure
|
664
|
+
#
|
665
|
+
# resp.workflow_id #=> String
|
666
|
+
# resp.message #=> String
|
667
|
+
#
|
668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateIntegrationWorkflow AWS API Documentation
|
669
|
+
#
|
670
|
+
# @overload create_integration_workflow(params = {})
|
671
|
+
# @param [Hash] params ({})
|
672
|
+
def create_integration_workflow(params = {}, options = {})
|
673
|
+
req = build_request(:create_integration_workflow, params)
|
674
|
+
req.send_request(options)
|
675
|
+
end
|
676
|
+
|
537
677
|
# Creates a standard profile.
|
538
678
|
#
|
539
679
|
# A standard profile represents the following attributes for a customer
|
@@ -909,6 +1049,33 @@ module Aws::CustomerProfiles
|
|
909
1049
|
req.send_request(options)
|
910
1050
|
end
|
911
1051
|
|
1052
|
+
# Deletes the specified workflow and all its corresponding resources.
|
1053
|
+
# This is an async process.
|
1054
|
+
#
|
1055
|
+
# @option params [required, String] :domain_name
|
1056
|
+
# The unique name of the domain.
|
1057
|
+
#
|
1058
|
+
# @option params [required, String] :workflow_id
|
1059
|
+
# Unique identifier for the workflow.
|
1060
|
+
#
|
1061
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1062
|
+
#
|
1063
|
+
# @example Request syntax with placeholder values
|
1064
|
+
#
|
1065
|
+
# resp = client.delete_workflow({
|
1066
|
+
# domain_name: "name", # required
|
1067
|
+
# workflow_id: "string1To255", # required
|
1068
|
+
# })
|
1069
|
+
#
|
1070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteWorkflow AWS API Documentation
|
1071
|
+
#
|
1072
|
+
# @overload delete_workflow(params = {})
|
1073
|
+
# @param [Hash] params ({})
|
1074
|
+
def delete_workflow(params = {}, options = {})
|
1075
|
+
req = build_request(:delete_workflow, params)
|
1076
|
+
req.send_request(options)
|
1077
|
+
end
|
1078
|
+
|
912
1079
|
# Tests the auto-merging settings of your Identity Resolution Job
|
913
1080
|
# without merging your data. It randomly selects a sample of matching
|
914
1081
|
# groups from the existing matching results, and applies the automerging
|
@@ -936,6 +1103,10 @@ module Aws::CustomerProfiles
|
|
936
1103
|
# How the auto-merging process should resolve conflicts between
|
937
1104
|
# different profiles.
|
938
1105
|
#
|
1106
|
+
# @option params [Float] :min_allowed_confidence_score_for_merging
|
1107
|
+
# Minimum confidence score required for profiles within a matching group
|
1108
|
+
# to be merged during the auto-merge process.
|
1109
|
+
#
|
939
1110
|
# @return [Types::GetAutoMergingPreviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
940
1111
|
#
|
941
1112
|
# * {Types::GetAutoMergingPreviewResponse#domain_name #domain_name} => String
|
@@ -956,6 +1127,7 @@ module Aws::CustomerProfiles
|
|
956
1127
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
957
1128
|
# source_name: "string1To255",
|
958
1129
|
# },
|
1130
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
959
1131
|
# })
|
960
1132
|
#
|
961
1133
|
# @example Response structure
|
@@ -1016,6 +1188,7 @@ module Aws::CustomerProfiles
|
|
1016
1188
|
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
1017
1189
|
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
1018
1190
|
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
1191
|
+
# resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
|
1019
1192
|
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
1020
1193
|
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
1021
1194
|
# resp.created_at #=> Time
|
@@ -1086,6 +1259,7 @@ module Aws::CustomerProfiles
|
|
1086
1259
|
# resp.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
1087
1260
|
# resp.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
1088
1261
|
# resp.auto_merging.conflict_resolution.source_name #=> String
|
1262
|
+
# resp.auto_merging.min_allowed_confidence_score_for_merging #=> Float
|
1089
1263
|
# resp.exporting_location.s3_exporting.s3_bucket_name #=> String
|
1090
1264
|
# resp.exporting_location.s3_exporting.s3_key_name #=> String
|
1091
1265
|
# resp.job_stats.number_of_profiles_reviewed #=> Integer
|
@@ -1118,6 +1292,7 @@ module Aws::CustomerProfiles
|
|
1118
1292
|
# * {Types::GetIntegrationResponse#last_updated_at #last_updated_at} => Time
|
1119
1293
|
# * {Types::GetIntegrationResponse#tags #tags} => Hash<String,String>
|
1120
1294
|
# * {Types::GetIntegrationResponse#object_type_names #object_type_names} => Hash<String,String>
|
1295
|
+
# * {Types::GetIntegrationResponse#workflow_id #workflow_id} => String
|
1121
1296
|
#
|
1122
1297
|
# @example Request syntax with placeholder values
|
1123
1298
|
#
|
@@ -1137,6 +1312,7 @@ module Aws::CustomerProfiles
|
|
1137
1312
|
# resp.tags["TagKey"] #=> String
|
1138
1313
|
# resp.object_type_names #=> Hash
|
1139
1314
|
# resp.object_type_names["string1To255"] #=> String
|
1315
|
+
# resp.workflow_id #=> String
|
1140
1316
|
#
|
1141
1317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegration AWS API Documentation
|
1142
1318
|
#
|
@@ -1183,8 +1359,6 @@ module Aws::CustomerProfiles
|
|
1183
1359
|
#
|
1184
1360
|
# * FullName
|
1185
1361
|
#
|
1186
|
-
# * BusinessName
|
1187
|
-
#
|
1188
1362
|
# For example, two or more profiles—with spelling mistakes such as
|
1189
1363
|
# **John Doe** and **Jhn Doe**, or different casing email addresses such
|
1190
1364
|
# as **JOHN\_DOE@ANYCOMPANY.COM** and **johndoe@anycompany.com**, or
|
@@ -1361,6 +1535,112 @@ module Aws::CustomerProfiles
|
|
1361
1535
|
req.send_request(options)
|
1362
1536
|
end
|
1363
1537
|
|
1538
|
+
# Get details of specified workflow.
|
1539
|
+
#
|
1540
|
+
# @option params [required, String] :domain_name
|
1541
|
+
# The unique name of the domain.
|
1542
|
+
#
|
1543
|
+
# @option params [required, String] :workflow_id
|
1544
|
+
# Unique identifier for the workflow.
|
1545
|
+
#
|
1546
|
+
# @return [Types::GetWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1547
|
+
#
|
1548
|
+
# * {Types::GetWorkflowResponse#workflow_id #workflow_id} => String
|
1549
|
+
# * {Types::GetWorkflowResponse#workflow_type #workflow_type} => String
|
1550
|
+
# * {Types::GetWorkflowResponse#status #status} => String
|
1551
|
+
# * {Types::GetWorkflowResponse#error_description #error_description} => String
|
1552
|
+
# * {Types::GetWorkflowResponse#start_date #start_date} => Time
|
1553
|
+
# * {Types::GetWorkflowResponse#last_updated_at #last_updated_at} => Time
|
1554
|
+
# * {Types::GetWorkflowResponse#attributes #attributes} => Types::WorkflowAttributes
|
1555
|
+
# * {Types::GetWorkflowResponse#metrics #metrics} => Types::WorkflowMetrics
|
1556
|
+
#
|
1557
|
+
# @example Request syntax with placeholder values
|
1558
|
+
#
|
1559
|
+
# resp = client.get_workflow({
|
1560
|
+
# domain_name: "name", # required
|
1561
|
+
# workflow_id: "uuid", # required
|
1562
|
+
# })
|
1563
|
+
#
|
1564
|
+
# @example Response structure
|
1565
|
+
#
|
1566
|
+
# resp.workflow_id #=> String
|
1567
|
+
# resp.workflow_type #=> String, one of "APPFLOW_INTEGRATION"
|
1568
|
+
# resp.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
|
1569
|
+
# resp.error_description #=> String
|
1570
|
+
# resp.start_date #=> Time
|
1571
|
+
# resp.last_updated_at #=> Time
|
1572
|
+
# resp.attributes.appflow_integration.source_connector_type #=> String, one of "Salesforce", "Marketo", "Zendesk", "Servicenow", "S3"
|
1573
|
+
# resp.attributes.appflow_integration.connector_profile_name #=> String
|
1574
|
+
# resp.attributes.appflow_integration.role_arn #=> String
|
1575
|
+
# resp.metrics.appflow_integration.records_processed #=> Integer
|
1576
|
+
# resp.metrics.appflow_integration.steps_completed #=> Integer
|
1577
|
+
# resp.metrics.appflow_integration.total_steps #=> Integer
|
1578
|
+
#
|
1579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetWorkflow AWS API Documentation
|
1580
|
+
#
|
1581
|
+
# @overload get_workflow(params = {})
|
1582
|
+
# @param [Hash] params ({})
|
1583
|
+
def get_workflow(params = {}, options = {})
|
1584
|
+
req = build_request(:get_workflow, params)
|
1585
|
+
req.send_request(options)
|
1586
|
+
end
|
1587
|
+
|
1588
|
+
# Get granular list of steps in workflow.
|
1589
|
+
#
|
1590
|
+
# @option params [required, String] :domain_name
|
1591
|
+
# The unique name of the domain.
|
1592
|
+
#
|
1593
|
+
# @option params [required, String] :workflow_id
|
1594
|
+
# Unique identifier for the workflow.
|
1595
|
+
#
|
1596
|
+
# @option params [String] :next_token
|
1597
|
+
# The token for the next set of results. Use the value returned in the
|
1598
|
+
# previous response in the next request to retrieve the next set of
|
1599
|
+
# results.
|
1600
|
+
#
|
1601
|
+
# @option params [Integer] :max_results
|
1602
|
+
# The maximum number of results to return per page.
|
1603
|
+
#
|
1604
|
+
# @return [Types::GetWorkflowStepsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1605
|
+
#
|
1606
|
+
# * {Types::GetWorkflowStepsResponse#workflow_id #workflow_id} => String
|
1607
|
+
# * {Types::GetWorkflowStepsResponse#workflow_type #workflow_type} => String
|
1608
|
+
# * {Types::GetWorkflowStepsResponse#items #items} => Array<Types::WorkflowStepItem>
|
1609
|
+
# * {Types::GetWorkflowStepsResponse#next_token #next_token} => String
|
1610
|
+
#
|
1611
|
+
# @example Request syntax with placeholder values
|
1612
|
+
#
|
1613
|
+
# resp = client.get_workflow_steps({
|
1614
|
+
# domain_name: "name", # required
|
1615
|
+
# workflow_id: "uuid", # required
|
1616
|
+
# next_token: "token",
|
1617
|
+
# max_results: 1,
|
1618
|
+
# })
|
1619
|
+
#
|
1620
|
+
# @example Response structure
|
1621
|
+
#
|
1622
|
+
# resp.workflow_id #=> String
|
1623
|
+
# resp.workflow_type #=> String, one of "APPFLOW_INTEGRATION"
|
1624
|
+
# resp.items #=> Array
|
1625
|
+
# resp.items[0].appflow_integration.flow_name #=> String
|
1626
|
+
# resp.items[0].appflow_integration.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
|
1627
|
+
# resp.items[0].appflow_integration.execution_message #=> String
|
1628
|
+
# resp.items[0].appflow_integration.records_processed #=> Integer
|
1629
|
+
# resp.items[0].appflow_integration.batch_records_start_time #=> String
|
1630
|
+
# resp.items[0].appflow_integration.batch_records_end_time #=> String
|
1631
|
+
# resp.items[0].appflow_integration.created_at #=> Time
|
1632
|
+
# resp.items[0].appflow_integration.last_updated_at #=> Time
|
1633
|
+
# resp.next_token #=> String
|
1634
|
+
#
|
1635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetWorkflowSteps AWS API Documentation
|
1636
|
+
#
|
1637
|
+
# @overload get_workflow_steps(params = {})
|
1638
|
+
# @param [Hash] params ({})
|
1639
|
+
def get_workflow_steps(params = {}, options = {})
|
1640
|
+
req = build_request(:get_workflow_steps, params)
|
1641
|
+
req.send_request(options)
|
1642
|
+
end
|
1643
|
+
|
1364
1644
|
# Lists all of the integrations associated to a specific URI in the AWS
|
1365
1645
|
# account.
|
1366
1646
|
#
|
@@ -1374,6 +1654,10 @@ module Aws::CustomerProfiles
|
|
1374
1654
|
# @option params [Integer] :max_results
|
1375
1655
|
# The maximum number of objects returned per page.
|
1376
1656
|
#
|
1657
|
+
# @option params [Boolean] :include_hidden
|
1658
|
+
# Boolean to indicate if hidden integration should be returned. Defaults
|
1659
|
+
# to `False`.
|
1660
|
+
#
|
1377
1661
|
# @return [Types::ListAccountIntegrationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1378
1662
|
#
|
1379
1663
|
# * {Types::ListAccountIntegrationsResponse#items #items} => Array<Types::ListIntegrationItem>
|
@@ -1385,6 +1669,7 @@ module Aws::CustomerProfiles
|
|
1385
1669
|
# uri: "string1To255", # required
|
1386
1670
|
# next_token: "token",
|
1387
1671
|
# max_results: 1,
|
1672
|
+
# include_hidden: false,
|
1388
1673
|
# })
|
1389
1674
|
#
|
1390
1675
|
# @example Response structure
|
@@ -1399,6 +1684,7 @@ module Aws::CustomerProfiles
|
|
1399
1684
|
# resp.items[0].tags["TagKey"] #=> String
|
1400
1685
|
# resp.items[0].object_type_names #=> Hash
|
1401
1686
|
# resp.items[0].object_type_names["string1To255"] #=> String
|
1687
|
+
# resp.items[0].workflow_id #=> String
|
1402
1688
|
# resp.next_token #=> String
|
1403
1689
|
#
|
1404
1690
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListAccountIntegrations AWS API Documentation
|
@@ -1513,6 +1799,10 @@ module Aws::CustomerProfiles
|
|
1513
1799
|
# @option params [Integer] :max_results
|
1514
1800
|
# The maximum number of objects returned per page.
|
1515
1801
|
#
|
1802
|
+
# @option params [Boolean] :include_hidden
|
1803
|
+
# Boolean to indicate if hidden integration should be returned. Defaults
|
1804
|
+
# to `False`.
|
1805
|
+
#
|
1516
1806
|
# @return [Types::ListIntegrationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1517
1807
|
#
|
1518
1808
|
# * {Types::ListIntegrationsResponse#items #items} => Array<Types::ListIntegrationItem>
|
@@ -1524,6 +1814,7 @@ module Aws::CustomerProfiles
|
|
1524
1814
|
# domain_name: "name", # required
|
1525
1815
|
# next_token: "token",
|
1526
1816
|
# max_results: 1,
|
1817
|
+
# include_hidden: false,
|
1527
1818
|
# })
|
1528
1819
|
#
|
1529
1820
|
# @example Response structure
|
@@ -1538,6 +1829,7 @@ module Aws::CustomerProfiles
|
|
1538
1829
|
# resp.items[0].tags["TagKey"] #=> String
|
1539
1830
|
# resp.items[0].object_type_names #=> Hash
|
1540
1831
|
# resp.items[0].object_type_names["string1To255"] #=> String
|
1832
|
+
# resp.items[0].workflow_id #=> String
|
1541
1833
|
# resp.next_token #=> String
|
1542
1834
|
#
|
1543
1835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrations AWS API Documentation
|
@@ -1721,6 +2013,69 @@ module Aws::CustomerProfiles
|
|
1721
2013
|
req.send_request(options)
|
1722
2014
|
end
|
1723
2015
|
|
2016
|
+
# Query to list all workflows.
|
2017
|
+
#
|
2018
|
+
# @option params [required, String] :domain_name
|
2019
|
+
# The unique name of the domain.
|
2020
|
+
#
|
2021
|
+
# @option params [String] :workflow_type
|
2022
|
+
# The type of workflow. The only supported value is
|
2023
|
+
# APPFLOW\_INTEGRATION.
|
2024
|
+
#
|
2025
|
+
# @option params [String] :status
|
2026
|
+
# Status of workflow execution.
|
2027
|
+
#
|
2028
|
+
# @option params [Time,DateTime,Date,Integer,String] :query_start_date
|
2029
|
+
# Retrieve workflows started after timestamp.
|
2030
|
+
#
|
2031
|
+
# @option params [Time,DateTime,Date,Integer,String] :query_end_date
|
2032
|
+
# Retrieve workflows ended after timestamp.
|
2033
|
+
#
|
2034
|
+
# @option params [String] :next_token
|
2035
|
+
# The token for the next set of results. Use the value returned in the
|
2036
|
+
# previous response in the next request to retrieve the next set of
|
2037
|
+
# results.
|
2038
|
+
#
|
2039
|
+
# @option params [Integer] :max_results
|
2040
|
+
# The maximum number of results to return per page.
|
2041
|
+
#
|
2042
|
+
# @return [Types::ListWorkflowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2043
|
+
#
|
2044
|
+
# * {Types::ListWorkflowsResponse#items #items} => Array<Types::ListWorkflowsItem>
|
2045
|
+
# * {Types::ListWorkflowsResponse#next_token #next_token} => String
|
2046
|
+
#
|
2047
|
+
# @example Request syntax with placeholder values
|
2048
|
+
#
|
2049
|
+
# resp = client.list_workflows({
|
2050
|
+
# domain_name: "name", # required
|
2051
|
+
# workflow_type: "APPFLOW_INTEGRATION", # accepts APPFLOW_INTEGRATION
|
2052
|
+
# status: "NOT_STARTED", # accepts NOT_STARTED, IN_PROGRESS, COMPLETE, FAILED, SPLIT, RETRY, CANCELLED
|
2053
|
+
# query_start_date: Time.now,
|
2054
|
+
# query_end_date: Time.now,
|
2055
|
+
# next_token: "token",
|
2056
|
+
# max_results: 1,
|
2057
|
+
# })
|
2058
|
+
#
|
2059
|
+
# @example Response structure
|
2060
|
+
#
|
2061
|
+
# resp.items #=> Array
|
2062
|
+
# resp.items[0].workflow_type #=> String, one of "APPFLOW_INTEGRATION"
|
2063
|
+
# resp.items[0].workflow_id #=> String
|
2064
|
+
# resp.items[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
|
2065
|
+
# resp.items[0].status_description #=> String
|
2066
|
+
# resp.items[0].created_at #=> Time
|
2067
|
+
# resp.items[0].last_updated_at #=> Time
|
2068
|
+
# resp.next_token #=> String
|
2069
|
+
#
|
2070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListWorkflows AWS API Documentation
|
2071
|
+
#
|
2072
|
+
# @overload list_workflows(params = {})
|
2073
|
+
# @param [Hash] params ({})
|
2074
|
+
def list_workflows(params = {}, options = {})
|
2075
|
+
req = build_request(:list_workflows, params)
|
2076
|
+
req.send_request(options)
|
2077
|
+
end
|
2078
|
+
|
1724
2079
|
# Runs an AWS Lambda job that does the following:
|
1725
2080
|
#
|
1726
2081
|
# 1. All the profileKeys in the `ProfileToBeMerged` will be moved to
|
@@ -1860,6 +2215,7 @@ module Aws::CustomerProfiles
|
|
1860
2215
|
# * {Types::PutIntegrationResponse#last_updated_at #last_updated_at} => Time
|
1861
2216
|
# * {Types::PutIntegrationResponse#tags #tags} => Hash<String,String>
|
1862
2217
|
# * {Types::PutIntegrationResponse#object_type_names #object_type_names} => Hash<String,String>
|
2218
|
+
# * {Types::PutIntegrationResponse#workflow_id #workflow_id} => String
|
1863
2219
|
#
|
1864
2220
|
# @example Request syntax with placeholder values
|
1865
2221
|
#
|
@@ -1949,6 +2305,7 @@ module Aws::CustomerProfiles
|
|
1949
2305
|
# resp.tags["TagKey"] #=> String
|
1950
2306
|
# resp.object_type_names #=> Hash
|
1951
2307
|
# resp.object_type_names["string1To255"] #=> String
|
2308
|
+
# resp.workflow_id #=> String
|
1952
2309
|
#
|
1953
2310
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegration AWS API Documentation
|
1954
2311
|
#
|
@@ -2020,7 +2377,14 @@ module Aws::CustomerProfiles
|
|
2020
2377
|
# Description of the profile object type.
|
2021
2378
|
#
|
2022
2379
|
# @option params [String] :template_id
|
2023
|
-
# A unique identifier for the object template.
|
2380
|
+
# A unique identifier for the object template. For some attributes in
|
2381
|
+
# the request, the service will use the default value from the object
|
2382
|
+
# template when TemplateId is present. If these attributes are present
|
2383
|
+
# in the request, the service may return a `BadRequestException`. These
|
2384
|
+
# attributes include: AllowProfileCreation,
|
2385
|
+
# SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
|
2386
|
+
# AllowProfileCreation is set to true when TemplateId is set, the
|
2387
|
+
# service may return a `BadRequestException`.
|
2024
2388
|
#
|
2025
2389
|
# @option params [Integer] :expiration_days
|
2026
2390
|
# The number of days until the data in the object expires.
|
@@ -2405,6 +2769,7 @@ module Aws::CustomerProfiles
|
|
2405
2769
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
2406
2770
|
# source_name: "string1To255",
|
2407
2771
|
# },
|
2772
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
2408
2773
|
# },
|
2409
2774
|
# exporting_config: {
|
2410
2775
|
# s3_exporting: {
|
@@ -2433,6 +2798,7 @@ module Aws::CustomerProfiles
|
|
2433
2798
|
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
2434
2799
|
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
2435
2800
|
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
2801
|
+
# resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
|
2436
2802
|
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
2437
2803
|
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
2438
2804
|
# resp.created_at #=> Time
|
@@ -2632,7 +2998,7 @@ module Aws::CustomerProfiles
|
|
2632
2998
|
params: params,
|
2633
2999
|
config: config)
|
2634
3000
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
2635
|
-
context[:gem_version] = '1.
|
3001
|
+
context[:gem_version] = '1.21.0'
|
2636
3002
|
Seahorse::Client::Request.new(handlers, context)
|
2637
3003
|
end
|
2638
3004
|
|