aws-sdk-customerprofiles 1.15.0 → 1.19.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +389 -20
- data/lib/aws-sdk-customerprofiles/client_api.rb +219 -4
- data/lib/aws-sdk-customerprofiles/types.rb +904 -26
- 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: b94f04755f2fc503f4a6e1255e377229c09022acd8e1d2feaa87ce1dfa8c804d
|
4
|
+
data.tar.gz: 06411063f77dd0162a1b23e49dae590a68d9a0fe1cddedc067331cfe53faac0a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 687c4696485ff85856aafe98a3e8acc1564ee3eb89e1cb25f9ae14df331c50e381f08ae73e0e82de688b3572cde5856257cd654dd014d5f92e23393760bfbf45
|
7
|
+
data.tar.gz: 2fb611bf788982376423569e84fa5842f43e1038ea869000d3d29cdb5001b9a0471f7ce2b6dab2b47a92e48bc7158be274294be7eee93dc7f00ea76364f7648a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.19.0 (2022-02-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release introduces apis CreateIntegrationWorkflow, DeleteWorkflow, ListWorkflows, GetWorkflow and GetWorkflowSteps. These apis are used to manage and view integration workflows.
|
8
|
+
|
9
|
+
1.18.0 (2022-02-03)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.17.0 (2021-12-21)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.16.0 (2021-12-20)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - This release adds an optional parameter, ObjectTypeNames to the PutIntegration API to support multiple object types per integration option. Besides, this release introduces Standard Order Objects which contain data from third party systems and each order object belongs to a specific profile.
|
23
|
+
|
4
24
|
1.15.0 (2021-11-30)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.19.0
|
@@ -27,6 +27,8 @@ 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/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::CustomerProfiles
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
82
|
|
@@ -175,6 +179,10 @@ module Aws::CustomerProfiles
|
|
175
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
178
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
187
|
# Set to true to disable SDK automatically adding host prefix
|
180
188
|
# to default service endpoint when available.
|
@@ -297,7 +305,7 @@ module Aws::CustomerProfiles
|
|
297
305
|
# seconds to wait when opening a HTTP session before raising a
|
298
306
|
# `Timeout::Error`.
|
299
307
|
#
|
300
|
-
# @option options [
|
308
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
309
|
# number of seconds to wait for response data. This value can
|
302
310
|
# safely be set per-request on the session.
|
303
311
|
#
|
@@ -313,6 +321,9 @@ module Aws::CustomerProfiles
|
|
313
321
|
# disables this behaviour. This value can safely be set per
|
314
322
|
# request on the session.
|
315
323
|
#
|
324
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
325
|
+
# in seconds.
|
326
|
+
#
|
316
327
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
328
|
# HTTP debug output will be sent to the `:logger`.
|
318
329
|
#
|
@@ -523,6 +534,136 @@ module Aws::CustomerProfiles
|
|
523
534
|
req.send_request(options)
|
524
535
|
end
|
525
536
|
|
537
|
+
# Creates an integration workflow. An integration workflow is an async
|
538
|
+
# process which ingests historic data and sets up an integration for
|
539
|
+
# ongoing updates. The supported Amazon AppFlow sources are Salesforce,
|
540
|
+
# ServiceNow, and Marketo.
|
541
|
+
#
|
542
|
+
# @option params [required, String] :domain_name
|
543
|
+
# The unique name of the domain.
|
544
|
+
#
|
545
|
+
# @option params [required, String] :workflow_type
|
546
|
+
# The type of workflow. The only supported value is
|
547
|
+
# APPFLOW\_INTEGRATION.
|
548
|
+
#
|
549
|
+
# @option params [required, Types::IntegrationConfig] :integration_config
|
550
|
+
# Configuration data for integration workflow.
|
551
|
+
#
|
552
|
+
# @option params [required, String] :object_type_name
|
553
|
+
# The name of the profile object type.
|
554
|
+
#
|
555
|
+
# @option params [required, String] :role_arn
|
556
|
+
# The Amazon Resource Name (ARN) of the IAM role. Customer Profiles
|
557
|
+
# assumes this role to create resources on your behalf as part of
|
558
|
+
# workflow execution.
|
559
|
+
#
|
560
|
+
# @option params [Hash<String,String>] :tags
|
561
|
+
# The tags used to organize, track, or control access for this resource.
|
562
|
+
#
|
563
|
+
# @return [Types::CreateIntegrationWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
564
|
+
#
|
565
|
+
# * {Types::CreateIntegrationWorkflowResponse#workflow_id #workflow_id} => String
|
566
|
+
# * {Types::CreateIntegrationWorkflowResponse#message #message} => String
|
567
|
+
#
|
568
|
+
# @example Request syntax with placeholder values
|
569
|
+
#
|
570
|
+
# resp = client.create_integration_workflow({
|
571
|
+
# domain_name: "name", # required
|
572
|
+
# workflow_type: "APPFLOW_INTEGRATION", # required, accepts APPFLOW_INTEGRATION
|
573
|
+
# integration_config: { # required
|
574
|
+
# appflow_integration: {
|
575
|
+
# flow_definition: { # required
|
576
|
+
# description: "FlowDescription",
|
577
|
+
# flow_name: "FlowName", # required
|
578
|
+
# kms_arn: "KmsArn", # required
|
579
|
+
# source_flow_config: { # required
|
580
|
+
# connector_profile_name: "ConnectorProfileName",
|
581
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
|
582
|
+
# incremental_pull_config: {
|
583
|
+
# datetime_type_field_name: "DatetimeTypeFieldName",
|
584
|
+
# },
|
585
|
+
# source_connector_properties: { # required
|
586
|
+
# marketo: {
|
587
|
+
# object: "Object", # required
|
588
|
+
# },
|
589
|
+
# s3: {
|
590
|
+
# bucket_name: "BucketName", # required
|
591
|
+
# bucket_prefix: "BucketPrefix",
|
592
|
+
# },
|
593
|
+
# salesforce: {
|
594
|
+
# object: "Object", # required
|
595
|
+
# enable_dynamic_field_update: false,
|
596
|
+
# include_deleted_records: false,
|
597
|
+
# },
|
598
|
+
# service_now: {
|
599
|
+
# object: "Object", # required
|
600
|
+
# },
|
601
|
+
# zendesk: {
|
602
|
+
# object: "Object", # required
|
603
|
+
# },
|
604
|
+
# },
|
605
|
+
# },
|
606
|
+
# tasks: [ # required
|
607
|
+
# {
|
608
|
+
# connector_operator: {
|
609
|
+
# 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
|
610
|
+
# 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
|
611
|
+
# 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
|
612
|
+
# 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
|
613
|
+
# 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
|
614
|
+
# },
|
615
|
+
# destination_field: "DestinationField",
|
616
|
+
# source_fields: ["stringTo2048"], # required
|
617
|
+
# task_properties: {
|
618
|
+
# "VALUE" => "Property",
|
619
|
+
# },
|
620
|
+
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
|
621
|
+
# },
|
622
|
+
# ],
|
623
|
+
# trigger_config: { # required
|
624
|
+
# trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
|
625
|
+
# trigger_properties: {
|
626
|
+
# scheduled: {
|
627
|
+
# schedule_expression: "ScheduleExpression", # required
|
628
|
+
# data_pull_mode: "Incremental", # accepts Incremental, Complete
|
629
|
+
# schedule_start_time: Time.now,
|
630
|
+
# schedule_end_time: Time.now,
|
631
|
+
# timezone: "Timezone",
|
632
|
+
# schedule_offset: 1,
|
633
|
+
# first_execution_from: Time.now,
|
634
|
+
# },
|
635
|
+
# },
|
636
|
+
# },
|
637
|
+
# },
|
638
|
+
# batches: [
|
639
|
+
# {
|
640
|
+
# start_time: Time.now, # required
|
641
|
+
# end_time: Time.now, # required
|
642
|
+
# },
|
643
|
+
# ],
|
644
|
+
# },
|
645
|
+
# },
|
646
|
+
# object_type_name: "typeName", # required
|
647
|
+
# role_arn: "RoleArn", # required
|
648
|
+
# tags: {
|
649
|
+
# "TagKey" => "TagValue",
|
650
|
+
# },
|
651
|
+
# })
|
652
|
+
#
|
653
|
+
# @example Response structure
|
654
|
+
#
|
655
|
+
# resp.workflow_id #=> String
|
656
|
+
# resp.message #=> String
|
657
|
+
#
|
658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateIntegrationWorkflow AWS API Documentation
|
659
|
+
#
|
660
|
+
# @overload create_integration_workflow(params = {})
|
661
|
+
# @param [Hash] params ({})
|
662
|
+
def create_integration_workflow(params = {}, options = {})
|
663
|
+
req = build_request(:create_integration_workflow, params)
|
664
|
+
req.send_request(options)
|
665
|
+
end
|
666
|
+
|
526
667
|
# Creates a standard profile.
|
527
668
|
#
|
528
669
|
# A standard profile represents the following attributes for a customer
|
@@ -898,6 +1039,33 @@ module Aws::CustomerProfiles
|
|
898
1039
|
req.send_request(options)
|
899
1040
|
end
|
900
1041
|
|
1042
|
+
# Deletes the specified workflow and all its corresponding resources.
|
1043
|
+
# This is an async process.
|
1044
|
+
#
|
1045
|
+
# @option params [required, String] :domain_name
|
1046
|
+
# The unique name of the domain.
|
1047
|
+
#
|
1048
|
+
# @option params [required, String] :workflow_id
|
1049
|
+
# Unique identifier for the workflow.
|
1050
|
+
#
|
1051
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1052
|
+
#
|
1053
|
+
# @example Request syntax with placeholder values
|
1054
|
+
#
|
1055
|
+
# resp = client.delete_workflow({
|
1056
|
+
# domain_name: "name", # required
|
1057
|
+
# workflow_id: "string1To255", # required
|
1058
|
+
# })
|
1059
|
+
#
|
1060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteWorkflow AWS API Documentation
|
1061
|
+
#
|
1062
|
+
# @overload delete_workflow(params = {})
|
1063
|
+
# @param [Hash] params ({})
|
1064
|
+
def delete_workflow(params = {}, options = {})
|
1065
|
+
req = build_request(:delete_workflow, params)
|
1066
|
+
req.send_request(options)
|
1067
|
+
end
|
1068
|
+
|
901
1069
|
# Tests the auto-merging settings of your Identity Resolution Job
|
902
1070
|
# without merging your data. It randomly selects a sample of matching
|
903
1071
|
# groups from the existing matching results, and applies the automerging
|
@@ -1106,6 +1274,8 @@ module Aws::CustomerProfiles
|
|
1106
1274
|
# * {Types::GetIntegrationResponse#created_at #created_at} => Time
|
1107
1275
|
# * {Types::GetIntegrationResponse#last_updated_at #last_updated_at} => Time
|
1108
1276
|
# * {Types::GetIntegrationResponse#tags #tags} => Hash<String,String>
|
1277
|
+
# * {Types::GetIntegrationResponse#object_type_names #object_type_names} => Hash<String,String>
|
1278
|
+
# * {Types::GetIntegrationResponse#workflow_id #workflow_id} => String
|
1109
1279
|
#
|
1110
1280
|
# @example Request syntax with placeholder values
|
1111
1281
|
#
|
@@ -1123,6 +1293,9 @@ module Aws::CustomerProfiles
|
|
1123
1293
|
# resp.last_updated_at #=> Time
|
1124
1294
|
# resp.tags #=> Hash
|
1125
1295
|
# resp.tags["TagKey"] #=> String
|
1296
|
+
# resp.object_type_names #=> Hash
|
1297
|
+
# resp.object_type_names["string1To255"] #=> String
|
1298
|
+
# resp.workflow_id #=> String
|
1126
1299
|
#
|
1127
1300
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetIntegration AWS API Documentation
|
1128
1301
|
#
|
@@ -1133,9 +1306,6 @@ module Aws::CustomerProfiles
|
|
1133
1306
|
req.send_request(options)
|
1134
1307
|
end
|
1135
1308
|
|
1136
|
-
# This API is in preview release for Amazon Connect and subject to
|
1137
|
-
# change.
|
1138
|
-
#
|
1139
1309
|
# Before calling this API, use [CreateDomain][1] or [UpdateDomain][2] to
|
1140
1310
|
# enable identity resolution: set `Matching` to true.
|
1141
1311
|
#
|
@@ -1172,8 +1342,6 @@ module Aws::CustomerProfiles
|
|
1172
1342
|
#
|
1173
1343
|
# * FullName
|
1174
1344
|
#
|
1175
|
-
# * BusinessName
|
1176
|
-
#
|
1177
1345
|
# For example, two or more profiles—with spelling mistakes such as
|
1178
1346
|
# **John Doe** and **Jhn Doe**, or different casing email addresses such
|
1179
1347
|
# as **JOHN\_DOE@ANYCOMPANY.COM** and **johndoe@anycompany.com**, or
|
@@ -1279,7 +1447,7 @@ module Aws::CustomerProfiles
|
|
1279
1447
|
# resp.keys #=> Hash
|
1280
1448
|
# resp.keys["name"] #=> Array
|
1281
1449
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
1282
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
1450
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY", "ORDER"
|
1283
1451
|
# resp.keys["name"][0].field_names #=> Array
|
1284
1452
|
# resp.keys["name"][0].field_names[0] #=> String
|
1285
1453
|
# resp.created_at #=> Time
|
@@ -1337,7 +1505,7 @@ module Aws::CustomerProfiles
|
|
1337
1505
|
# resp.keys #=> Hash
|
1338
1506
|
# resp.keys["name"] #=> Array
|
1339
1507
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
1340
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
1508
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY", "ORDER"
|
1341
1509
|
# resp.keys["name"][0].field_names #=> Array
|
1342
1510
|
# resp.keys["name"][0].field_names[0] #=> String
|
1343
1511
|
#
|
@@ -1350,6 +1518,112 @@ module Aws::CustomerProfiles
|
|
1350
1518
|
req.send_request(options)
|
1351
1519
|
end
|
1352
1520
|
|
1521
|
+
# Get details of specified workflow.
|
1522
|
+
#
|
1523
|
+
# @option params [required, String] :domain_name
|
1524
|
+
# The unique name of the domain.
|
1525
|
+
#
|
1526
|
+
# @option params [required, String] :workflow_id
|
1527
|
+
# Unique identifier for the workflow.
|
1528
|
+
#
|
1529
|
+
# @return [Types::GetWorkflowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1530
|
+
#
|
1531
|
+
# * {Types::GetWorkflowResponse#workflow_id #workflow_id} => String
|
1532
|
+
# * {Types::GetWorkflowResponse#workflow_type #workflow_type} => String
|
1533
|
+
# * {Types::GetWorkflowResponse#status #status} => String
|
1534
|
+
# * {Types::GetWorkflowResponse#error_description #error_description} => String
|
1535
|
+
# * {Types::GetWorkflowResponse#start_date #start_date} => Time
|
1536
|
+
# * {Types::GetWorkflowResponse#last_updated_at #last_updated_at} => Time
|
1537
|
+
# * {Types::GetWorkflowResponse#attributes #attributes} => Types::WorkflowAttributes
|
1538
|
+
# * {Types::GetWorkflowResponse#metrics #metrics} => Types::WorkflowMetrics
|
1539
|
+
#
|
1540
|
+
# @example Request syntax with placeholder values
|
1541
|
+
#
|
1542
|
+
# resp = client.get_workflow({
|
1543
|
+
# domain_name: "name", # required
|
1544
|
+
# workflow_id: "uuid", # required
|
1545
|
+
# })
|
1546
|
+
#
|
1547
|
+
# @example Response structure
|
1548
|
+
#
|
1549
|
+
# resp.workflow_id #=> String
|
1550
|
+
# resp.workflow_type #=> String, one of "APPFLOW_INTEGRATION"
|
1551
|
+
# resp.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
|
1552
|
+
# resp.error_description #=> String
|
1553
|
+
# resp.start_date #=> Time
|
1554
|
+
# resp.last_updated_at #=> Time
|
1555
|
+
# resp.attributes.appflow_integration.source_connector_type #=> String, one of "Salesforce", "Marketo", "Zendesk", "Servicenow", "S3"
|
1556
|
+
# resp.attributes.appflow_integration.connector_profile_name #=> String
|
1557
|
+
# resp.attributes.appflow_integration.role_arn #=> String
|
1558
|
+
# resp.metrics.appflow_integration.records_processed #=> Integer
|
1559
|
+
# resp.metrics.appflow_integration.steps_completed #=> Integer
|
1560
|
+
# resp.metrics.appflow_integration.total_steps #=> Integer
|
1561
|
+
#
|
1562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetWorkflow AWS API Documentation
|
1563
|
+
#
|
1564
|
+
# @overload get_workflow(params = {})
|
1565
|
+
# @param [Hash] params ({})
|
1566
|
+
def get_workflow(params = {}, options = {})
|
1567
|
+
req = build_request(:get_workflow, params)
|
1568
|
+
req.send_request(options)
|
1569
|
+
end
|
1570
|
+
|
1571
|
+
# Get granular list of steps in workflow.
|
1572
|
+
#
|
1573
|
+
# @option params [required, String] :domain_name
|
1574
|
+
# The unique name of the domain.
|
1575
|
+
#
|
1576
|
+
# @option params [required, String] :workflow_id
|
1577
|
+
# Unique identifier for the workflow.
|
1578
|
+
#
|
1579
|
+
# @option params [String] :next_token
|
1580
|
+
# The token for the next set of results. Use the value returned in the
|
1581
|
+
# previous response in the next request to retrieve the next set of
|
1582
|
+
# results.
|
1583
|
+
#
|
1584
|
+
# @option params [Integer] :max_results
|
1585
|
+
# The maximum number of results to return per page.
|
1586
|
+
#
|
1587
|
+
# @return [Types::GetWorkflowStepsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1588
|
+
#
|
1589
|
+
# * {Types::GetWorkflowStepsResponse#workflow_id #workflow_id} => String
|
1590
|
+
# * {Types::GetWorkflowStepsResponse#workflow_type #workflow_type} => String
|
1591
|
+
# * {Types::GetWorkflowStepsResponse#items #items} => Array<Types::WorkflowStepItem>
|
1592
|
+
# * {Types::GetWorkflowStepsResponse#next_token #next_token} => String
|
1593
|
+
#
|
1594
|
+
# @example Request syntax with placeholder values
|
1595
|
+
#
|
1596
|
+
# resp = client.get_workflow_steps({
|
1597
|
+
# domain_name: "name", # required
|
1598
|
+
# workflow_id: "uuid", # required
|
1599
|
+
# next_token: "token",
|
1600
|
+
# max_results: 1,
|
1601
|
+
# })
|
1602
|
+
#
|
1603
|
+
# @example Response structure
|
1604
|
+
#
|
1605
|
+
# resp.workflow_id #=> String
|
1606
|
+
# resp.workflow_type #=> String, one of "APPFLOW_INTEGRATION"
|
1607
|
+
# resp.items #=> Array
|
1608
|
+
# resp.items[0].appflow_integration.flow_name #=> String
|
1609
|
+
# resp.items[0].appflow_integration.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
|
1610
|
+
# resp.items[0].appflow_integration.execution_message #=> String
|
1611
|
+
# resp.items[0].appflow_integration.records_processed #=> Integer
|
1612
|
+
# resp.items[0].appflow_integration.batch_records_start_time #=> String
|
1613
|
+
# resp.items[0].appflow_integration.batch_records_end_time #=> String
|
1614
|
+
# resp.items[0].appflow_integration.created_at #=> Time
|
1615
|
+
# resp.items[0].appflow_integration.last_updated_at #=> Time
|
1616
|
+
# resp.next_token #=> String
|
1617
|
+
#
|
1618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetWorkflowSteps AWS API Documentation
|
1619
|
+
#
|
1620
|
+
# @overload get_workflow_steps(params = {})
|
1621
|
+
# @param [Hash] params ({})
|
1622
|
+
def get_workflow_steps(params = {}, options = {})
|
1623
|
+
req = build_request(:get_workflow_steps, params)
|
1624
|
+
req.send_request(options)
|
1625
|
+
end
|
1626
|
+
|
1353
1627
|
# Lists all of the integrations associated to a specific URI in the AWS
|
1354
1628
|
# account.
|
1355
1629
|
#
|
@@ -1363,6 +1637,10 @@ module Aws::CustomerProfiles
|
|
1363
1637
|
# @option params [Integer] :max_results
|
1364
1638
|
# The maximum number of objects returned per page.
|
1365
1639
|
#
|
1640
|
+
# @option params [Boolean] :include_hidden
|
1641
|
+
# Boolean to indicate if hidden integration should be returned. Defaults
|
1642
|
+
# to `False`.
|
1643
|
+
#
|
1366
1644
|
# @return [Types::ListAccountIntegrationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1367
1645
|
#
|
1368
1646
|
# * {Types::ListAccountIntegrationsResponse#items #items} => Array<Types::ListIntegrationItem>
|
@@ -1374,6 +1652,7 @@ module Aws::CustomerProfiles
|
|
1374
1652
|
# uri: "string1To255", # required
|
1375
1653
|
# next_token: "token",
|
1376
1654
|
# max_results: 1,
|
1655
|
+
# include_hidden: false,
|
1377
1656
|
# })
|
1378
1657
|
#
|
1379
1658
|
# @example Response structure
|
@@ -1386,6 +1665,9 @@ module Aws::CustomerProfiles
|
|
1386
1665
|
# resp.items[0].last_updated_at #=> Time
|
1387
1666
|
# resp.items[0].tags #=> Hash
|
1388
1667
|
# resp.items[0].tags["TagKey"] #=> String
|
1668
|
+
# resp.items[0].object_type_names #=> Hash
|
1669
|
+
# resp.items[0].object_type_names["string1To255"] #=> String
|
1670
|
+
# resp.items[0].workflow_id #=> String
|
1389
1671
|
# resp.next_token #=> String
|
1390
1672
|
#
|
1391
1673
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListAccountIntegrations AWS API Documentation
|
@@ -1500,6 +1782,10 @@ module Aws::CustomerProfiles
|
|
1500
1782
|
# @option params [Integer] :max_results
|
1501
1783
|
# The maximum number of objects returned per page.
|
1502
1784
|
#
|
1785
|
+
# @option params [Boolean] :include_hidden
|
1786
|
+
# Boolean to indicate if hidden integration should be returned. Defaults
|
1787
|
+
# to `False`.
|
1788
|
+
#
|
1503
1789
|
# @return [Types::ListIntegrationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1504
1790
|
#
|
1505
1791
|
# * {Types::ListIntegrationsResponse#items #items} => Array<Types::ListIntegrationItem>
|
@@ -1511,6 +1797,7 @@ module Aws::CustomerProfiles
|
|
1511
1797
|
# domain_name: "name", # required
|
1512
1798
|
# next_token: "token",
|
1513
1799
|
# max_results: 1,
|
1800
|
+
# include_hidden: false,
|
1514
1801
|
# })
|
1515
1802
|
#
|
1516
1803
|
# @example Response structure
|
@@ -1523,6 +1810,9 @@ module Aws::CustomerProfiles
|
|
1523
1810
|
# resp.items[0].last_updated_at #=> Time
|
1524
1811
|
# resp.items[0].tags #=> Hash
|
1525
1812
|
# resp.items[0].tags["TagKey"] #=> String
|
1813
|
+
# resp.items[0].object_type_names #=> Hash
|
1814
|
+
# resp.items[0].object_type_names["string1To255"] #=> String
|
1815
|
+
# resp.items[0].workflow_id #=> String
|
1526
1816
|
# resp.next_token #=> String
|
1527
1817
|
#
|
1528
1818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrations AWS API Documentation
|
@@ -1637,7 +1927,7 @@ module Aws::CustomerProfiles
|
|
1637
1927
|
# @option params [Types::ObjectFilter] :object_filter
|
1638
1928
|
# Applies a filter to the response to include profile objects with the
|
1639
1929
|
# specified index values. This filter is only supported for
|
1640
|
-
# ObjectTypeName \_asset and \
|
1930
|
+
# ObjectTypeName \_asset, \_case and \_order.
|
1641
1931
|
#
|
1642
1932
|
# @return [Types::ListProfileObjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1643
1933
|
#
|
@@ -1706,9 +1996,69 @@ module Aws::CustomerProfiles
|
|
1706
1996
|
req.send_request(options)
|
1707
1997
|
end
|
1708
1998
|
|
1709
|
-
#
|
1710
|
-
#
|
1999
|
+
# Query to list all workflows.
|
2000
|
+
#
|
2001
|
+
# @option params [required, String] :domain_name
|
2002
|
+
# The unique name of the domain.
|
2003
|
+
#
|
2004
|
+
# @option params [String] :workflow_type
|
2005
|
+
# The type of workflow. The only supported value is
|
2006
|
+
# APPFLOW\_INTEGRATION.
|
2007
|
+
#
|
2008
|
+
# @option params [String] :status
|
2009
|
+
# Status of workflow execution.
|
2010
|
+
#
|
2011
|
+
# @option params [Time,DateTime,Date,Integer,String] :query_start_date
|
2012
|
+
# Retrieve workflows started after timestamp.
|
2013
|
+
#
|
2014
|
+
# @option params [Time,DateTime,Date,Integer,String] :query_end_date
|
2015
|
+
# Retrieve workflows ended after timestamp.
|
2016
|
+
#
|
2017
|
+
# @option params [String] :next_token
|
2018
|
+
# The token for the next set of results. Use the value returned in the
|
2019
|
+
# previous response in the next request to retrieve the next set of
|
2020
|
+
# results.
|
2021
|
+
#
|
2022
|
+
# @option params [Integer] :max_results
|
2023
|
+
# The maximum number of results to return per page.
|
2024
|
+
#
|
2025
|
+
# @return [Types::ListWorkflowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1711
2026
|
#
|
2027
|
+
# * {Types::ListWorkflowsResponse#items #items} => Array<Types::ListWorkflowsItem>
|
2028
|
+
# * {Types::ListWorkflowsResponse#next_token #next_token} => String
|
2029
|
+
#
|
2030
|
+
# @example Request syntax with placeholder values
|
2031
|
+
#
|
2032
|
+
# resp = client.list_workflows({
|
2033
|
+
# domain_name: "name", # required
|
2034
|
+
# workflow_type: "APPFLOW_INTEGRATION", # accepts APPFLOW_INTEGRATION
|
2035
|
+
# status: "NOT_STARTED", # accepts NOT_STARTED, IN_PROGRESS, COMPLETE, FAILED, SPLIT, RETRY, CANCELLED
|
2036
|
+
# query_start_date: Time.now,
|
2037
|
+
# query_end_date: Time.now,
|
2038
|
+
# next_token: "token",
|
2039
|
+
# max_results: 1,
|
2040
|
+
# })
|
2041
|
+
#
|
2042
|
+
# @example Response structure
|
2043
|
+
#
|
2044
|
+
# resp.items #=> Array
|
2045
|
+
# resp.items[0].workflow_type #=> String, one of "APPFLOW_INTEGRATION"
|
2046
|
+
# resp.items[0].workflow_id #=> String
|
2047
|
+
# resp.items[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
|
2048
|
+
# resp.items[0].status_description #=> String
|
2049
|
+
# resp.items[0].created_at #=> Time
|
2050
|
+
# resp.items[0].last_updated_at #=> Time
|
2051
|
+
# resp.next_token #=> String
|
2052
|
+
#
|
2053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListWorkflows AWS API Documentation
|
2054
|
+
#
|
2055
|
+
# @overload list_workflows(params = {})
|
2056
|
+
# @param [Hash] params ({})
|
2057
|
+
def list_workflows(params = {}, options = {})
|
2058
|
+
req = build_request(:list_workflows, params)
|
2059
|
+
req.send_request(options)
|
2060
|
+
end
|
2061
|
+
|
1712
2062
|
# Runs an AWS Lambda job that does the following:
|
1713
2063
|
#
|
1714
2064
|
# 1. All the profileKeys in the `ProfileToBeMerged` will be moved to
|
@@ -1820,7 +2170,7 @@ module Aws::CustomerProfiles
|
|
1820
2170
|
# @option params [String] :uri
|
1821
2171
|
# The URI of the S3 bucket or any other type of data source.
|
1822
2172
|
#
|
1823
|
-
# @option params [
|
2173
|
+
# @option params [String] :object_type_name
|
1824
2174
|
# The name of the profile object type.
|
1825
2175
|
#
|
1826
2176
|
# @option params [Hash<String,String>] :tags
|
@@ -1830,6 +2180,15 @@ module Aws::CustomerProfiles
|
|
1830
2180
|
# The configuration that controls how Customer Profiles retrieves data
|
1831
2181
|
# from the source.
|
1832
2182
|
#
|
2183
|
+
# @option params [Hash<String,String>] :object_type_names
|
2184
|
+
# A map in which each key is an event type from an external application
|
2185
|
+
# such as Segment or Shopify, and each value is an `ObjectTypeName`
|
2186
|
+
# (template) used to ingest the event. It supports the following event
|
2187
|
+
# types: `SegmentIdentify`, `ShopifyCreateCustomers`,
|
2188
|
+
# `ShopifyUpdateCustomers`, `ShopifyCreateDraftOrders`,
|
2189
|
+
# `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and
|
2190
|
+
# `ShopifyUpdatedOrders`.
|
2191
|
+
#
|
1833
2192
|
# @return [Types::PutIntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1834
2193
|
#
|
1835
2194
|
# * {Types::PutIntegrationResponse#domain_name #domain_name} => String
|
@@ -1838,13 +2197,15 @@ module Aws::CustomerProfiles
|
|
1838
2197
|
# * {Types::PutIntegrationResponse#created_at #created_at} => Time
|
1839
2198
|
# * {Types::PutIntegrationResponse#last_updated_at #last_updated_at} => Time
|
1840
2199
|
# * {Types::PutIntegrationResponse#tags #tags} => Hash<String,String>
|
2200
|
+
# * {Types::PutIntegrationResponse#object_type_names #object_type_names} => Hash<String,String>
|
2201
|
+
# * {Types::PutIntegrationResponse#workflow_id #workflow_id} => String
|
1841
2202
|
#
|
1842
2203
|
# @example Request syntax with placeholder values
|
1843
2204
|
#
|
1844
2205
|
# resp = client.put_integration({
|
1845
2206
|
# domain_name: "name", # required
|
1846
2207
|
# uri: "string1To255",
|
1847
|
-
# object_type_name: "typeName",
|
2208
|
+
# object_type_name: "typeName",
|
1848
2209
|
# tags: {
|
1849
2210
|
# "TagKey" => "TagValue",
|
1850
2211
|
# },
|
@@ -1911,6 +2272,9 @@ module Aws::CustomerProfiles
|
|
1911
2272
|
# },
|
1912
2273
|
# },
|
1913
2274
|
# },
|
2275
|
+
# object_type_names: {
|
2276
|
+
# "string1To255" => "typeName",
|
2277
|
+
# },
|
1914
2278
|
# })
|
1915
2279
|
#
|
1916
2280
|
# @example Response structure
|
@@ -1922,6 +2286,9 @@ module Aws::CustomerProfiles
|
|
1922
2286
|
# resp.last_updated_at #=> Time
|
1923
2287
|
# resp.tags #=> Hash
|
1924
2288
|
# resp.tags["TagKey"] #=> String
|
2289
|
+
# resp.object_type_names #=> Hash
|
2290
|
+
# resp.object_type_names["string1To255"] #=> String
|
2291
|
+
# resp.workflow_id #=> String
|
1925
2292
|
#
|
1926
2293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/PutIntegration AWS API Documentation
|
1927
2294
|
#
|
@@ -2059,7 +2426,7 @@ module Aws::CustomerProfiles
|
|
2059
2426
|
# keys: {
|
2060
2427
|
# "name" => [
|
2061
2428
|
# {
|
2062
|
-
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
2429
|
+
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY, ORDER
|
2063
2430
|
# field_names: ["name"],
|
2064
2431
|
# },
|
2065
2432
|
# ],
|
@@ -2085,7 +2452,7 @@ module Aws::CustomerProfiles
|
|
2085
2452
|
# resp.keys #=> Hash
|
2086
2453
|
# resp.keys["name"] #=> Array
|
2087
2454
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
2088
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
2455
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY", "ORDER"
|
2089
2456
|
# resp.keys["name"][0].field_names #=> Array
|
2090
2457
|
# resp.keys["name"][0].field_names[0] #=> String
|
2091
2458
|
# resp.created_at #=> Time
|
@@ -2116,10 +2483,12 @@ module Aws::CustomerProfiles
|
|
2116
2483
|
#
|
2117
2484
|
# @option params [required, String] :key_name
|
2118
2485
|
# A searchable identifier of a customer profile. The predefined keys you
|
2119
|
-
# can use to search include: \_account, \_profileId, \
|
2120
|
-
# \_phone, \_email, \_ctrContactId,
|
2121
|
-
# \
|
2122
|
-
# \
|
2486
|
+
# can use to search include: \_account, \_profileId, \_assetId,
|
2487
|
+
# \_caseId, \_orderId, \_fullName, \_phone, \_email, \_ctrContactId,
|
2488
|
+
# \_marketoLeadId, \_salesforceAccountId, \_salesforceContactId,
|
2489
|
+
# \_salesforceAssetId, \_zendeskUserId, \_zendeskExternalId,
|
2490
|
+
# \_zendeskTicketId, \_serviceNowSystemId, \_serviceNowIncidentId,
|
2491
|
+
# \_segmentUserId, \_shopifyCustomerId, \_shopifyOrderId.
|
2123
2492
|
#
|
2124
2493
|
# @option params [required, Array<String>] :values
|
2125
2494
|
# A list of key values.
|
@@ -2603,7 +2972,7 @@ module Aws::CustomerProfiles
|
|
2603
2972
|
params: params,
|
2604
2973
|
config: config)
|
2605
2974
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
2606
|
-
context[:gem_version] = '1.
|
2975
|
+
context[:gem_version] = '1.19.0'
|
2607
2976
|
Seahorse::Client::Request.new(handlers, context)
|
2608
2977
|
end
|
2609
2978
|
|