aws-sdk-customerprofiles 1.56.0 → 1.57.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +1323 -6
- data/lib/aws-sdk-customerprofiles/client_api.rb +623 -0
- data/lib/aws-sdk-customerprofiles/types.rb +1375 -16
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- data/sig/client.rbs +621 -1
- data/sig/types.rbs +394 -1
- metadata +2 -2
|
@@ -501,6 +501,169 @@ module Aws::CustomerProfiles
|
|
|
501
501
|
req.send_request(options)
|
|
502
502
|
end
|
|
503
503
|
|
|
504
|
+
# Fetch the possible attribute values given the attribute name.
|
|
505
|
+
#
|
|
506
|
+
# @option params [required, String] :calculated_attribute_name
|
|
507
|
+
# The unique name of the calculated attribute.
|
|
508
|
+
#
|
|
509
|
+
# @option params [required, String] :domain_name
|
|
510
|
+
# The unique name of the domain.
|
|
511
|
+
#
|
|
512
|
+
# @option params [required, Array<String>] :profile_ids
|
|
513
|
+
# List of unique identifiers for customer profiles to retrieve.
|
|
514
|
+
#
|
|
515
|
+
# @option params [Types::ConditionOverrides] :condition_overrides
|
|
516
|
+
# Overrides the condition block within the original calculated attribute
|
|
517
|
+
# definition.
|
|
518
|
+
#
|
|
519
|
+
# @return [Types::BatchGetCalculatedAttributeForProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
520
|
+
#
|
|
521
|
+
# * {Types::BatchGetCalculatedAttributeForProfileResponse#errors #errors} => Array<Types::BatchGetCalculatedAttributeForProfileError>
|
|
522
|
+
# * {Types::BatchGetCalculatedAttributeForProfileResponse#calculated_attribute_values #calculated_attribute_values} => Array<Types::CalculatedAttributeValue>
|
|
523
|
+
# * {Types::BatchGetCalculatedAttributeForProfileResponse#condition_overrides #condition_overrides} => Types::ConditionOverrides
|
|
524
|
+
#
|
|
525
|
+
# @example Request syntax with placeholder values
|
|
526
|
+
#
|
|
527
|
+
# resp = client.batch_get_calculated_attribute_for_profile({
|
|
528
|
+
# calculated_attribute_name: "typeName", # required
|
|
529
|
+
# domain_name: "name", # required
|
|
530
|
+
# profile_ids: ["uuid"], # required
|
|
531
|
+
# condition_overrides: {
|
|
532
|
+
# range: {
|
|
533
|
+
# start: 1, # required
|
|
534
|
+
# end: 1,
|
|
535
|
+
# unit: "DAYS", # required, accepts DAYS
|
|
536
|
+
# },
|
|
537
|
+
# },
|
|
538
|
+
# })
|
|
539
|
+
#
|
|
540
|
+
# @example Response structure
|
|
541
|
+
#
|
|
542
|
+
# resp.errors #=> Array
|
|
543
|
+
# resp.errors[0].code #=> String
|
|
544
|
+
# resp.errors[0].message #=> String
|
|
545
|
+
# resp.errors[0].profile_id #=> String
|
|
546
|
+
# resp.calculated_attribute_values #=> Array
|
|
547
|
+
# resp.calculated_attribute_values[0].calculated_attribute_name #=> String
|
|
548
|
+
# resp.calculated_attribute_values[0].display_name #=> String
|
|
549
|
+
# resp.calculated_attribute_values[0].is_data_partial #=> String
|
|
550
|
+
# resp.calculated_attribute_values[0].profile_id #=> String
|
|
551
|
+
# resp.calculated_attribute_values[0].value #=> String
|
|
552
|
+
# resp.condition_overrides.range.start #=> Integer
|
|
553
|
+
# resp.condition_overrides.range.end #=> Integer
|
|
554
|
+
# resp.condition_overrides.range.unit #=> String, one of "DAYS"
|
|
555
|
+
#
|
|
556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile AWS API Documentation
|
|
557
|
+
#
|
|
558
|
+
# @overload batch_get_calculated_attribute_for_profile(params = {})
|
|
559
|
+
# @param [Hash] params ({})
|
|
560
|
+
def batch_get_calculated_attribute_for_profile(params = {}, options = {})
|
|
561
|
+
req = build_request(:batch_get_calculated_attribute_for_profile, params)
|
|
562
|
+
req.send_request(options)
|
|
563
|
+
end
|
|
564
|
+
|
|
565
|
+
# Get a batch of profiles.
|
|
566
|
+
#
|
|
567
|
+
# @option params [required, String] :domain_name
|
|
568
|
+
# The unique name of the domain.
|
|
569
|
+
#
|
|
570
|
+
# @option params [required, Array<String>] :profile_ids
|
|
571
|
+
# List of unique identifiers for customer profiles to retrieve.
|
|
572
|
+
#
|
|
573
|
+
# @return [Types::BatchGetProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
574
|
+
#
|
|
575
|
+
# * {Types::BatchGetProfileResponse#errors #errors} => Array<Types::BatchGetProfileError>
|
|
576
|
+
# * {Types::BatchGetProfileResponse#profiles #profiles} => Array<Types::Profile>
|
|
577
|
+
#
|
|
578
|
+
# @example Request syntax with placeholder values
|
|
579
|
+
#
|
|
580
|
+
# resp = client.batch_get_profile({
|
|
581
|
+
# domain_name: "name", # required
|
|
582
|
+
# profile_ids: ["uuid"], # required
|
|
583
|
+
# })
|
|
584
|
+
#
|
|
585
|
+
# @example Response structure
|
|
586
|
+
#
|
|
587
|
+
# resp.errors #=> Array
|
|
588
|
+
# resp.errors[0].code #=> String
|
|
589
|
+
# resp.errors[0].message #=> String
|
|
590
|
+
# resp.errors[0].profile_id #=> String
|
|
591
|
+
# resp.profiles #=> Array
|
|
592
|
+
# resp.profiles[0].profile_id #=> String
|
|
593
|
+
# resp.profiles[0].account_number #=> String
|
|
594
|
+
# resp.profiles[0].additional_information #=> String
|
|
595
|
+
# resp.profiles[0].party_type #=> String, one of "INDIVIDUAL", "BUSINESS", "OTHER"
|
|
596
|
+
# resp.profiles[0].business_name #=> String
|
|
597
|
+
# resp.profiles[0].first_name #=> String
|
|
598
|
+
# resp.profiles[0].middle_name #=> String
|
|
599
|
+
# resp.profiles[0].last_name #=> String
|
|
600
|
+
# resp.profiles[0].birth_date #=> String
|
|
601
|
+
# resp.profiles[0].gender #=> String, one of "MALE", "FEMALE", "UNSPECIFIED"
|
|
602
|
+
# resp.profiles[0].phone_number #=> String
|
|
603
|
+
# resp.profiles[0].mobile_phone_number #=> String
|
|
604
|
+
# resp.profiles[0].home_phone_number #=> String
|
|
605
|
+
# resp.profiles[0].business_phone_number #=> String
|
|
606
|
+
# resp.profiles[0].email_address #=> String
|
|
607
|
+
# resp.profiles[0].personal_email_address #=> String
|
|
608
|
+
# resp.profiles[0].business_email_address #=> String
|
|
609
|
+
# resp.profiles[0].address.address_1 #=> String
|
|
610
|
+
# resp.profiles[0].address.address_2 #=> String
|
|
611
|
+
# resp.profiles[0].address.address_3 #=> String
|
|
612
|
+
# resp.profiles[0].address.address_4 #=> String
|
|
613
|
+
# resp.profiles[0].address.city #=> String
|
|
614
|
+
# resp.profiles[0].address.county #=> String
|
|
615
|
+
# resp.profiles[0].address.state #=> String
|
|
616
|
+
# resp.profiles[0].address.province #=> String
|
|
617
|
+
# resp.profiles[0].address.country #=> String
|
|
618
|
+
# resp.profiles[0].address.postal_code #=> String
|
|
619
|
+
# resp.profiles[0].shipping_address.address_1 #=> String
|
|
620
|
+
# resp.profiles[0].shipping_address.address_2 #=> String
|
|
621
|
+
# resp.profiles[0].shipping_address.address_3 #=> String
|
|
622
|
+
# resp.profiles[0].shipping_address.address_4 #=> String
|
|
623
|
+
# resp.profiles[0].shipping_address.city #=> String
|
|
624
|
+
# resp.profiles[0].shipping_address.county #=> String
|
|
625
|
+
# resp.profiles[0].shipping_address.state #=> String
|
|
626
|
+
# resp.profiles[0].shipping_address.province #=> String
|
|
627
|
+
# resp.profiles[0].shipping_address.country #=> String
|
|
628
|
+
# resp.profiles[0].shipping_address.postal_code #=> String
|
|
629
|
+
# resp.profiles[0].mailing_address.address_1 #=> String
|
|
630
|
+
# resp.profiles[0].mailing_address.address_2 #=> String
|
|
631
|
+
# resp.profiles[0].mailing_address.address_3 #=> String
|
|
632
|
+
# resp.profiles[0].mailing_address.address_4 #=> String
|
|
633
|
+
# resp.profiles[0].mailing_address.city #=> String
|
|
634
|
+
# resp.profiles[0].mailing_address.county #=> String
|
|
635
|
+
# resp.profiles[0].mailing_address.state #=> String
|
|
636
|
+
# resp.profiles[0].mailing_address.province #=> String
|
|
637
|
+
# resp.profiles[0].mailing_address.country #=> String
|
|
638
|
+
# resp.profiles[0].mailing_address.postal_code #=> String
|
|
639
|
+
# resp.profiles[0].billing_address.address_1 #=> String
|
|
640
|
+
# resp.profiles[0].billing_address.address_2 #=> String
|
|
641
|
+
# resp.profiles[0].billing_address.address_3 #=> String
|
|
642
|
+
# resp.profiles[0].billing_address.address_4 #=> String
|
|
643
|
+
# resp.profiles[0].billing_address.city #=> String
|
|
644
|
+
# resp.profiles[0].billing_address.county #=> String
|
|
645
|
+
# resp.profiles[0].billing_address.state #=> String
|
|
646
|
+
# resp.profiles[0].billing_address.province #=> String
|
|
647
|
+
# resp.profiles[0].billing_address.country #=> String
|
|
648
|
+
# resp.profiles[0].billing_address.postal_code #=> String
|
|
649
|
+
# resp.profiles[0].attributes #=> Hash
|
|
650
|
+
# resp.profiles[0].attributes["string1To255"] #=> String
|
|
651
|
+
# resp.profiles[0].found_by_items #=> Array
|
|
652
|
+
# resp.profiles[0].found_by_items[0].key_name #=> String
|
|
653
|
+
# resp.profiles[0].found_by_items[0].values #=> Array
|
|
654
|
+
# resp.profiles[0].found_by_items[0].values[0] #=> String
|
|
655
|
+
# resp.profiles[0].party_type_string #=> String
|
|
656
|
+
# resp.profiles[0].gender_string #=> String
|
|
657
|
+
#
|
|
658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetProfile AWS API Documentation
|
|
659
|
+
#
|
|
660
|
+
# @overload batch_get_profile(params = {})
|
|
661
|
+
# @param [Hash] params ({})
|
|
662
|
+
def batch_get_profile(params = {}, options = {})
|
|
663
|
+
req = build_request(:batch_get_profile, params)
|
|
664
|
+
req.send_request(options)
|
|
665
|
+
end
|
|
666
|
+
|
|
504
667
|
# Creates a new calculated attribute definition. After creation, new
|
|
505
668
|
# object data ingested into Customer Profiles will be included in the
|
|
506
669
|
# calculated attribute, which can be retrieved for a profile using the
|
|
@@ -533,6 +696,10 @@ module Aws::CustomerProfiles
|
|
|
533
696
|
# The conditions including range, object count, and threshold for the
|
|
534
697
|
# calculated attribute.
|
|
535
698
|
#
|
|
699
|
+
# @option params [Types::Filter] :filter
|
|
700
|
+
# Defines how to filter incoming objects to include part of the
|
|
701
|
+
# Calculated Attribute.
|
|
702
|
+
#
|
|
536
703
|
# @option params [required, String] :statistic
|
|
537
704
|
# The aggregation operation to perform for the calculated attribute.
|
|
538
705
|
#
|
|
@@ -546,6 +713,7 @@ module Aws::CustomerProfiles
|
|
|
546
713
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#description #description} => String
|
|
547
714
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
|
548
715
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
|
716
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#filter #data.filter} => Types::Filter (This method conflicts with a method on Response, call it through the data member)
|
|
549
717
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
|
550
718
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
|
551
719
|
# * {Types::CreateCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
|
@@ -577,6 +745,24 @@ module Aws::CustomerProfiles
|
|
|
577
745
|
# operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
|
|
578
746
|
# },
|
|
579
747
|
# },
|
|
748
|
+
# filter: {
|
|
749
|
+
# include: "ALL", # required, accepts ALL, ANY, NONE
|
|
750
|
+
# groups: [ # required
|
|
751
|
+
# {
|
|
752
|
+
# type: "ALL", # required, accepts ALL, ANY, NONE
|
|
753
|
+
# dimensions: [ # required
|
|
754
|
+
# {
|
|
755
|
+
# attributes: { # required
|
|
756
|
+
# "attributeName" => {
|
|
757
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL
|
|
758
|
+
# values: ["string1To255"], # required
|
|
759
|
+
# },
|
|
760
|
+
# },
|
|
761
|
+
# },
|
|
762
|
+
# ],
|
|
763
|
+
# },
|
|
764
|
+
# ],
|
|
765
|
+
# },
|
|
580
766
|
# statistic: "FIRST_OCCURRENCE", # required, accepts FIRST_OCCURRENCE, LAST_OCCURRENCE, COUNT, SUM, MINIMUM, MAXIMUM, AVERAGE, MAX_OCCURRENCE
|
|
581
767
|
# tags: {
|
|
582
768
|
# "TagKey" => "TagValue",
|
|
@@ -596,6 +782,14 @@ module Aws::CustomerProfiles
|
|
|
596
782
|
# resp.conditions.object_count #=> Integer
|
|
597
783
|
# resp.conditions.threshold.value #=> String
|
|
598
784
|
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
|
785
|
+
# resp.data.filter.include #=> String, one of "ALL", "ANY", "NONE"
|
|
786
|
+
# resp.data.filter.groups #=> Array
|
|
787
|
+
# resp.data.filter.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
|
|
788
|
+
# resp.data.filter.groups[0].dimensions #=> Array
|
|
789
|
+
# resp.data.filter.groups[0].dimensions[0].attributes #=> Hash
|
|
790
|
+
# resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL"
|
|
791
|
+
# resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values #=> Array
|
|
792
|
+
# resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values[0] #=> String
|
|
599
793
|
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
|
600
794
|
# resp.created_at #=> Time
|
|
601
795
|
# resp.last_updated_at #=> Time
|
|
@@ -1170,6 +1364,569 @@ module Aws::CustomerProfiles
|
|
|
1170
1364
|
req.send_request(options)
|
|
1171
1365
|
end
|
|
1172
1366
|
|
|
1367
|
+
# Creates a segment definition associated to the given domain.
|
|
1368
|
+
#
|
|
1369
|
+
# @option params [required, String] :domain_name
|
|
1370
|
+
# The unique name of the domain.
|
|
1371
|
+
#
|
|
1372
|
+
# @option params [required, String] :segment_definition_name
|
|
1373
|
+
# The unique name of the segment definition.
|
|
1374
|
+
#
|
|
1375
|
+
# @option params [required, String] :display_name
|
|
1376
|
+
# The display name of the segment definition.
|
|
1377
|
+
#
|
|
1378
|
+
# @option params [String] :description
|
|
1379
|
+
# The description of the segment definition.
|
|
1380
|
+
#
|
|
1381
|
+
# @option params [required, Types::SegmentGroup] :segment_groups
|
|
1382
|
+
# Specifies the base segments and dimensions for a segment definition
|
|
1383
|
+
# along with their respective relationship.
|
|
1384
|
+
#
|
|
1385
|
+
# @option params [Hash<String,String>] :tags
|
|
1386
|
+
# The tags used to organize, track, or control access for this resource.
|
|
1387
|
+
#
|
|
1388
|
+
# @return [Types::CreateSegmentDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1389
|
+
#
|
|
1390
|
+
# * {Types::CreateSegmentDefinitionResponse#segment_definition_name #segment_definition_name} => String
|
|
1391
|
+
# * {Types::CreateSegmentDefinitionResponse#display_name #display_name} => String
|
|
1392
|
+
# * {Types::CreateSegmentDefinitionResponse#description #description} => String
|
|
1393
|
+
# * {Types::CreateSegmentDefinitionResponse#created_at #created_at} => Time
|
|
1394
|
+
# * {Types::CreateSegmentDefinitionResponse#segment_definition_arn #segment_definition_arn} => String
|
|
1395
|
+
# * {Types::CreateSegmentDefinitionResponse#tags #tags} => Hash<String,String>
|
|
1396
|
+
#
|
|
1397
|
+
# @example Request syntax with placeholder values
|
|
1398
|
+
#
|
|
1399
|
+
# resp = client.create_segment_definition({
|
|
1400
|
+
# domain_name: "name", # required
|
|
1401
|
+
# segment_definition_name: "name", # required
|
|
1402
|
+
# display_name: "string1To255", # required
|
|
1403
|
+
# description: "sensitiveText",
|
|
1404
|
+
# segment_groups: { # required
|
|
1405
|
+
# groups: [
|
|
1406
|
+
# {
|
|
1407
|
+
# dimensions: [
|
|
1408
|
+
# {
|
|
1409
|
+
# profile_attributes: {
|
|
1410
|
+
# account_number: {
|
|
1411
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1412
|
+
# values: ["string1To255"], # required
|
|
1413
|
+
# },
|
|
1414
|
+
# additional_information: {
|
|
1415
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1416
|
+
# values: ["string1To1000"], # required
|
|
1417
|
+
# },
|
|
1418
|
+
# first_name: {
|
|
1419
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1420
|
+
# values: ["string1To255"], # required
|
|
1421
|
+
# },
|
|
1422
|
+
# last_name: {
|
|
1423
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1424
|
+
# values: ["string1To255"], # required
|
|
1425
|
+
# },
|
|
1426
|
+
# middle_name: {
|
|
1427
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1428
|
+
# values: ["string1To255"], # required
|
|
1429
|
+
# },
|
|
1430
|
+
# gender_string: {
|
|
1431
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1432
|
+
# values: ["string1To255"], # required
|
|
1433
|
+
# },
|
|
1434
|
+
# party_type_string: {
|
|
1435
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1436
|
+
# values: ["string1To255"], # required
|
|
1437
|
+
# },
|
|
1438
|
+
# birth_date: {
|
|
1439
|
+
# dimension_type: "BEFORE", # required, accepts BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON
|
|
1440
|
+
# values: ["String"], # required
|
|
1441
|
+
# },
|
|
1442
|
+
# phone_number: {
|
|
1443
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1444
|
+
# values: ["string1To255"], # required
|
|
1445
|
+
# },
|
|
1446
|
+
# business_name: {
|
|
1447
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1448
|
+
# values: ["string1To255"], # required
|
|
1449
|
+
# },
|
|
1450
|
+
# business_phone_number: {
|
|
1451
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1452
|
+
# values: ["string1To255"], # required
|
|
1453
|
+
# },
|
|
1454
|
+
# home_phone_number: {
|
|
1455
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1456
|
+
# values: ["string1To255"], # required
|
|
1457
|
+
# },
|
|
1458
|
+
# mobile_phone_number: {
|
|
1459
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1460
|
+
# values: ["string1To255"], # required
|
|
1461
|
+
# },
|
|
1462
|
+
# email_address: {
|
|
1463
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1464
|
+
# values: ["string1To255"], # required
|
|
1465
|
+
# },
|
|
1466
|
+
# personal_email_address: {
|
|
1467
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1468
|
+
# values: ["string1To255"], # required
|
|
1469
|
+
# },
|
|
1470
|
+
# business_email_address: {
|
|
1471
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1472
|
+
# values: ["string1To255"], # required
|
|
1473
|
+
# },
|
|
1474
|
+
# address: {
|
|
1475
|
+
# city: {
|
|
1476
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1477
|
+
# values: ["string1To255"], # required
|
|
1478
|
+
# },
|
|
1479
|
+
# country: {
|
|
1480
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1481
|
+
# values: ["string1To255"], # required
|
|
1482
|
+
# },
|
|
1483
|
+
# county: {
|
|
1484
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1485
|
+
# values: ["string1To255"], # required
|
|
1486
|
+
# },
|
|
1487
|
+
# postal_code: {
|
|
1488
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1489
|
+
# values: ["string1To255"], # required
|
|
1490
|
+
# },
|
|
1491
|
+
# province: {
|
|
1492
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1493
|
+
# values: ["string1To255"], # required
|
|
1494
|
+
# },
|
|
1495
|
+
# state: {
|
|
1496
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1497
|
+
# values: ["string1To255"], # required
|
|
1498
|
+
# },
|
|
1499
|
+
# },
|
|
1500
|
+
# shipping_address: {
|
|
1501
|
+
# city: {
|
|
1502
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1503
|
+
# values: ["string1To255"], # required
|
|
1504
|
+
# },
|
|
1505
|
+
# country: {
|
|
1506
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1507
|
+
# values: ["string1To255"], # required
|
|
1508
|
+
# },
|
|
1509
|
+
# county: {
|
|
1510
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1511
|
+
# values: ["string1To255"], # required
|
|
1512
|
+
# },
|
|
1513
|
+
# postal_code: {
|
|
1514
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1515
|
+
# values: ["string1To255"], # required
|
|
1516
|
+
# },
|
|
1517
|
+
# province: {
|
|
1518
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1519
|
+
# values: ["string1To255"], # required
|
|
1520
|
+
# },
|
|
1521
|
+
# state: {
|
|
1522
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1523
|
+
# values: ["string1To255"], # required
|
|
1524
|
+
# },
|
|
1525
|
+
# },
|
|
1526
|
+
# mailing_address: {
|
|
1527
|
+
# city: {
|
|
1528
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1529
|
+
# values: ["string1To255"], # required
|
|
1530
|
+
# },
|
|
1531
|
+
# country: {
|
|
1532
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1533
|
+
# values: ["string1To255"], # required
|
|
1534
|
+
# },
|
|
1535
|
+
# county: {
|
|
1536
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1537
|
+
# values: ["string1To255"], # required
|
|
1538
|
+
# },
|
|
1539
|
+
# postal_code: {
|
|
1540
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1541
|
+
# values: ["string1To255"], # required
|
|
1542
|
+
# },
|
|
1543
|
+
# province: {
|
|
1544
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1545
|
+
# values: ["string1To255"], # required
|
|
1546
|
+
# },
|
|
1547
|
+
# state: {
|
|
1548
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1549
|
+
# values: ["string1To255"], # required
|
|
1550
|
+
# },
|
|
1551
|
+
# },
|
|
1552
|
+
# billing_address: {
|
|
1553
|
+
# city: {
|
|
1554
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1555
|
+
# values: ["string1To255"], # required
|
|
1556
|
+
# },
|
|
1557
|
+
# country: {
|
|
1558
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1559
|
+
# values: ["string1To255"], # required
|
|
1560
|
+
# },
|
|
1561
|
+
# county: {
|
|
1562
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1563
|
+
# values: ["string1To255"], # required
|
|
1564
|
+
# },
|
|
1565
|
+
# postal_code: {
|
|
1566
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1567
|
+
# values: ["string1To255"], # required
|
|
1568
|
+
# },
|
|
1569
|
+
# province: {
|
|
1570
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1571
|
+
# values: ["string1To255"], # required
|
|
1572
|
+
# },
|
|
1573
|
+
# state: {
|
|
1574
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1575
|
+
# values: ["string1To255"], # required
|
|
1576
|
+
# },
|
|
1577
|
+
# },
|
|
1578
|
+
# attributes: {
|
|
1579
|
+
# "typeName" => {
|
|
1580
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL
|
|
1581
|
+
# values: ["string1To255"], # required
|
|
1582
|
+
# },
|
|
1583
|
+
# },
|
|
1584
|
+
# },
|
|
1585
|
+
# calculated_attributes: {
|
|
1586
|
+
# "typeName" => {
|
|
1587
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL
|
|
1588
|
+
# values: ["string1To255"], # required
|
|
1589
|
+
# condition_overrides: {
|
|
1590
|
+
# range: {
|
|
1591
|
+
# start: 1, # required
|
|
1592
|
+
# end: 1,
|
|
1593
|
+
# unit: "DAYS", # required, accepts DAYS
|
|
1594
|
+
# },
|
|
1595
|
+
# },
|
|
1596
|
+
# },
|
|
1597
|
+
# },
|
|
1598
|
+
# },
|
|
1599
|
+
# ],
|
|
1600
|
+
# source_segments: [
|
|
1601
|
+
# {
|
|
1602
|
+
# segment_definition_name: "name",
|
|
1603
|
+
# },
|
|
1604
|
+
# ],
|
|
1605
|
+
# source_type: "ALL", # accepts ALL, ANY, NONE
|
|
1606
|
+
# type: "ALL", # accepts ALL, ANY, NONE
|
|
1607
|
+
# },
|
|
1608
|
+
# ],
|
|
1609
|
+
# include: "ALL", # accepts ALL, ANY, NONE
|
|
1610
|
+
# },
|
|
1611
|
+
# tags: {
|
|
1612
|
+
# "TagKey" => "TagValue",
|
|
1613
|
+
# },
|
|
1614
|
+
# })
|
|
1615
|
+
#
|
|
1616
|
+
# @example Response structure
|
|
1617
|
+
#
|
|
1618
|
+
# resp.segment_definition_name #=> String
|
|
1619
|
+
# resp.display_name #=> String
|
|
1620
|
+
# resp.description #=> String
|
|
1621
|
+
# resp.created_at #=> Time
|
|
1622
|
+
# resp.segment_definition_arn #=> String
|
|
1623
|
+
# resp.tags #=> Hash
|
|
1624
|
+
# resp.tags["TagKey"] #=> String
|
|
1625
|
+
#
|
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentDefinition AWS API Documentation
|
|
1627
|
+
#
|
|
1628
|
+
# @overload create_segment_definition(params = {})
|
|
1629
|
+
# @param [Hash] params ({})
|
|
1630
|
+
def create_segment_definition(params = {}, options = {})
|
|
1631
|
+
req = build_request(:create_segment_definition, params)
|
|
1632
|
+
req.send_request(options)
|
|
1633
|
+
end
|
|
1634
|
+
|
|
1635
|
+
# Creates a segment estimate query.
|
|
1636
|
+
#
|
|
1637
|
+
# @option params [required, String] :domain_name
|
|
1638
|
+
# The unique name of the domain.
|
|
1639
|
+
#
|
|
1640
|
+
# @option params [required, Types::SegmentGroupStructure] :segment_query
|
|
1641
|
+
# The segment query for calculating a segment estimate.
|
|
1642
|
+
#
|
|
1643
|
+
# @return [Types::CreateSegmentEstimateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1644
|
+
#
|
|
1645
|
+
# * {Types::CreateSegmentEstimateResponse#domain_name #domain_name} => String
|
|
1646
|
+
# * {Types::CreateSegmentEstimateResponse#estimate_id #estimate_id} => String
|
|
1647
|
+
# * {Types::CreateSegmentEstimateResponse#status_code #status_code} => Integer
|
|
1648
|
+
#
|
|
1649
|
+
# @example Request syntax with placeholder values
|
|
1650
|
+
#
|
|
1651
|
+
# resp = client.create_segment_estimate({
|
|
1652
|
+
# domain_name: "name", # required
|
|
1653
|
+
# segment_query: { # required
|
|
1654
|
+
# groups: [
|
|
1655
|
+
# {
|
|
1656
|
+
# dimensions: [
|
|
1657
|
+
# {
|
|
1658
|
+
# profile_attributes: {
|
|
1659
|
+
# account_number: {
|
|
1660
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1661
|
+
# values: ["string1To255"], # required
|
|
1662
|
+
# },
|
|
1663
|
+
# additional_information: {
|
|
1664
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1665
|
+
# values: ["string1To1000"], # required
|
|
1666
|
+
# },
|
|
1667
|
+
# first_name: {
|
|
1668
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1669
|
+
# values: ["string1To255"], # required
|
|
1670
|
+
# },
|
|
1671
|
+
# last_name: {
|
|
1672
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1673
|
+
# values: ["string1To255"], # required
|
|
1674
|
+
# },
|
|
1675
|
+
# middle_name: {
|
|
1676
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1677
|
+
# values: ["string1To255"], # required
|
|
1678
|
+
# },
|
|
1679
|
+
# gender_string: {
|
|
1680
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1681
|
+
# values: ["string1To255"], # required
|
|
1682
|
+
# },
|
|
1683
|
+
# party_type_string: {
|
|
1684
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1685
|
+
# values: ["string1To255"], # required
|
|
1686
|
+
# },
|
|
1687
|
+
# birth_date: {
|
|
1688
|
+
# dimension_type: "BEFORE", # required, accepts BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON
|
|
1689
|
+
# values: ["String"], # required
|
|
1690
|
+
# },
|
|
1691
|
+
# phone_number: {
|
|
1692
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1693
|
+
# values: ["string1To255"], # required
|
|
1694
|
+
# },
|
|
1695
|
+
# business_name: {
|
|
1696
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1697
|
+
# values: ["string1To255"], # required
|
|
1698
|
+
# },
|
|
1699
|
+
# business_phone_number: {
|
|
1700
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1701
|
+
# values: ["string1To255"], # required
|
|
1702
|
+
# },
|
|
1703
|
+
# home_phone_number: {
|
|
1704
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1705
|
+
# values: ["string1To255"], # required
|
|
1706
|
+
# },
|
|
1707
|
+
# mobile_phone_number: {
|
|
1708
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1709
|
+
# values: ["string1To255"], # required
|
|
1710
|
+
# },
|
|
1711
|
+
# email_address: {
|
|
1712
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1713
|
+
# values: ["string1To255"], # required
|
|
1714
|
+
# },
|
|
1715
|
+
# personal_email_address: {
|
|
1716
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1717
|
+
# values: ["string1To255"], # required
|
|
1718
|
+
# },
|
|
1719
|
+
# business_email_address: {
|
|
1720
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1721
|
+
# values: ["string1To255"], # required
|
|
1722
|
+
# },
|
|
1723
|
+
# address: {
|
|
1724
|
+
# city: {
|
|
1725
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1726
|
+
# values: ["string1To255"], # required
|
|
1727
|
+
# },
|
|
1728
|
+
# country: {
|
|
1729
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1730
|
+
# values: ["string1To255"], # required
|
|
1731
|
+
# },
|
|
1732
|
+
# county: {
|
|
1733
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1734
|
+
# values: ["string1To255"], # required
|
|
1735
|
+
# },
|
|
1736
|
+
# postal_code: {
|
|
1737
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1738
|
+
# values: ["string1To255"], # required
|
|
1739
|
+
# },
|
|
1740
|
+
# province: {
|
|
1741
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1742
|
+
# values: ["string1To255"], # required
|
|
1743
|
+
# },
|
|
1744
|
+
# state: {
|
|
1745
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1746
|
+
# values: ["string1To255"], # required
|
|
1747
|
+
# },
|
|
1748
|
+
# },
|
|
1749
|
+
# shipping_address: {
|
|
1750
|
+
# city: {
|
|
1751
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1752
|
+
# values: ["string1To255"], # required
|
|
1753
|
+
# },
|
|
1754
|
+
# country: {
|
|
1755
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1756
|
+
# values: ["string1To255"], # required
|
|
1757
|
+
# },
|
|
1758
|
+
# county: {
|
|
1759
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1760
|
+
# values: ["string1To255"], # required
|
|
1761
|
+
# },
|
|
1762
|
+
# postal_code: {
|
|
1763
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1764
|
+
# values: ["string1To255"], # required
|
|
1765
|
+
# },
|
|
1766
|
+
# province: {
|
|
1767
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1768
|
+
# values: ["string1To255"], # required
|
|
1769
|
+
# },
|
|
1770
|
+
# state: {
|
|
1771
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1772
|
+
# values: ["string1To255"], # required
|
|
1773
|
+
# },
|
|
1774
|
+
# },
|
|
1775
|
+
# mailing_address: {
|
|
1776
|
+
# city: {
|
|
1777
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1778
|
+
# values: ["string1To255"], # required
|
|
1779
|
+
# },
|
|
1780
|
+
# country: {
|
|
1781
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1782
|
+
# values: ["string1To255"], # required
|
|
1783
|
+
# },
|
|
1784
|
+
# county: {
|
|
1785
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1786
|
+
# values: ["string1To255"], # required
|
|
1787
|
+
# },
|
|
1788
|
+
# postal_code: {
|
|
1789
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1790
|
+
# values: ["string1To255"], # required
|
|
1791
|
+
# },
|
|
1792
|
+
# province: {
|
|
1793
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1794
|
+
# values: ["string1To255"], # required
|
|
1795
|
+
# },
|
|
1796
|
+
# state: {
|
|
1797
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1798
|
+
# values: ["string1To255"], # required
|
|
1799
|
+
# },
|
|
1800
|
+
# },
|
|
1801
|
+
# billing_address: {
|
|
1802
|
+
# city: {
|
|
1803
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1804
|
+
# values: ["string1To255"], # required
|
|
1805
|
+
# },
|
|
1806
|
+
# country: {
|
|
1807
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1808
|
+
# values: ["string1To255"], # required
|
|
1809
|
+
# },
|
|
1810
|
+
# county: {
|
|
1811
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1812
|
+
# values: ["string1To255"], # required
|
|
1813
|
+
# },
|
|
1814
|
+
# postal_code: {
|
|
1815
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1816
|
+
# values: ["string1To255"], # required
|
|
1817
|
+
# },
|
|
1818
|
+
# province: {
|
|
1819
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1820
|
+
# values: ["string1To255"], # required
|
|
1821
|
+
# },
|
|
1822
|
+
# state: {
|
|
1823
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
|
|
1824
|
+
# values: ["string1To255"], # required
|
|
1825
|
+
# },
|
|
1826
|
+
# },
|
|
1827
|
+
# attributes: {
|
|
1828
|
+
# "typeName" => {
|
|
1829
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL
|
|
1830
|
+
# values: ["string1To255"], # required
|
|
1831
|
+
# },
|
|
1832
|
+
# },
|
|
1833
|
+
# },
|
|
1834
|
+
# calculated_attributes: {
|
|
1835
|
+
# "typeName" => {
|
|
1836
|
+
# dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL
|
|
1837
|
+
# values: ["string1To255"], # required
|
|
1838
|
+
# condition_overrides: {
|
|
1839
|
+
# range: {
|
|
1840
|
+
# start: 1, # required
|
|
1841
|
+
# end: 1,
|
|
1842
|
+
# unit: "DAYS", # required, accepts DAYS
|
|
1843
|
+
# },
|
|
1844
|
+
# },
|
|
1845
|
+
# },
|
|
1846
|
+
# },
|
|
1847
|
+
# },
|
|
1848
|
+
# ],
|
|
1849
|
+
# source_segments: [
|
|
1850
|
+
# {
|
|
1851
|
+
# segment_definition_name: "name",
|
|
1852
|
+
# },
|
|
1853
|
+
# ],
|
|
1854
|
+
# source_type: "ALL", # accepts ALL, ANY, NONE
|
|
1855
|
+
# type: "ALL", # accepts ALL, ANY, NONE
|
|
1856
|
+
# },
|
|
1857
|
+
# ],
|
|
1858
|
+
# include: "ALL", # accepts ALL, ANY, NONE
|
|
1859
|
+
# },
|
|
1860
|
+
# })
|
|
1861
|
+
#
|
|
1862
|
+
# @example Response structure
|
|
1863
|
+
#
|
|
1864
|
+
# resp.domain_name #=> String
|
|
1865
|
+
# resp.estimate_id #=> String
|
|
1866
|
+
# resp.status_code #=> Integer
|
|
1867
|
+
#
|
|
1868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentEstimate AWS API Documentation
|
|
1869
|
+
#
|
|
1870
|
+
# @overload create_segment_estimate(params = {})
|
|
1871
|
+
# @param [Hash] params ({})
|
|
1872
|
+
def create_segment_estimate(params = {}, options = {})
|
|
1873
|
+
req = build_request(:create_segment_estimate, params)
|
|
1874
|
+
req.send_request(options)
|
|
1875
|
+
end
|
|
1876
|
+
|
|
1877
|
+
# Triggers a job to export a segment to a specified destination.
|
|
1878
|
+
#
|
|
1879
|
+
# @option params [required, String] :domain_name
|
|
1880
|
+
# The unique name of the domain.
|
|
1881
|
+
#
|
|
1882
|
+
# @option params [required, String] :segment_definition_name
|
|
1883
|
+
# The name of the segment definition used in this snapshot request.
|
|
1884
|
+
#
|
|
1885
|
+
# @option params [required, String] :data_format
|
|
1886
|
+
# The format in which the segment will be exported.
|
|
1887
|
+
#
|
|
1888
|
+
# @option params [String] :encryption_key
|
|
1889
|
+
# The Amazon Resource Name (ARN) of the KMS key used to encrypt the
|
|
1890
|
+
# exported segment.
|
|
1891
|
+
#
|
|
1892
|
+
# @option params [String] :role_arn
|
|
1893
|
+
# The Amazon Resource Name (ARN) of the IAM role that allows Customer
|
|
1894
|
+
# Profiles service principal to assume the role for conducting KMS and
|
|
1895
|
+
# S3 operations.
|
|
1896
|
+
#
|
|
1897
|
+
# @option params [String] :destination_uri
|
|
1898
|
+
# The destination to which the segment will be exported. This field must
|
|
1899
|
+
# be provided if the request is not submitted from the Amazon Connect
|
|
1900
|
+
# Admin Website.
|
|
1901
|
+
#
|
|
1902
|
+
# @return [Types::CreateSegmentSnapshotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1903
|
+
#
|
|
1904
|
+
# * {Types::CreateSegmentSnapshotResponse#snapshot_id #snapshot_id} => String
|
|
1905
|
+
#
|
|
1906
|
+
# @example Request syntax with placeholder values
|
|
1907
|
+
#
|
|
1908
|
+
# resp = client.create_segment_snapshot({
|
|
1909
|
+
# domain_name: "name", # required
|
|
1910
|
+
# segment_definition_name: "name", # required
|
|
1911
|
+
# data_format: "CSV", # required, accepts CSV, JSONL, ORC
|
|
1912
|
+
# encryption_key: "encryptionKey",
|
|
1913
|
+
# role_arn: "RoleArn",
|
|
1914
|
+
# destination_uri: "string1To255",
|
|
1915
|
+
# })
|
|
1916
|
+
#
|
|
1917
|
+
# @example Response structure
|
|
1918
|
+
#
|
|
1919
|
+
# resp.snapshot_id #=> String
|
|
1920
|
+
#
|
|
1921
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentSnapshot AWS API Documentation
|
|
1922
|
+
#
|
|
1923
|
+
# @overload create_segment_snapshot(params = {})
|
|
1924
|
+
# @param [Hash] params ({})
|
|
1925
|
+
def create_segment_snapshot(params = {}, options = {})
|
|
1926
|
+
req = build_request(:create_segment_snapshot, params)
|
|
1927
|
+
req.send_request(options)
|
|
1928
|
+
end
|
|
1929
|
+
|
|
1173
1930
|
# Deletes an existing calculated attribute definition. Note that
|
|
1174
1931
|
# deleting a default calculated attribute is possible, however once
|
|
1175
1932
|
# deleted, you will be unable to undo that action and will need to
|
|
@@ -1437,6 +2194,38 @@ module Aws::CustomerProfiles
|
|
|
1437
2194
|
req.send_request(options)
|
|
1438
2195
|
end
|
|
1439
2196
|
|
|
2197
|
+
# Deletes a segment definition from the domain.
|
|
2198
|
+
#
|
|
2199
|
+
# @option params [required, String] :domain_name
|
|
2200
|
+
# The unique name of the domain.
|
|
2201
|
+
#
|
|
2202
|
+
# @option params [required, String] :segment_definition_name
|
|
2203
|
+
# The unique name of the segment definition.
|
|
2204
|
+
#
|
|
2205
|
+
# @return [Types::DeleteSegmentDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2206
|
+
#
|
|
2207
|
+
# * {Types::DeleteSegmentDefinitionResponse#message #message} => String
|
|
2208
|
+
#
|
|
2209
|
+
# @example Request syntax with placeholder values
|
|
2210
|
+
#
|
|
2211
|
+
# resp = client.delete_segment_definition({
|
|
2212
|
+
# domain_name: "name", # required
|
|
2213
|
+
# segment_definition_name: "name", # required
|
|
2214
|
+
# })
|
|
2215
|
+
#
|
|
2216
|
+
# @example Response structure
|
|
2217
|
+
#
|
|
2218
|
+
# resp.message #=> String
|
|
2219
|
+
#
|
|
2220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteSegmentDefinition AWS API Documentation
|
|
2221
|
+
#
|
|
2222
|
+
# @overload delete_segment_definition(params = {})
|
|
2223
|
+
# @param [Hash] params ({})
|
|
2224
|
+
def delete_segment_definition(params = {}, options = {})
|
|
2225
|
+
req = build_request(:delete_segment_definition, params)
|
|
2226
|
+
req.send_request(options)
|
|
2227
|
+
end
|
|
2228
|
+
|
|
1440
2229
|
# Deletes the specified workflow and all its corresponding resources.
|
|
1441
2230
|
# This is an async process.
|
|
1442
2231
|
#
|
|
@@ -1495,7 +2284,7 @@ module Aws::CustomerProfiles
|
|
|
1495
2284
|
# resp.detected_profile_object_types[0].keys #=> Hash
|
|
1496
2285
|
# resp.detected_profile_object_types[0].keys["name"] #=> Array
|
|
1497
2286
|
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers #=> Array
|
|
1498
|
-
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
2287
|
+
# resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
1499
2288
|
# resp.detected_profile_object_types[0].keys["name"][0].field_names #=> Array
|
|
1500
2289
|
# resp.detected_profile_object_types[0].keys["name"][0].field_names[0] #=> String
|
|
1501
2290
|
#
|
|
@@ -1595,6 +2384,7 @@ module Aws::CustomerProfiles
|
|
|
1595
2384
|
# * {Types::GetCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
|
1596
2385
|
# * {Types::GetCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
|
1597
2386
|
# * {Types::GetCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
|
2387
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#filter #data.filter} => Types::Filter (This method conflicts with a method on Response, call it through the data member)
|
|
1598
2388
|
# * {Types::GetCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
|
1599
2389
|
# * {Types::GetCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
|
1600
2390
|
# * {Types::GetCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
|
@@ -1614,6 +2404,14 @@ module Aws::CustomerProfiles
|
|
|
1614
2404
|
# resp.created_at #=> Time
|
|
1615
2405
|
# resp.last_updated_at #=> Time
|
|
1616
2406
|
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
|
2407
|
+
# resp.data.filter.include #=> String, one of "ALL", "ANY", "NONE"
|
|
2408
|
+
# resp.data.filter.groups #=> Array
|
|
2409
|
+
# resp.data.filter.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
|
|
2410
|
+
# resp.data.filter.groups[0].dimensions #=> Array
|
|
2411
|
+
# resp.data.filter.groups[0].dimensions[0].attributes #=> Hash
|
|
2412
|
+
# resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL"
|
|
2413
|
+
# resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values #=> Array
|
|
2414
|
+
# resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values[0] #=> String
|
|
1617
2415
|
# resp.conditions.range.value #=> Integer
|
|
1618
2416
|
# resp.conditions.range.unit #=> String, one of "DAYS"
|
|
1619
2417
|
# resp.conditions.object_count #=> Integer
|
|
@@ -2070,7 +2868,7 @@ module Aws::CustomerProfiles
|
|
|
2070
2868
|
# resp.keys #=> Hash
|
|
2071
2869
|
# resp.keys["name"] #=> Array
|
|
2072
2870
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
|
2073
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
2871
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
2074
2872
|
# resp.keys["name"][0].field_names #=> Array
|
|
2075
2873
|
# resp.keys["name"][0].field_names[0] #=> String
|
|
2076
2874
|
# resp.created_at #=> Time
|
|
@@ -2128,7 +2926,7 @@ module Aws::CustomerProfiles
|
|
|
2128
2926
|
# resp.keys #=> Hash
|
|
2129
2927
|
# resp.keys["name"] #=> Array
|
|
2130
2928
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
|
2131
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
2929
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
2132
2930
|
# resp.keys["name"][0].field_names #=> Array
|
|
2133
2931
|
# resp.keys["name"][0].field_names[0] #=> String
|
|
2134
2932
|
#
|
|
@@ -2141,6 +2939,389 @@ module Aws::CustomerProfiles
|
|
|
2141
2939
|
req.send_request(options)
|
|
2142
2940
|
end
|
|
2143
2941
|
|
|
2942
|
+
# Gets a segment definition from the domain.
|
|
2943
|
+
#
|
|
2944
|
+
# @option params [required, String] :domain_name
|
|
2945
|
+
# The unique name of the domain.
|
|
2946
|
+
#
|
|
2947
|
+
# @option params [required, String] :segment_definition_name
|
|
2948
|
+
# The unique name of the segment definition.
|
|
2949
|
+
#
|
|
2950
|
+
# @return [Types::GetSegmentDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2951
|
+
#
|
|
2952
|
+
# * {Types::GetSegmentDefinitionResponse#segment_definition_name #segment_definition_name} => String
|
|
2953
|
+
# * {Types::GetSegmentDefinitionResponse#display_name #display_name} => String
|
|
2954
|
+
# * {Types::GetSegmentDefinitionResponse#description #description} => String
|
|
2955
|
+
# * {Types::GetSegmentDefinitionResponse#segment_groups #segment_groups} => Types::SegmentGroup
|
|
2956
|
+
# * {Types::GetSegmentDefinitionResponse#segment_definition_arn #segment_definition_arn} => String
|
|
2957
|
+
# * {Types::GetSegmentDefinitionResponse#created_at #created_at} => Time
|
|
2958
|
+
# * {Types::GetSegmentDefinitionResponse#tags #tags} => Hash<String,String>
|
|
2959
|
+
#
|
|
2960
|
+
# @example Request syntax with placeholder values
|
|
2961
|
+
#
|
|
2962
|
+
# resp = client.get_segment_definition({
|
|
2963
|
+
# domain_name: "name", # required
|
|
2964
|
+
# segment_definition_name: "name", # required
|
|
2965
|
+
# })
|
|
2966
|
+
#
|
|
2967
|
+
# @example Response structure
|
|
2968
|
+
#
|
|
2969
|
+
# resp.segment_definition_name #=> String
|
|
2970
|
+
# resp.display_name #=> String
|
|
2971
|
+
# resp.description #=> String
|
|
2972
|
+
# resp.segment_groups.groups #=> Array
|
|
2973
|
+
# resp.segment_groups.groups[0].dimensions #=> Array
|
|
2974
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.account_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
2975
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.account_number.values #=> Array
|
|
2976
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.account_number.values[0] #=> String
|
|
2977
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.additional_information.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
2978
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.additional_information.values #=> Array
|
|
2979
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.additional_information.values[0] #=> String
|
|
2980
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.first_name.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
2981
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.first_name.values #=> Array
|
|
2982
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.first_name.values[0] #=> String
|
|
2983
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.last_name.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
2984
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.last_name.values #=> Array
|
|
2985
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.last_name.values[0] #=> String
|
|
2986
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.middle_name.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
2987
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.middle_name.values #=> Array
|
|
2988
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.middle_name.values[0] #=> String
|
|
2989
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.gender_string.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
2990
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.gender_string.values #=> Array
|
|
2991
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.gender_string.values[0] #=> String
|
|
2992
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.party_type_string.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
2993
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.party_type_string.values #=> Array
|
|
2994
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.party_type_string.values[0] #=> String
|
|
2995
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.birth_date.dimension_type #=> String, one of "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON"
|
|
2996
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.birth_date.values #=> Array
|
|
2997
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.birth_date.values[0] #=> String
|
|
2998
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.phone_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
2999
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.phone_number.values #=> Array
|
|
3000
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.phone_number.values[0] #=> String
|
|
3001
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_name.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3002
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_name.values #=> Array
|
|
3003
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_name.values[0] #=> String
|
|
3004
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_phone_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3005
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_phone_number.values #=> Array
|
|
3006
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_phone_number.values[0] #=> String
|
|
3007
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.home_phone_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3008
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.home_phone_number.values #=> Array
|
|
3009
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.home_phone_number.values[0] #=> String
|
|
3010
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mobile_phone_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3011
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mobile_phone_number.values #=> Array
|
|
3012
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mobile_phone_number.values[0] #=> String
|
|
3013
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.email_address.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3014
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.email_address.values #=> Array
|
|
3015
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.email_address.values[0] #=> String
|
|
3016
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.personal_email_address.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3017
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.personal_email_address.values #=> Array
|
|
3018
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.personal_email_address.values[0] #=> String
|
|
3019
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_email_address.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3020
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_email_address.values #=> Array
|
|
3021
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_email_address.values[0] #=> String
|
|
3022
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.city.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3023
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.city.values #=> Array
|
|
3024
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.city.values[0] #=> String
|
|
3025
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3026
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.country.values #=> Array
|
|
3027
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.country.values[0] #=> String
|
|
3028
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.county.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3029
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.county.values #=> Array
|
|
3030
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.county.values[0] #=> String
|
|
3031
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.postal_code.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3032
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.postal_code.values #=> Array
|
|
3033
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.postal_code.values[0] #=> String
|
|
3034
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.province.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3035
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.province.values #=> Array
|
|
3036
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.province.values[0] #=> String
|
|
3037
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.state.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3038
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.state.values #=> Array
|
|
3039
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.state.values[0] #=> String
|
|
3040
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.city.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3041
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.city.values #=> Array
|
|
3042
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.city.values[0] #=> String
|
|
3043
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3044
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.country.values #=> Array
|
|
3045
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.country.values[0] #=> String
|
|
3046
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.county.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3047
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.county.values #=> Array
|
|
3048
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.county.values[0] #=> String
|
|
3049
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.postal_code.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3050
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.postal_code.values #=> Array
|
|
3051
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.postal_code.values[0] #=> String
|
|
3052
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.province.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3053
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.province.values #=> Array
|
|
3054
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.province.values[0] #=> String
|
|
3055
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.state.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3056
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.state.values #=> Array
|
|
3057
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.state.values[0] #=> String
|
|
3058
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.city.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3059
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.city.values #=> Array
|
|
3060
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.city.values[0] #=> String
|
|
3061
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3062
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.country.values #=> Array
|
|
3063
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.country.values[0] #=> String
|
|
3064
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.county.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3065
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.county.values #=> Array
|
|
3066
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.county.values[0] #=> String
|
|
3067
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.postal_code.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3068
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.postal_code.values #=> Array
|
|
3069
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.postal_code.values[0] #=> String
|
|
3070
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.province.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3071
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.province.values #=> Array
|
|
3072
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.province.values[0] #=> String
|
|
3073
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.state.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3074
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.state.values #=> Array
|
|
3075
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.state.values[0] #=> String
|
|
3076
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.city.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3077
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.city.values #=> Array
|
|
3078
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.city.values[0] #=> String
|
|
3079
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3080
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.country.values #=> Array
|
|
3081
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.country.values[0] #=> String
|
|
3082
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.county.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3083
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.county.values #=> Array
|
|
3084
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.county.values[0] #=> String
|
|
3085
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.postal_code.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3086
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.postal_code.values #=> Array
|
|
3087
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.postal_code.values[0] #=> String
|
|
3088
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.province.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3089
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.province.values #=> Array
|
|
3090
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.province.values[0] #=> String
|
|
3091
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.state.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
|
|
3092
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.state.values #=> Array
|
|
3093
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.state.values[0] #=> String
|
|
3094
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes #=> Hash
|
|
3095
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["typeName"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL"
|
|
3096
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["typeName"].values #=> Array
|
|
3097
|
+
# resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["typeName"].values[0] #=> String
|
|
3098
|
+
# resp.segment_groups.groups[0].dimensions[0].calculated_attributes #=> Hash
|
|
3099
|
+
# resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL"
|
|
3100
|
+
# resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].values #=> Array
|
|
3101
|
+
# resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].values[0] #=> String
|
|
3102
|
+
# resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].condition_overrides.range.start #=> Integer
|
|
3103
|
+
# resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].condition_overrides.range.end #=> Integer
|
|
3104
|
+
# resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].condition_overrides.range.unit #=> String, one of "DAYS"
|
|
3105
|
+
# resp.segment_groups.groups[0].source_segments #=> Array
|
|
3106
|
+
# resp.segment_groups.groups[0].source_segments[0].segment_definition_name #=> String
|
|
3107
|
+
# resp.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
|
|
3108
|
+
# resp.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
|
|
3109
|
+
# resp.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
|
|
3110
|
+
# resp.segment_definition_arn #=> String
|
|
3111
|
+
# resp.created_at #=> Time
|
|
3112
|
+
# resp.tags #=> Hash
|
|
3113
|
+
# resp.tags["TagKey"] #=> String
|
|
3114
|
+
#
|
|
3115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentDefinition AWS API Documentation
|
|
3116
|
+
#
|
|
3117
|
+
# @overload get_segment_definition(params = {})
|
|
3118
|
+
# @param [Hash] params ({})
|
|
3119
|
+
def get_segment_definition(params = {}, options = {})
|
|
3120
|
+
req = build_request(:get_segment_definition, params)
|
|
3121
|
+
req.send_request(options)
|
|
3122
|
+
end
|
|
3123
|
+
|
|
3124
|
+
# Gets the result of a segment estimate query.
|
|
3125
|
+
#
|
|
3126
|
+
# @option params [required, String] :domain_name
|
|
3127
|
+
# The unique name of the domain.
|
|
3128
|
+
#
|
|
3129
|
+
# @option params [required, String] :estimate_id
|
|
3130
|
+
# The query Id passed by a previous `CreateSegmentEstimate` operation.
|
|
3131
|
+
#
|
|
3132
|
+
# @return [Types::GetSegmentEstimateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3133
|
+
#
|
|
3134
|
+
# * {Types::GetSegmentEstimateResponse#domain_name #domain_name} => String
|
|
3135
|
+
# * {Types::GetSegmentEstimateResponse#estimate_id #estimate_id} => String
|
|
3136
|
+
# * {Types::GetSegmentEstimateResponse#status #status} => String
|
|
3137
|
+
# * {Types::GetSegmentEstimateResponse#estimate #estimate} => String
|
|
3138
|
+
# * {Types::GetSegmentEstimateResponse#message #message} => String
|
|
3139
|
+
# * {Types::GetSegmentEstimateResponse#status_code #status_code} => Integer
|
|
3140
|
+
#
|
|
3141
|
+
# @example Request syntax with placeholder values
|
|
3142
|
+
#
|
|
3143
|
+
# resp = client.get_segment_estimate({
|
|
3144
|
+
# domain_name: "name", # required
|
|
3145
|
+
# estimate_id: "string1To255", # required
|
|
3146
|
+
# })
|
|
3147
|
+
#
|
|
3148
|
+
# @example Response structure
|
|
3149
|
+
#
|
|
3150
|
+
# resp.domain_name #=> String
|
|
3151
|
+
# resp.estimate_id #=> String
|
|
3152
|
+
# resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED"
|
|
3153
|
+
# resp.estimate #=> String
|
|
3154
|
+
# resp.message #=> String
|
|
3155
|
+
# resp.status_code #=> Integer
|
|
3156
|
+
#
|
|
3157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentEstimate AWS API Documentation
|
|
3158
|
+
#
|
|
3159
|
+
# @overload get_segment_estimate(params = {})
|
|
3160
|
+
# @param [Hash] params ({})
|
|
3161
|
+
def get_segment_estimate(params = {}, options = {})
|
|
3162
|
+
req = build_request(:get_segment_estimate, params)
|
|
3163
|
+
req.send_request(options)
|
|
3164
|
+
end
|
|
3165
|
+
|
|
3166
|
+
# Determines if the given profiles are within a segment.
|
|
3167
|
+
#
|
|
3168
|
+
# @option params [required, String] :domain_name
|
|
3169
|
+
# The unique name of the domain.
|
|
3170
|
+
#
|
|
3171
|
+
# @option params [required, String] :segment_definition_name
|
|
3172
|
+
# The Id of the wanted segment. Needs to be a valid, and existing
|
|
3173
|
+
# segment Id.
|
|
3174
|
+
#
|
|
3175
|
+
# @option params [required, Array<String>] :profile_ids
|
|
3176
|
+
# The list of profile IDs to query for.
|
|
3177
|
+
#
|
|
3178
|
+
# @return [Types::GetSegmentMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3179
|
+
#
|
|
3180
|
+
# * {Types::GetSegmentMembershipResponse#segment_definition_name #segment_definition_name} => String
|
|
3181
|
+
# * {Types::GetSegmentMembershipResponse#profiles #profiles} => Array<Types::ProfileQueryResult>
|
|
3182
|
+
# * {Types::GetSegmentMembershipResponse#failures #failures} => Array<Types::ProfileQueryFailures>
|
|
3183
|
+
#
|
|
3184
|
+
# @example Request syntax with placeholder values
|
|
3185
|
+
#
|
|
3186
|
+
# resp = client.get_segment_membership({
|
|
3187
|
+
# domain_name: "name", # required
|
|
3188
|
+
# segment_definition_name: "name", # required
|
|
3189
|
+
# profile_ids: ["uuid"], # required
|
|
3190
|
+
# })
|
|
3191
|
+
#
|
|
3192
|
+
# @example Response structure
|
|
3193
|
+
#
|
|
3194
|
+
# resp.segment_definition_name #=> String
|
|
3195
|
+
# resp.profiles #=> Array
|
|
3196
|
+
# resp.profiles[0].profile_id #=> String
|
|
3197
|
+
# resp.profiles[0].query_result #=> String, one of "PRESENT", "ABSENT"
|
|
3198
|
+
# resp.profiles[0].profile.profile_id #=> String
|
|
3199
|
+
# resp.profiles[0].profile.account_number #=> String
|
|
3200
|
+
# resp.profiles[0].profile.additional_information #=> String
|
|
3201
|
+
# resp.profiles[0].profile.party_type #=> String, one of "INDIVIDUAL", "BUSINESS", "OTHER"
|
|
3202
|
+
# resp.profiles[0].profile.business_name #=> String
|
|
3203
|
+
# resp.profiles[0].profile.first_name #=> String
|
|
3204
|
+
# resp.profiles[0].profile.middle_name #=> String
|
|
3205
|
+
# resp.profiles[0].profile.last_name #=> String
|
|
3206
|
+
# resp.profiles[0].profile.birth_date #=> String
|
|
3207
|
+
# resp.profiles[0].profile.gender #=> String, one of "MALE", "FEMALE", "UNSPECIFIED"
|
|
3208
|
+
# resp.profiles[0].profile.phone_number #=> String
|
|
3209
|
+
# resp.profiles[0].profile.mobile_phone_number #=> String
|
|
3210
|
+
# resp.profiles[0].profile.home_phone_number #=> String
|
|
3211
|
+
# resp.profiles[0].profile.business_phone_number #=> String
|
|
3212
|
+
# resp.profiles[0].profile.email_address #=> String
|
|
3213
|
+
# resp.profiles[0].profile.personal_email_address #=> String
|
|
3214
|
+
# resp.profiles[0].profile.business_email_address #=> String
|
|
3215
|
+
# resp.profiles[0].profile.address.address_1 #=> String
|
|
3216
|
+
# resp.profiles[0].profile.address.address_2 #=> String
|
|
3217
|
+
# resp.profiles[0].profile.address.address_3 #=> String
|
|
3218
|
+
# resp.profiles[0].profile.address.address_4 #=> String
|
|
3219
|
+
# resp.profiles[0].profile.address.city #=> String
|
|
3220
|
+
# resp.profiles[0].profile.address.county #=> String
|
|
3221
|
+
# resp.profiles[0].profile.address.state #=> String
|
|
3222
|
+
# resp.profiles[0].profile.address.province #=> String
|
|
3223
|
+
# resp.profiles[0].profile.address.country #=> String
|
|
3224
|
+
# resp.profiles[0].profile.address.postal_code #=> String
|
|
3225
|
+
# resp.profiles[0].profile.shipping_address.address_1 #=> String
|
|
3226
|
+
# resp.profiles[0].profile.shipping_address.address_2 #=> String
|
|
3227
|
+
# resp.profiles[0].profile.shipping_address.address_3 #=> String
|
|
3228
|
+
# resp.profiles[0].profile.shipping_address.address_4 #=> String
|
|
3229
|
+
# resp.profiles[0].profile.shipping_address.city #=> String
|
|
3230
|
+
# resp.profiles[0].profile.shipping_address.county #=> String
|
|
3231
|
+
# resp.profiles[0].profile.shipping_address.state #=> String
|
|
3232
|
+
# resp.profiles[0].profile.shipping_address.province #=> String
|
|
3233
|
+
# resp.profiles[0].profile.shipping_address.country #=> String
|
|
3234
|
+
# resp.profiles[0].profile.shipping_address.postal_code #=> String
|
|
3235
|
+
# resp.profiles[0].profile.mailing_address.address_1 #=> String
|
|
3236
|
+
# resp.profiles[0].profile.mailing_address.address_2 #=> String
|
|
3237
|
+
# resp.profiles[0].profile.mailing_address.address_3 #=> String
|
|
3238
|
+
# resp.profiles[0].profile.mailing_address.address_4 #=> String
|
|
3239
|
+
# resp.profiles[0].profile.mailing_address.city #=> String
|
|
3240
|
+
# resp.profiles[0].profile.mailing_address.county #=> String
|
|
3241
|
+
# resp.profiles[0].profile.mailing_address.state #=> String
|
|
3242
|
+
# resp.profiles[0].profile.mailing_address.province #=> String
|
|
3243
|
+
# resp.profiles[0].profile.mailing_address.country #=> String
|
|
3244
|
+
# resp.profiles[0].profile.mailing_address.postal_code #=> String
|
|
3245
|
+
# resp.profiles[0].profile.billing_address.address_1 #=> String
|
|
3246
|
+
# resp.profiles[0].profile.billing_address.address_2 #=> String
|
|
3247
|
+
# resp.profiles[0].profile.billing_address.address_3 #=> String
|
|
3248
|
+
# resp.profiles[0].profile.billing_address.address_4 #=> String
|
|
3249
|
+
# resp.profiles[0].profile.billing_address.city #=> String
|
|
3250
|
+
# resp.profiles[0].profile.billing_address.county #=> String
|
|
3251
|
+
# resp.profiles[0].profile.billing_address.state #=> String
|
|
3252
|
+
# resp.profiles[0].profile.billing_address.province #=> String
|
|
3253
|
+
# resp.profiles[0].profile.billing_address.country #=> String
|
|
3254
|
+
# resp.profiles[0].profile.billing_address.postal_code #=> String
|
|
3255
|
+
# resp.profiles[0].profile.attributes #=> Hash
|
|
3256
|
+
# resp.profiles[0].profile.attributes["string1To255"] #=> String
|
|
3257
|
+
# resp.profiles[0].profile.found_by_items #=> Array
|
|
3258
|
+
# resp.profiles[0].profile.found_by_items[0].key_name #=> String
|
|
3259
|
+
# resp.profiles[0].profile.found_by_items[0].values #=> Array
|
|
3260
|
+
# resp.profiles[0].profile.found_by_items[0].values[0] #=> String
|
|
3261
|
+
# resp.profiles[0].profile.party_type_string #=> String
|
|
3262
|
+
# resp.profiles[0].profile.gender_string #=> String
|
|
3263
|
+
# resp.failures #=> Array
|
|
3264
|
+
# resp.failures[0].profile_id #=> String
|
|
3265
|
+
# resp.failures[0].message #=> String
|
|
3266
|
+
# resp.failures[0].status #=> Integer
|
|
3267
|
+
#
|
|
3268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentMembership AWS API Documentation
|
|
3269
|
+
#
|
|
3270
|
+
# @overload get_segment_membership(params = {})
|
|
3271
|
+
# @param [Hash] params ({})
|
|
3272
|
+
def get_segment_membership(params = {}, options = {})
|
|
3273
|
+
req = build_request(:get_segment_membership, params)
|
|
3274
|
+
req.send_request(options)
|
|
3275
|
+
end
|
|
3276
|
+
|
|
3277
|
+
# Retrieve the latest status of a segment snapshot.
|
|
3278
|
+
#
|
|
3279
|
+
# @option params [required, String] :domain_name
|
|
3280
|
+
# The unique identifier of the domain.
|
|
3281
|
+
#
|
|
3282
|
+
# @option params [required, String] :segment_definition_name
|
|
3283
|
+
# The unique name of the segment definition.
|
|
3284
|
+
#
|
|
3285
|
+
# @option params [required, String] :snapshot_id
|
|
3286
|
+
# The unique identifier of the segment snapshot.
|
|
3287
|
+
#
|
|
3288
|
+
# @return [Types::GetSegmentSnapshotResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3289
|
+
#
|
|
3290
|
+
# * {Types::GetSegmentSnapshotResponse#snapshot_id #snapshot_id} => String
|
|
3291
|
+
# * {Types::GetSegmentSnapshotResponse#status #status} => String
|
|
3292
|
+
# * {Types::GetSegmentSnapshotResponse#status_message #status_message} => String
|
|
3293
|
+
# * {Types::GetSegmentSnapshotResponse#data_format #data_format} => String
|
|
3294
|
+
# * {Types::GetSegmentSnapshotResponse#encryption_key #encryption_key} => String
|
|
3295
|
+
# * {Types::GetSegmentSnapshotResponse#role_arn #role_arn} => String
|
|
3296
|
+
# * {Types::GetSegmentSnapshotResponse#destination_uri #destination_uri} => String
|
|
3297
|
+
#
|
|
3298
|
+
# @example Request syntax with placeholder values
|
|
3299
|
+
#
|
|
3300
|
+
# resp = client.get_segment_snapshot({
|
|
3301
|
+
# domain_name: "name", # required
|
|
3302
|
+
# segment_definition_name: "name", # required
|
|
3303
|
+
# snapshot_id: "uuid", # required
|
|
3304
|
+
# })
|
|
3305
|
+
#
|
|
3306
|
+
# @example Response structure
|
|
3307
|
+
#
|
|
3308
|
+
# resp.snapshot_id #=> String
|
|
3309
|
+
# resp.status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED"
|
|
3310
|
+
# resp.status_message #=> String
|
|
3311
|
+
# resp.data_format #=> String, one of "CSV", "JSONL", "ORC"
|
|
3312
|
+
# resp.encryption_key #=> String
|
|
3313
|
+
# resp.role_arn #=> String
|
|
3314
|
+
# resp.destination_uri #=> String
|
|
3315
|
+
#
|
|
3316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentSnapshot AWS API Documentation
|
|
3317
|
+
#
|
|
3318
|
+
# @overload get_segment_snapshot(params = {})
|
|
3319
|
+
# @param [Hash] params ({})
|
|
3320
|
+
def get_segment_snapshot(params = {}, options = {})
|
|
3321
|
+
req = build_request(:get_segment_snapshot, params)
|
|
3322
|
+
req.send_request(options)
|
|
3323
|
+
end
|
|
3324
|
+
|
|
2144
3325
|
# Returns a set of profiles that belong to the same matching group using
|
|
2145
3326
|
# the `matchId` or `profileId`. You can also specify the type of
|
|
2146
3327
|
# matching that you want for finding similar profiles using either
|
|
@@ -2173,6 +3354,8 @@ module Aws::CustomerProfiles
|
|
|
2173
3354
|
# * {Types::GetSimilarProfilesResponse#confidence_score #confidence_score} => Float
|
|
2174
3355
|
# * {Types::GetSimilarProfilesResponse#next_token #next_token} => String
|
|
2175
3356
|
#
|
|
3357
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3358
|
+
#
|
|
2176
3359
|
# @example Request syntax with placeholder values
|
|
2177
3360
|
#
|
|
2178
3361
|
# resp = client.get_similar_profiles({
|
|
@@ -2657,6 +3840,91 @@ module Aws::CustomerProfiles
|
|
|
2657
3840
|
req.send_request(options)
|
|
2658
3841
|
end
|
|
2659
3842
|
|
|
3843
|
+
# Fetch the possible attribute values given the attribute name.
|
|
3844
|
+
#
|
|
3845
|
+
# @option params [String] :next_token
|
|
3846
|
+
# The pagination token from the previous call.
|
|
3847
|
+
#
|
|
3848
|
+
# @option params [Integer] :max_results
|
|
3849
|
+
# The maximum number of objects returned per page.
|
|
3850
|
+
#
|
|
3851
|
+
# @option params [required, String] :domain_name
|
|
3852
|
+
# The unique identifier of the domain.
|
|
3853
|
+
#
|
|
3854
|
+
# @option params [required, String] :object_type_name
|
|
3855
|
+
# The name of the profile object type.
|
|
3856
|
+
#
|
|
3857
|
+
# @return [Types::ListObjectTypeAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3858
|
+
#
|
|
3859
|
+
# * {Types::ListObjectTypeAttributesResponse#items #items} => Array<Types::ListObjectTypeAttributeItem>
|
|
3860
|
+
# * {Types::ListObjectTypeAttributesResponse#next_token #next_token} => String
|
|
3861
|
+
#
|
|
3862
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3863
|
+
#
|
|
3864
|
+
# @example Request syntax with placeholder values
|
|
3865
|
+
#
|
|
3866
|
+
# resp = client.list_object_type_attributes({
|
|
3867
|
+
# next_token: "token",
|
|
3868
|
+
# max_results: 1,
|
|
3869
|
+
# domain_name: "name", # required
|
|
3870
|
+
# object_type_name: "typeName", # required
|
|
3871
|
+
# })
|
|
3872
|
+
#
|
|
3873
|
+
# @example Response structure
|
|
3874
|
+
#
|
|
3875
|
+
# resp.items #=> Array
|
|
3876
|
+
# resp.items[0].attribute_name #=> String
|
|
3877
|
+
# resp.items[0].last_updated_at #=> Time
|
|
3878
|
+
# resp.next_token #=> String
|
|
3879
|
+
#
|
|
3880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributes AWS API Documentation
|
|
3881
|
+
#
|
|
3882
|
+
# @overload list_object_type_attributes(params = {})
|
|
3883
|
+
# @param [Hash] params ({})
|
|
3884
|
+
def list_object_type_attributes(params = {}, options = {})
|
|
3885
|
+
req = build_request(:list_object_type_attributes, params)
|
|
3886
|
+
req.send_request(options)
|
|
3887
|
+
end
|
|
3888
|
+
|
|
3889
|
+
# Fetch the possible attribute values given the attribute name.
|
|
3890
|
+
#
|
|
3891
|
+
# @option params [required, String] :domain_name
|
|
3892
|
+
# The unique identifier of the domain.
|
|
3893
|
+
#
|
|
3894
|
+
# @option params [required, String] :attribute_name
|
|
3895
|
+
# The attribute name.
|
|
3896
|
+
#
|
|
3897
|
+
# @return [Types::ProfileAttributeValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3898
|
+
#
|
|
3899
|
+
# * {Types::ProfileAttributeValuesResponse#domain_name #domain_name} => String
|
|
3900
|
+
# * {Types::ProfileAttributeValuesResponse#attribute_name #attribute_name} => String
|
|
3901
|
+
# * {Types::ProfileAttributeValuesResponse#items #items} => Array<Types::AttributeValueItem>
|
|
3902
|
+
# * {Types::ProfileAttributeValuesResponse#status_code #status_code} => Integer
|
|
3903
|
+
#
|
|
3904
|
+
# @example Request syntax with placeholder values
|
|
3905
|
+
#
|
|
3906
|
+
# resp = client.list_profile_attribute_values({
|
|
3907
|
+
# domain_name: "name", # required
|
|
3908
|
+
# attribute_name: "string1To255", # required
|
|
3909
|
+
# })
|
|
3910
|
+
#
|
|
3911
|
+
# @example Response structure
|
|
3912
|
+
#
|
|
3913
|
+
# resp.domain_name #=> String
|
|
3914
|
+
# resp.attribute_name #=> String
|
|
3915
|
+
# resp.items #=> Array
|
|
3916
|
+
# resp.items[0].value #=> String
|
|
3917
|
+
# resp.status_code #=> Integer
|
|
3918
|
+
#
|
|
3919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileAttributeValues AWS API Documentation
|
|
3920
|
+
#
|
|
3921
|
+
# @overload list_profile_attribute_values(params = {})
|
|
3922
|
+
# @param [Hash] params ({})
|
|
3923
|
+
def list_profile_attribute_values(params = {}, options = {})
|
|
3924
|
+
req = build_request(:list_profile_attribute_values, params)
|
|
3925
|
+
req.send_request(options)
|
|
3926
|
+
end
|
|
3927
|
+
|
|
2660
3928
|
# Lists all of the template information for object types.
|
|
2661
3929
|
#
|
|
2662
3930
|
# @option params [String] :next_token
|
|
@@ -2816,6 +4084,8 @@ module Aws::CustomerProfiles
|
|
|
2816
4084
|
# * {Types::ListRuleBasedMatchesResponse#match_ids #match_ids} => Array<String>
|
|
2817
4085
|
# * {Types::ListRuleBasedMatchesResponse#next_token #next_token} => String
|
|
2818
4086
|
#
|
|
4087
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4088
|
+
#
|
|
2819
4089
|
# @example Request syntax with placeholder values
|
|
2820
4090
|
#
|
|
2821
4091
|
# resp = client.list_rule_based_matches({
|
|
@@ -2839,6 +4109,53 @@ module Aws::CustomerProfiles
|
|
|
2839
4109
|
req.send_request(options)
|
|
2840
4110
|
end
|
|
2841
4111
|
|
|
4112
|
+
# Lists all segment definitions under a domain.
|
|
4113
|
+
#
|
|
4114
|
+
# @option params [required, String] :domain_name
|
|
4115
|
+
# The unique identifier of the domain.
|
|
4116
|
+
#
|
|
4117
|
+
# @option params [Integer] :max_results
|
|
4118
|
+
# The maximum number of objects returned per page.
|
|
4119
|
+
#
|
|
4120
|
+
# @option params [String] :next_token
|
|
4121
|
+
# The pagination token from the previous call.
|
|
4122
|
+
#
|
|
4123
|
+
# @return [Types::ListSegmentDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4124
|
+
#
|
|
4125
|
+
# * {Types::ListSegmentDefinitionsResponse#next_token #next_token} => String
|
|
4126
|
+
# * {Types::ListSegmentDefinitionsResponse#items #items} => Array<Types::SegmentDefinitionItem>
|
|
4127
|
+
#
|
|
4128
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4129
|
+
#
|
|
4130
|
+
# @example Request syntax with placeholder values
|
|
4131
|
+
#
|
|
4132
|
+
# resp = client.list_segment_definitions({
|
|
4133
|
+
# domain_name: "name", # required
|
|
4134
|
+
# max_results: 1,
|
|
4135
|
+
# next_token: "token",
|
|
4136
|
+
# })
|
|
4137
|
+
#
|
|
4138
|
+
# @example Response structure
|
|
4139
|
+
#
|
|
4140
|
+
# resp.next_token #=> String
|
|
4141
|
+
# resp.items #=> Array
|
|
4142
|
+
# resp.items[0].segment_definition_name #=> String
|
|
4143
|
+
# resp.items[0].display_name #=> String
|
|
4144
|
+
# resp.items[0].description #=> String
|
|
4145
|
+
# resp.items[0].segment_definition_arn #=> String
|
|
4146
|
+
# resp.items[0].created_at #=> Time
|
|
4147
|
+
# resp.items[0].tags #=> Hash
|
|
4148
|
+
# resp.items[0].tags["TagKey"] #=> String
|
|
4149
|
+
#
|
|
4150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListSegmentDefinitions AWS API Documentation
|
|
4151
|
+
#
|
|
4152
|
+
# @overload list_segment_definitions(params = {})
|
|
4153
|
+
# @param [Hash] params ({})
|
|
4154
|
+
def list_segment_definitions(params = {}, options = {})
|
|
4155
|
+
req = build_request(:list_segment_definitions, params)
|
|
4156
|
+
req.send_request(options)
|
|
4157
|
+
end
|
|
4158
|
+
|
|
2842
4159
|
# Displays the tags associated with an Amazon Connect Customer Profiles
|
|
2843
4160
|
# resource. In Connect Customer Profiles, domains, profile object types,
|
|
2844
4161
|
# and integrations can be tagged.
|
|
@@ -3338,7 +4655,7 @@ module Aws::CustomerProfiles
|
|
|
3338
4655
|
# keys: {
|
|
3339
4656
|
# "name" => [
|
|
3340
4657
|
# {
|
|
3341
|
-
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
|
4658
|
+
# standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, ORDER, COMMUNICATION_RECORD, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
|
|
3342
4659
|
# field_names: ["name"],
|
|
3343
4660
|
# },
|
|
3344
4661
|
# ],
|
|
@@ -3366,7 +4683,7 @@ module Aws::CustomerProfiles
|
|
|
3366
4683
|
# resp.keys #=> Hash
|
|
3367
4684
|
# resp.keys["name"] #=> Array
|
|
3368
4685
|
# resp.keys["name"][0].standard_identifiers #=> Array
|
|
3369
|
-
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
4686
|
+
# resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "ORDER", "COMMUNICATION_RECORD", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
|
|
3370
4687
|
# resp.keys["name"][0].field_names #=> Array
|
|
3371
4688
|
# resp.keys["name"][0].field_names[0] #=> String
|
|
3372
4689
|
# resp.created_at #=> Time
|
|
@@ -4089,7 +5406,7 @@ module Aws::CustomerProfiles
|
|
|
4089
5406
|
tracer: tracer
|
|
4090
5407
|
)
|
|
4091
5408
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
|
4092
|
-
context[:gem_version] = '1.
|
|
5409
|
+
context[:gem_version] = '1.57.0'
|
|
4093
5410
|
Seahorse::Client::Request.new(handlers, context)
|
|
4094
5411
|
end
|
|
4095
5412
|
|