aws-sdk-customerprofiles 1.28.0 → 1.30.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +592 -3
- data/lib/aws-sdk-customerprofiles/client_api.rb +384 -0
- data/lib/aws-sdk-customerprofiles/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-customerprofiles/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-customerprofiles/endpoints.rb +154 -0
- data/lib/aws-sdk-customerprofiles/plugins/endpoints.rb +22 -0
- data/lib/aws-sdk-customerprofiles/types.rb +887 -15
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- metadata +2 -2
@@ -427,6 +427,116 @@ module Aws::CustomerProfiles
|
|
427
427
|
req.send_request(options)
|
428
428
|
end
|
429
429
|
|
430
|
+
# Creates a new calculated attribute definition. After creation, new
|
431
|
+
# object data ingested into Customer Profiles will be included in the
|
432
|
+
# calculated attribute, which can be retrieved for a profile using the
|
433
|
+
# [GetCalculatedAttributeForProfile][1] API. Defining a calculated
|
434
|
+
# attribute makes it available for all profiles within a domain. Each
|
435
|
+
# calculated attribute can only reference one `ObjectType` and at most,
|
436
|
+
# two fields from that `ObjectType`.
|
437
|
+
#
|
438
|
+
#
|
439
|
+
#
|
440
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html
|
441
|
+
#
|
442
|
+
# @option params [required, String] :domain_name
|
443
|
+
# The unique name of the domain.
|
444
|
+
#
|
445
|
+
# @option params [required, String] :calculated_attribute_name
|
446
|
+
# The unique name of the calculated attribute.
|
447
|
+
#
|
448
|
+
# @option params [String] :display_name
|
449
|
+
# The display name of the calculated attribute.
|
450
|
+
#
|
451
|
+
# @option params [String] :description
|
452
|
+
# The description of the calculated attribute.
|
453
|
+
#
|
454
|
+
# @option params [required, Types::AttributeDetails] :attribute_details
|
455
|
+
# Mathematical expression and a list of attribute items specified in
|
456
|
+
# that expression.
|
457
|
+
#
|
458
|
+
# @option params [Types::Conditions] :conditions
|
459
|
+
# The conditions including range, object count, and threshold for the
|
460
|
+
# calculated attribute.
|
461
|
+
#
|
462
|
+
# @option params [required, String] :statistic
|
463
|
+
# The aggregation operation to perform for the calculated attribute.
|
464
|
+
#
|
465
|
+
# @option params [Hash<String,String>] :tags
|
466
|
+
# The tags used to organize, track, or control access for this resource.
|
467
|
+
#
|
468
|
+
# @return [Types::CreateCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
469
|
+
#
|
470
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
|
471
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#display_name #display_name} => String
|
472
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#description #description} => String
|
473
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
474
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
475
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
476
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
477
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
478
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
479
|
+
#
|
480
|
+
# @example Request syntax with placeholder values
|
481
|
+
#
|
482
|
+
# resp = client.create_calculated_attribute_definition({
|
483
|
+
# domain_name: "name", # required
|
484
|
+
# calculated_attribute_name: "typeName", # required
|
485
|
+
# display_name: "displayName",
|
486
|
+
# description: "text",
|
487
|
+
# attribute_details: { # required
|
488
|
+
# attributes: [ # required
|
489
|
+
# {
|
490
|
+
# name: "attributeName", # required
|
491
|
+
# },
|
492
|
+
# ],
|
493
|
+
# expression: "string1To255", # required
|
494
|
+
# },
|
495
|
+
# conditions: {
|
496
|
+
# range: {
|
497
|
+
# value: 1, # required
|
498
|
+
# unit: "DAYS", # required, accepts DAYS
|
499
|
+
# },
|
500
|
+
# object_count: 1,
|
501
|
+
# threshold: {
|
502
|
+
# value: "string1To255", # required
|
503
|
+
# operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
|
504
|
+
# },
|
505
|
+
# },
|
506
|
+
# statistic: "FIRST_OCCURRENCE", # required, accepts FIRST_OCCURRENCE, LAST_OCCURRENCE, COUNT, SUM, MINIMUM, MAXIMUM, AVERAGE, MAX_OCCURRENCE
|
507
|
+
# tags: {
|
508
|
+
# "TagKey" => "TagValue",
|
509
|
+
# },
|
510
|
+
# })
|
511
|
+
#
|
512
|
+
# @example Response structure
|
513
|
+
#
|
514
|
+
# resp.calculated_attribute_name #=> String
|
515
|
+
# resp.display_name #=> String
|
516
|
+
# resp.description #=> String
|
517
|
+
# resp.attribute_details.attributes #=> Array
|
518
|
+
# resp.attribute_details.attributes[0].name #=> String
|
519
|
+
# resp.attribute_details.expression #=> String
|
520
|
+
# resp.conditions.range.value #=> Integer
|
521
|
+
# resp.conditions.range.unit #=> String, one of "DAYS"
|
522
|
+
# resp.conditions.object_count #=> Integer
|
523
|
+
# resp.conditions.threshold.value #=> String
|
524
|
+
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
525
|
+
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
526
|
+
# resp.created_at #=> Time
|
527
|
+
# resp.last_updated_at #=> Time
|
528
|
+
# resp.tags #=> Hash
|
529
|
+
# resp.tags["TagKey"] #=> String
|
530
|
+
#
|
531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition AWS API Documentation
|
532
|
+
#
|
533
|
+
# @overload create_calculated_attribute_definition(params = {})
|
534
|
+
# @param [Hash] params ({})
|
535
|
+
def create_calculated_attribute_definition(params = {}, options = {})
|
536
|
+
req = build_request(:create_calculated_attribute_definition, params)
|
537
|
+
req.send_request(options)
|
538
|
+
end
|
539
|
+
|
430
540
|
# Creates a domain, which is a container for all customer data, such as
|
431
541
|
# customer profile attributes, object types, profile keys, and
|
432
542
|
# encryption keys. You can create multiple domains, and each domain can
|
@@ -566,6 +676,58 @@ module Aws::CustomerProfiles
|
|
566
676
|
req.send_request(options)
|
567
677
|
end
|
568
678
|
|
679
|
+
# Creates an event stream, which is a subscription to real-time events,
|
680
|
+
# such as when profiles are created and updated through Amazon Connect
|
681
|
+
# Customer Profiles.
|
682
|
+
#
|
683
|
+
# Each event stream can be associated with only one Kinesis Data Stream
|
684
|
+
# destination in the same region and Amazon Web Services account as the
|
685
|
+
# customer profiles domain
|
686
|
+
#
|
687
|
+
# @option params [required, String] :domain_name
|
688
|
+
# The unique name of the domain.
|
689
|
+
#
|
690
|
+
# @option params [required, String] :uri
|
691
|
+
# The StreamARN of the destination to deliver profile events to. For
|
692
|
+
# example, arn:aws:kinesis:region:account-id:stream/stream-name
|
693
|
+
#
|
694
|
+
# @option params [required, String] :event_stream_name
|
695
|
+
# The name of the event stream.
|
696
|
+
#
|
697
|
+
# @option params [Hash<String,String>] :tags
|
698
|
+
# The tags used to organize, track, or control access for this resource.
|
699
|
+
#
|
700
|
+
# @return [Types::CreateEventStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
701
|
+
#
|
702
|
+
# * {Types::CreateEventStreamResponse#event_stream_arn #event_stream_arn} => String
|
703
|
+
# * {Types::CreateEventStreamResponse#tags #tags} => Hash<String,String>
|
704
|
+
#
|
705
|
+
# @example Request syntax with placeholder values
|
706
|
+
#
|
707
|
+
# resp = client.create_event_stream({
|
708
|
+
# domain_name: "name", # required
|
709
|
+
# uri: "string1To255", # required
|
710
|
+
# event_stream_name: "name", # required
|
711
|
+
# tags: {
|
712
|
+
# "TagKey" => "TagValue",
|
713
|
+
# },
|
714
|
+
# })
|
715
|
+
#
|
716
|
+
# @example Response structure
|
717
|
+
#
|
718
|
+
# resp.event_stream_arn #=> String
|
719
|
+
# resp.tags #=> Hash
|
720
|
+
# resp.tags["TagKey"] #=> String
|
721
|
+
#
|
722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateEventStream AWS API Documentation
|
723
|
+
#
|
724
|
+
# @overload create_event_stream(params = {})
|
725
|
+
# @param [Hash] params ({})
|
726
|
+
def create_event_stream(params = {}, options = {})
|
727
|
+
req = build_request(:create_event_stream, params)
|
728
|
+
req.send_request(options)
|
729
|
+
end
|
730
|
+
|
569
731
|
# Creates an integration workflow. An integration workflow is an async
|
570
732
|
# process which ingests historic data and sets up an integration for
|
571
733
|
# ongoing updates. The supported Amazon AppFlow sources are Salesforce,
|
@@ -868,6 +1030,36 @@ module Aws::CustomerProfiles
|
|
868
1030
|
req.send_request(options)
|
869
1031
|
end
|
870
1032
|
|
1033
|
+
# Deletes an existing calculated attribute definition. Note that
|
1034
|
+
# deleting a default calculated attribute is possible, however once
|
1035
|
+
# deleted, you will be unable to undo that action and will need to
|
1036
|
+
# recreate it on your own using the CreateCalculatedAttributeDefinition
|
1037
|
+
# API if you want it back.
|
1038
|
+
#
|
1039
|
+
# @option params [required, String] :domain_name
|
1040
|
+
# The unique name of the domain.
|
1041
|
+
#
|
1042
|
+
# @option params [required, String] :calculated_attribute_name
|
1043
|
+
# The unique name of the calculated attribute.
|
1044
|
+
#
|
1045
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1046
|
+
#
|
1047
|
+
# @example Request syntax with placeholder values
|
1048
|
+
#
|
1049
|
+
# resp = client.delete_calculated_attribute_definition({
|
1050
|
+
# domain_name: "name", # required
|
1051
|
+
# calculated_attribute_name: "typeName", # required
|
1052
|
+
# })
|
1053
|
+
#
|
1054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition AWS API Documentation
|
1055
|
+
#
|
1056
|
+
# @overload delete_calculated_attribute_definition(params = {})
|
1057
|
+
# @param [Hash] params ({})
|
1058
|
+
def delete_calculated_attribute_definition(params = {}, options = {})
|
1059
|
+
req = build_request(:delete_calculated_attribute_definition, params)
|
1060
|
+
req.send_request(options)
|
1061
|
+
end
|
1062
|
+
|
871
1063
|
# Deletes a specific domain and all of its customer data, such as
|
872
1064
|
# customer profile attributes and their related objects.
|
873
1065
|
#
|
@@ -897,6 +1089,32 @@ module Aws::CustomerProfiles
|
|
897
1089
|
req.send_request(options)
|
898
1090
|
end
|
899
1091
|
|
1092
|
+
# Disables and deletes the specified event stream.
|
1093
|
+
#
|
1094
|
+
# @option params [required, String] :domain_name
|
1095
|
+
# The unique name of the domain.
|
1096
|
+
#
|
1097
|
+
# @option params [required, String] :event_stream_name
|
1098
|
+
# The name of the event stream
|
1099
|
+
#
|
1100
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1101
|
+
#
|
1102
|
+
# @example Request syntax with placeholder values
|
1103
|
+
#
|
1104
|
+
# resp = client.delete_event_stream({
|
1105
|
+
# domain_name: "name", # required
|
1106
|
+
# event_stream_name: "name", # required
|
1107
|
+
# })
|
1108
|
+
#
|
1109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteEventStream AWS API Documentation
|
1110
|
+
#
|
1111
|
+
# @overload delete_event_stream(params = {})
|
1112
|
+
# @param [Hash] params ({})
|
1113
|
+
def delete_event_stream(params = {}, options = {})
|
1114
|
+
req = build_request(:delete_event_stream, params)
|
1115
|
+
req.send_request(options)
|
1116
|
+
end
|
1117
|
+
|
900
1118
|
# Removes an integration from a specific domain.
|
901
1119
|
#
|
902
1120
|
# @option params [required, String] :domain_name
|
@@ -1176,6 +1394,104 @@ module Aws::CustomerProfiles
|
|
1176
1394
|
req.send_request(options)
|
1177
1395
|
end
|
1178
1396
|
|
1397
|
+
# Provides more information on a calculated attribute definition for
|
1398
|
+
# Customer Profiles.
|
1399
|
+
#
|
1400
|
+
# @option params [required, String] :domain_name
|
1401
|
+
# The unique name of the domain.
|
1402
|
+
#
|
1403
|
+
# @option params [required, String] :calculated_attribute_name
|
1404
|
+
# The unique name of the calculated attribute.
|
1405
|
+
#
|
1406
|
+
# @return [Types::GetCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1407
|
+
#
|
1408
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
|
1409
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#display_name #display_name} => String
|
1410
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#description #description} => String
|
1411
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
1412
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
1413
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
1414
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
1415
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
1416
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
1417
|
+
#
|
1418
|
+
# @example Request syntax with placeholder values
|
1419
|
+
#
|
1420
|
+
# resp = client.get_calculated_attribute_definition({
|
1421
|
+
# domain_name: "name", # required
|
1422
|
+
# calculated_attribute_name: "typeName", # required
|
1423
|
+
# })
|
1424
|
+
#
|
1425
|
+
# @example Response structure
|
1426
|
+
#
|
1427
|
+
# resp.calculated_attribute_name #=> String
|
1428
|
+
# resp.display_name #=> String
|
1429
|
+
# resp.description #=> String
|
1430
|
+
# resp.created_at #=> Time
|
1431
|
+
# resp.last_updated_at #=> Time
|
1432
|
+
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
1433
|
+
# resp.conditions.range.value #=> Integer
|
1434
|
+
# resp.conditions.range.unit #=> String, one of "DAYS"
|
1435
|
+
# resp.conditions.object_count #=> Integer
|
1436
|
+
# resp.conditions.threshold.value #=> String
|
1437
|
+
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
1438
|
+
# resp.attribute_details.attributes #=> Array
|
1439
|
+
# resp.attribute_details.attributes[0].name #=> String
|
1440
|
+
# resp.attribute_details.expression #=> String
|
1441
|
+
# resp.tags #=> Hash
|
1442
|
+
# resp.tags["TagKey"] #=> String
|
1443
|
+
#
|
1444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition AWS API Documentation
|
1445
|
+
#
|
1446
|
+
# @overload get_calculated_attribute_definition(params = {})
|
1447
|
+
# @param [Hash] params ({})
|
1448
|
+
def get_calculated_attribute_definition(params = {}, options = {})
|
1449
|
+
req = build_request(:get_calculated_attribute_definition, params)
|
1450
|
+
req.send_request(options)
|
1451
|
+
end
|
1452
|
+
|
1453
|
+
# Retrieve a calculated attribute for a customer profile.
|
1454
|
+
#
|
1455
|
+
# @option params [required, String] :domain_name
|
1456
|
+
# The unique name of the domain.
|
1457
|
+
#
|
1458
|
+
# @option params [required, String] :profile_id
|
1459
|
+
# The unique identifier of a customer profile.
|
1460
|
+
#
|
1461
|
+
# @option params [required, String] :calculated_attribute_name
|
1462
|
+
# The unique name of the calculated attribute.
|
1463
|
+
#
|
1464
|
+
# @return [Types::GetCalculatedAttributeForProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1465
|
+
#
|
1466
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#calculated_attribute_name #calculated_attribute_name} => String
|
1467
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#display_name #display_name} => String
|
1468
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#is_data_partial #is_data_partial} => String
|
1469
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#value #value} => String
|
1470
|
+
#
|
1471
|
+
# @example Request syntax with placeholder values
|
1472
|
+
#
|
1473
|
+
# resp = client.get_calculated_attribute_for_profile({
|
1474
|
+
# domain_name: "name", # required
|
1475
|
+
# profile_id: "uuid", # required
|
1476
|
+
# calculated_attribute_name: "typeName", # required
|
1477
|
+
# })
|
1478
|
+
#
|
1479
|
+
# @example Response structure
|
1480
|
+
#
|
1481
|
+
# resp.calculated_attribute_name #=> String
|
1482
|
+
# resp.display_name #=> String
|
1483
|
+
# resp.is_data_partial #=> String
|
1484
|
+
# resp.value #=> String
|
1485
|
+
#
|
1486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile AWS API Documentation
|
1487
|
+
#
|
1488
|
+
# @overload get_calculated_attribute_for_profile(params = {})
|
1489
|
+
# @param [Hash] params ({})
|
1490
|
+
def get_calculated_attribute_for_profile(params = {}, options = {})
|
1491
|
+
req = build_request(:get_calculated_attribute_for_profile, params)
|
1492
|
+
req.send_request(options)
|
1493
|
+
end
|
1494
|
+
|
1179
1495
|
# Returns information about a specific domain.
|
1180
1496
|
#
|
1181
1497
|
# @option params [required, String] :domain_name
|
@@ -1235,6 +1551,55 @@ module Aws::CustomerProfiles
|
|
1235
1551
|
req.send_request(options)
|
1236
1552
|
end
|
1237
1553
|
|
1554
|
+
# Returns information about the specified event stream in a specific
|
1555
|
+
# domain.
|
1556
|
+
#
|
1557
|
+
# @option params [required, String] :domain_name
|
1558
|
+
# The unique name of the domain.
|
1559
|
+
#
|
1560
|
+
# @option params [required, String] :event_stream_name
|
1561
|
+
# The name of the event stream provided during create operations.
|
1562
|
+
#
|
1563
|
+
# @return [Types::GetEventStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1564
|
+
#
|
1565
|
+
# * {Types::GetEventStreamResponse#domain_name #domain_name} => String
|
1566
|
+
# * {Types::GetEventStreamResponse#event_stream_arn #event_stream_arn} => String
|
1567
|
+
# * {Types::GetEventStreamResponse#created_at #created_at} => Time
|
1568
|
+
# * {Types::GetEventStreamResponse#state #state} => String
|
1569
|
+
# * {Types::GetEventStreamResponse#stopped_since #stopped_since} => Time
|
1570
|
+
# * {Types::GetEventStreamResponse#destination_details #destination_details} => Types::EventStreamDestinationDetails
|
1571
|
+
# * {Types::GetEventStreamResponse#tags #tags} => Hash<String,String>
|
1572
|
+
#
|
1573
|
+
# @example Request syntax with placeholder values
|
1574
|
+
#
|
1575
|
+
# resp = client.get_event_stream({
|
1576
|
+
# domain_name: "name", # required
|
1577
|
+
# event_stream_name: "name", # required
|
1578
|
+
# })
|
1579
|
+
#
|
1580
|
+
# @example Response structure
|
1581
|
+
#
|
1582
|
+
# resp.domain_name #=> String
|
1583
|
+
# resp.event_stream_arn #=> String
|
1584
|
+
# resp.created_at #=> Time
|
1585
|
+
# resp.state #=> String, one of "RUNNING", "STOPPED"
|
1586
|
+
# resp.stopped_since #=> Time
|
1587
|
+
# resp.destination_details.uri #=> String
|
1588
|
+
# resp.destination_details.status #=> String, one of "HEALTHY", "UNHEALTHY"
|
1589
|
+
# resp.destination_details.unhealthy_since #=> Time
|
1590
|
+
# resp.destination_details.message #=> String
|
1591
|
+
# resp.tags #=> Hash
|
1592
|
+
# resp.tags["TagKey"] #=> String
|
1593
|
+
#
|
1594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetEventStream AWS API Documentation
|
1595
|
+
#
|
1596
|
+
# @overload get_event_stream(params = {})
|
1597
|
+
# @param [Hash] params ({})
|
1598
|
+
def get_event_stream(params = {}, options = {})
|
1599
|
+
req = build_request(:get_event_stream, params)
|
1600
|
+
req.send_request(options)
|
1601
|
+
end
|
1602
|
+
|
1238
1603
|
# Returns information about an Identity Resolution Job in a specific
|
1239
1604
|
# domain.
|
1240
1605
|
#
|
@@ -1729,6 +2094,100 @@ module Aws::CustomerProfiles
|
|
1729
2094
|
req.send_request(options)
|
1730
2095
|
end
|
1731
2096
|
|
2097
|
+
# Lists calculated attribute definitions for Customer Profiles
|
2098
|
+
#
|
2099
|
+
# @option params [required, String] :domain_name
|
2100
|
+
# The unique name of the domain.
|
2101
|
+
#
|
2102
|
+
# @option params [String] :next_token
|
2103
|
+
# The pagination token from the previous call to
|
2104
|
+
# ListCalculatedAttributeDefinitions.
|
2105
|
+
#
|
2106
|
+
# @option params [Integer] :max_results
|
2107
|
+
# The maximum number of calculated attribute definitions returned per
|
2108
|
+
# page.
|
2109
|
+
#
|
2110
|
+
# @return [Types::ListCalculatedAttributeDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2111
|
+
#
|
2112
|
+
# * {Types::ListCalculatedAttributeDefinitionsResponse#items #items} => Array<Types::ListCalculatedAttributeDefinitionItem>
|
2113
|
+
# * {Types::ListCalculatedAttributeDefinitionsResponse#next_token #next_token} => String
|
2114
|
+
#
|
2115
|
+
# @example Request syntax with placeholder values
|
2116
|
+
#
|
2117
|
+
# resp = client.list_calculated_attribute_definitions({
|
2118
|
+
# domain_name: "name", # required
|
2119
|
+
# next_token: "token",
|
2120
|
+
# max_results: 1,
|
2121
|
+
# })
|
2122
|
+
#
|
2123
|
+
# @example Response structure
|
2124
|
+
#
|
2125
|
+
# resp.items #=> Array
|
2126
|
+
# resp.items[0].calculated_attribute_name #=> String
|
2127
|
+
# resp.items[0].display_name #=> String
|
2128
|
+
# resp.items[0].description #=> String
|
2129
|
+
# resp.items[0].created_at #=> Time
|
2130
|
+
# resp.items[0].last_updated_at #=> Time
|
2131
|
+
# resp.items[0].tags #=> Hash
|
2132
|
+
# resp.items[0].tags["TagKey"] #=> String
|
2133
|
+
# resp.next_token #=> String
|
2134
|
+
#
|
2135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions AWS API Documentation
|
2136
|
+
#
|
2137
|
+
# @overload list_calculated_attribute_definitions(params = {})
|
2138
|
+
# @param [Hash] params ({})
|
2139
|
+
def list_calculated_attribute_definitions(params = {}, options = {})
|
2140
|
+
req = build_request(:list_calculated_attribute_definitions, params)
|
2141
|
+
req.send_request(options)
|
2142
|
+
end
|
2143
|
+
|
2144
|
+
# Retrieve a list of calculated attributes for a customer profile.
|
2145
|
+
#
|
2146
|
+
# @option params [String] :next_token
|
2147
|
+
# The pagination token from the previous call to
|
2148
|
+
# ListCalculatedAttributesForProfile.
|
2149
|
+
#
|
2150
|
+
# @option params [Integer] :max_results
|
2151
|
+
# The maximum number of calculated attributes returned per page.
|
2152
|
+
#
|
2153
|
+
# @option params [required, String] :domain_name
|
2154
|
+
# The unique name of the domain.
|
2155
|
+
#
|
2156
|
+
# @option params [required, String] :profile_id
|
2157
|
+
# The unique identifier of a customer profile.
|
2158
|
+
#
|
2159
|
+
# @return [Types::ListCalculatedAttributesForProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2160
|
+
#
|
2161
|
+
# * {Types::ListCalculatedAttributesForProfileResponse#items #items} => Array<Types::ListCalculatedAttributeForProfileItem>
|
2162
|
+
# * {Types::ListCalculatedAttributesForProfileResponse#next_token #next_token} => String
|
2163
|
+
#
|
2164
|
+
# @example Request syntax with placeholder values
|
2165
|
+
#
|
2166
|
+
# resp = client.list_calculated_attributes_for_profile({
|
2167
|
+
# next_token: "token",
|
2168
|
+
# max_results: 1,
|
2169
|
+
# domain_name: "name", # required
|
2170
|
+
# profile_id: "uuid", # required
|
2171
|
+
# })
|
2172
|
+
#
|
2173
|
+
# @example Response structure
|
2174
|
+
#
|
2175
|
+
# resp.items #=> Array
|
2176
|
+
# resp.items[0].calculated_attribute_name #=> String
|
2177
|
+
# resp.items[0].display_name #=> String
|
2178
|
+
# resp.items[0].is_data_partial #=> String
|
2179
|
+
# resp.items[0].value #=> String
|
2180
|
+
# resp.next_token #=> String
|
2181
|
+
#
|
2182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile AWS API Documentation
|
2183
|
+
#
|
2184
|
+
# @overload list_calculated_attributes_for_profile(params = {})
|
2185
|
+
# @param [Hash] params ({})
|
2186
|
+
def list_calculated_attributes_for_profile(params = {}, options = {})
|
2187
|
+
req = build_request(:list_calculated_attributes_for_profile, params)
|
2188
|
+
req.send_request(options)
|
2189
|
+
end
|
2190
|
+
|
1732
2191
|
# Returns a list of all the domains for an AWS account that have been
|
1733
2192
|
# created.
|
1734
2193
|
#
|
@@ -1769,6 +2228,56 @@ module Aws::CustomerProfiles
|
|
1769
2228
|
req.send_request(options)
|
1770
2229
|
end
|
1771
2230
|
|
2231
|
+
# Returns a list of all the event streams in a specific domain.
|
2232
|
+
#
|
2233
|
+
# @option params [required, String] :domain_name
|
2234
|
+
# The unique name of the domain.
|
2235
|
+
#
|
2236
|
+
# @option params [String] :next_token
|
2237
|
+
# Identifies the next page of results to return.
|
2238
|
+
#
|
2239
|
+
# @option params [Integer] :max_results
|
2240
|
+
# The maximum number of objects returned per page.
|
2241
|
+
#
|
2242
|
+
# @return [Types::ListEventStreamsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2243
|
+
#
|
2244
|
+
# * {Types::ListEventStreamsResponse#items #items} => Array<Types::EventStreamSummary>
|
2245
|
+
# * {Types::ListEventStreamsResponse#next_token #next_token} => String
|
2246
|
+
#
|
2247
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2248
|
+
#
|
2249
|
+
# @example Request syntax with placeholder values
|
2250
|
+
#
|
2251
|
+
# resp = client.list_event_streams({
|
2252
|
+
# domain_name: "name", # required
|
2253
|
+
# next_token: "token",
|
2254
|
+
# max_results: 1,
|
2255
|
+
# })
|
2256
|
+
#
|
2257
|
+
# @example Response structure
|
2258
|
+
#
|
2259
|
+
# resp.items #=> Array
|
2260
|
+
# resp.items[0].domain_name #=> String
|
2261
|
+
# resp.items[0].event_stream_name #=> String
|
2262
|
+
# resp.items[0].event_stream_arn #=> String
|
2263
|
+
# resp.items[0].state #=> String, one of "RUNNING", "STOPPED"
|
2264
|
+
# resp.items[0].stopped_since #=> Time
|
2265
|
+
# resp.items[0].destination_summary.uri #=> String
|
2266
|
+
# resp.items[0].destination_summary.status #=> String, one of "HEALTHY", "UNHEALTHY"
|
2267
|
+
# resp.items[0].destination_summary.unhealthy_since #=> Time
|
2268
|
+
# resp.items[0].tags #=> Hash
|
2269
|
+
# resp.items[0].tags["TagKey"] #=> String
|
2270
|
+
# resp.next_token #=> String
|
2271
|
+
#
|
2272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListEventStreams AWS API Documentation
|
2273
|
+
#
|
2274
|
+
# @overload list_event_streams(params = {})
|
2275
|
+
# @param [Hash] params ({})
|
2276
|
+
def list_event_streams(params = {}, options = {})
|
2277
|
+
req = build_request(:list_event_streams, params)
|
2278
|
+
req.send_request(options)
|
2279
|
+
end
|
2280
|
+
|
1772
2281
|
# Lists all of the Identity Resolution Jobs in your domain. The response
|
1773
2282
|
# sorts the list by `JobStartTime`.
|
1774
2283
|
#
|
@@ -1977,8 +2486,7 @@ module Aws::CustomerProfiles
|
|
1977
2486
|
#
|
1978
2487
|
# @option params [Types::ObjectFilter] :object_filter
|
1979
2488
|
# Applies a filter to the response to include profile objects with the
|
1980
|
-
# specified index values.
|
1981
|
-
# ObjectTypeName \_asset, \_case and \_order.
|
2489
|
+
# specified index values.
|
1982
2490
|
#
|
1983
2491
|
# @return [Types::ListProfileObjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1984
2492
|
#
|
@@ -2777,6 +3285,87 @@ module Aws::CustomerProfiles
|
|
2777
3285
|
req.send_request(options)
|
2778
3286
|
end
|
2779
3287
|
|
3288
|
+
# Updates an existing calculated attribute definition. When updating the
|
3289
|
+
# Conditions, note that increasing the date range of a calculated
|
3290
|
+
# attribute will not trigger inclusion of historical data greater than
|
3291
|
+
# the current date range.
|
3292
|
+
#
|
3293
|
+
# @option params [required, String] :domain_name
|
3294
|
+
# The unique name of the domain.
|
3295
|
+
#
|
3296
|
+
# @option params [required, String] :calculated_attribute_name
|
3297
|
+
# The unique name of the calculated attribute.
|
3298
|
+
#
|
3299
|
+
# @option params [String] :display_name
|
3300
|
+
# The display name of the calculated attribute.
|
3301
|
+
#
|
3302
|
+
# @option params [String] :description
|
3303
|
+
# The description of the calculated attribute.
|
3304
|
+
#
|
3305
|
+
# @option params [Types::Conditions] :conditions
|
3306
|
+
# The conditions including range, object count, and threshold for the
|
3307
|
+
# calculated attribute.
|
3308
|
+
#
|
3309
|
+
# @return [Types::UpdateCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3310
|
+
#
|
3311
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
|
3312
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#display_name #display_name} => String
|
3313
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#description #description} => String
|
3314
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
3315
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
3316
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
3317
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
3318
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
3319
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
3320
|
+
#
|
3321
|
+
# @example Request syntax with placeholder values
|
3322
|
+
#
|
3323
|
+
# resp = client.update_calculated_attribute_definition({
|
3324
|
+
# domain_name: "name", # required
|
3325
|
+
# calculated_attribute_name: "typeName", # required
|
3326
|
+
# display_name: "displayName",
|
3327
|
+
# description: "text",
|
3328
|
+
# conditions: {
|
3329
|
+
# range: {
|
3330
|
+
# value: 1, # required
|
3331
|
+
# unit: "DAYS", # required, accepts DAYS
|
3332
|
+
# },
|
3333
|
+
# object_count: 1,
|
3334
|
+
# threshold: {
|
3335
|
+
# value: "string1To255", # required
|
3336
|
+
# operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
|
3337
|
+
# },
|
3338
|
+
# },
|
3339
|
+
# })
|
3340
|
+
#
|
3341
|
+
# @example Response structure
|
3342
|
+
#
|
3343
|
+
# resp.calculated_attribute_name #=> String
|
3344
|
+
# resp.display_name #=> String
|
3345
|
+
# resp.description #=> String
|
3346
|
+
# resp.created_at #=> Time
|
3347
|
+
# resp.last_updated_at #=> Time
|
3348
|
+
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
3349
|
+
# resp.conditions.range.value #=> Integer
|
3350
|
+
# resp.conditions.range.unit #=> String, one of "DAYS"
|
3351
|
+
# resp.conditions.object_count #=> Integer
|
3352
|
+
# resp.conditions.threshold.value #=> String
|
3353
|
+
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
3354
|
+
# resp.attribute_details.attributes #=> Array
|
3355
|
+
# resp.attribute_details.attributes[0].name #=> String
|
3356
|
+
# resp.attribute_details.expression #=> String
|
3357
|
+
# resp.tags #=> Hash
|
3358
|
+
# resp.tags["TagKey"] #=> String
|
3359
|
+
#
|
3360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition AWS API Documentation
|
3361
|
+
#
|
3362
|
+
# @overload update_calculated_attribute_definition(params = {})
|
3363
|
+
# @param [Hash] params ({})
|
3364
|
+
def update_calculated_attribute_definition(params = {}, options = {})
|
3365
|
+
req = build_request(:update_calculated_attribute_definition, params)
|
3366
|
+
req.send_request(options)
|
3367
|
+
end
|
3368
|
+
|
2780
3369
|
# Updates the properties of a domain, including creating or selecting a
|
2781
3370
|
# dead letter queue or an encryption key.
|
2782
3371
|
#
|
@@ -3111,7 +3700,7 @@ module Aws::CustomerProfiles
|
|
3111
3700
|
params: params,
|
3112
3701
|
config: config)
|
3113
3702
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
3114
|
-
context[:gem_version] = '1.
|
3703
|
+
context[:gem_version] = '1.30.0'
|
3115
3704
|
Seahorse::Client::Request.new(handlers, context)
|
3116
3705
|
end
|
3117
3706
|
|