aws-sdk-customerprofiles 1.55.0 → 1.57.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -160,6 +160,45 @@ module Aws::CustomerProfiles
160
160
  include Aws::Structure
161
161
  end
162
162
 
163
+ # Object that segments on Customer Profile's address object.
164
+ #
165
+ # @!attribute [rw] city
166
+ # The city belonging to the address.
167
+ # @return [Types::ProfileDimension]
168
+ #
169
+ # @!attribute [rw] country
170
+ # The country belonging to the address.
171
+ # @return [Types::ProfileDimension]
172
+ #
173
+ # @!attribute [rw] county
174
+ # The county belonging to the address.
175
+ # @return [Types::ProfileDimension]
176
+ #
177
+ # @!attribute [rw] postal_code
178
+ # The postal code belonging to the address.
179
+ # @return [Types::ProfileDimension]
180
+ #
181
+ # @!attribute [rw] province
182
+ # The province belonging to the address.
183
+ # @return [Types::ProfileDimension]
184
+ #
185
+ # @!attribute [rw] state
186
+ # The state belonging to the address.
187
+ # @return [Types::ProfileDimension]
188
+ #
189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AddressDimension AWS API Documentation
190
+ #
191
+ class AddressDimension < Struct.new(
192
+ :city,
193
+ :country,
194
+ :county,
195
+ :postal_code,
196
+ :province,
197
+ :state)
198
+ SENSITIVE = []
199
+ include Aws::Structure
200
+ end
201
+
163
202
  # Details for workflow of type `APPFLOW_INTEGRATION`.
164
203
  #
165
204
  # @!attribute [rw] flow_definition
@@ -302,7 +341,7 @@ module Aws::CustomerProfiles
302
341
  # Mathematical expression that is performed on attribute items
303
342
  # provided in the attribute list. Each element in the expression
304
343
  # should follow the structure of
305
- # \\"\\\{ObjectTypeName.AttributeName\\}\\".
344
+ # \\"\{ObjectTypeName.AttributeName}\\".
306
345
  # @return [String]
307
346
  #
308
347
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AttributeDetails AWS API Documentation
@@ -314,6 +353,25 @@ module Aws::CustomerProfiles
314
353
  include Aws::Structure
315
354
  end
316
355
 
356
+ # Object that segments on various Customer Profile's fields.
357
+ #
358
+ # @!attribute [rw] dimension_type
359
+ # The action to segment with.
360
+ # @return [String]
361
+ #
362
+ # @!attribute [rw] values
363
+ # The values to apply the DimensionType on.
364
+ # @return [Array<String>]
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AttributeDimension AWS API Documentation
367
+ #
368
+ class AttributeDimension < Struct.new(
369
+ :dimension_type,
370
+ :values)
371
+ SENSITIVE = []
372
+ include Aws::Structure
373
+ end
374
+
317
375
  # The details of a single attribute item specified in the mathematical
318
376
  # expression.
319
377
  #
@@ -340,13 +398,11 @@ module Aws::CustomerProfiles
340
398
  # * You can choose from `Email`, `BusinessEmail`, and `PersonalEmail`
341
399
  #
342
400
  # ^
343
- #
344
401
  # * Phone number type
345
402
  #
346
403
  # * You can choose from `Phone`, `HomePhone`, and `MobilePhone`
347
404
  #
348
405
  # ^
349
- #
350
406
  # * Address type
351
407
  #
352
408
  # * You can choose from `Address`, `BusinessAddress`,
@@ -415,6 +471,20 @@ module Aws::CustomerProfiles
415
471
  include Aws::Structure
416
472
  end
417
473
 
474
+ # List containing the values for the given attribute.
475
+ #
476
+ # @!attribute [rw] value
477
+ # An individual value belonging to the given attribute.
478
+ # @return [String]
479
+ #
480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AttributeValueItem AWS API Documentation
481
+ #
482
+ class AttributeValueItem < Struct.new(
483
+ :value)
484
+ SENSITIVE = []
485
+ include Aws::Structure
486
+ end
487
+
418
488
  # Configuration settings for how to perform the auto-merging of
419
489
  # profiles.
420
490
  #
@@ -487,6 +557,225 @@ module Aws::CustomerProfiles
487
557
  include Aws::Structure
488
558
  end
489
559
 
560
+ # Error object describing why a specific profile and calculated
561
+ # attribute failed.
562
+ #
563
+ # @!attribute [rw] code
564
+ # Status code for why a specific profile and calculated attribute
565
+ # failed.
566
+ # @return [String]
567
+ #
568
+ # @!attribute [rw] message
569
+ # Message describing why a specific profile and calculated attribute
570
+ # failed.
571
+ # @return [String]
572
+ #
573
+ # @!attribute [rw] profile_id
574
+ # The profile id that failed.
575
+ # @return [String]
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfileError AWS API Documentation
578
+ #
579
+ class BatchGetCalculatedAttributeForProfileError < Struct.new(
580
+ :code,
581
+ :message,
582
+ :profile_id)
583
+ SENSITIVE = []
584
+ include Aws::Structure
585
+ end
586
+
587
+ # @!attribute [rw] calculated_attribute_name
588
+ # The unique name of the calculated attribute.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] domain_name
592
+ # The unique name of the domain.
593
+ # @return [String]
594
+ #
595
+ # @!attribute [rw] profile_ids
596
+ # List of unique identifiers for customer profiles to retrieve.
597
+ # @return [Array<String>]
598
+ #
599
+ # @!attribute [rw] condition_overrides
600
+ # Overrides the condition block within the original calculated
601
+ # attribute definition.
602
+ # @return [Types::ConditionOverrides]
603
+ #
604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfileRequest AWS API Documentation
605
+ #
606
+ class BatchGetCalculatedAttributeForProfileRequest < Struct.new(
607
+ :calculated_attribute_name,
608
+ :domain_name,
609
+ :profile_ids,
610
+ :condition_overrides)
611
+ SENSITIVE = [:condition_overrides]
612
+ include Aws::Structure
613
+ end
614
+
615
+ # @!attribute [rw] errors
616
+ # List of errors for calculated attribute values that could not be
617
+ # retrieved.
618
+ # @return [Array<Types::BatchGetCalculatedAttributeForProfileError>]
619
+ #
620
+ # @!attribute [rw] calculated_attribute_values
621
+ # List of calculated attribute values retrieved.
622
+ # @return [Array<Types::CalculatedAttributeValue>]
623
+ #
624
+ # @!attribute [rw] condition_overrides
625
+ # Overrides the condition block within the original calculated
626
+ # attribute definition.
627
+ # @return [Types::ConditionOverrides]
628
+ #
629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfileResponse AWS API Documentation
630
+ #
631
+ class BatchGetCalculatedAttributeForProfileResponse < Struct.new(
632
+ :errors,
633
+ :calculated_attribute_values,
634
+ :condition_overrides)
635
+ SENSITIVE = [:condition_overrides]
636
+ include Aws::Structure
637
+ end
638
+
639
+ # Error object describing why a specific profile failed.
640
+ #
641
+ # @!attribute [rw] code
642
+ # Status code for why a specific profile failed.
643
+ # @return [String]
644
+ #
645
+ # @!attribute [rw] message
646
+ # Message describing why a specific profile failed.
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] profile_id
650
+ # The profile id that failed.
651
+ # @return [String]
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetProfileError AWS API Documentation
654
+ #
655
+ class BatchGetProfileError < Struct.new(
656
+ :code,
657
+ :message,
658
+ :profile_id)
659
+ SENSITIVE = []
660
+ include Aws::Structure
661
+ end
662
+
663
+ # @!attribute [rw] domain_name
664
+ # The unique name of the domain.
665
+ # @return [String]
666
+ #
667
+ # @!attribute [rw] profile_ids
668
+ # List of unique identifiers for customer profiles to retrieve.
669
+ # @return [Array<String>]
670
+ #
671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetProfileRequest AWS API Documentation
672
+ #
673
+ class BatchGetProfileRequest < Struct.new(
674
+ :domain_name,
675
+ :profile_ids)
676
+ SENSITIVE = []
677
+ include Aws::Structure
678
+ end
679
+
680
+ # @!attribute [rw] errors
681
+ # For information about the errors that are common to all actions, see
682
+ # [Common Errors][1].
683
+ #
684
+ #
685
+ #
686
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/CommonErrors.html
687
+ # @return [Array<Types::BatchGetProfileError>]
688
+ #
689
+ # @!attribute [rw] profiles
690
+ # Array of Profile Objects.
691
+ # @return [Array<Types::Profile>]
692
+ #
693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/BatchGetProfileResponse AWS API Documentation
694
+ #
695
+ class BatchGetProfileResponse < Struct.new(
696
+ :errors,
697
+ :profiles)
698
+ SENSITIVE = []
699
+ include Aws::Structure
700
+ end
701
+
702
+ # Object that segments on Customer Profile's Calculated Attributes.
703
+ #
704
+ # @!attribute [rw] dimension_type
705
+ # The action to segment with.
706
+ # @return [String]
707
+ #
708
+ # @!attribute [rw] values
709
+ # The values to apply the DimensionType with.
710
+ # @return [Array<String>]
711
+ #
712
+ # @!attribute [rw] condition_overrides
713
+ # Applies the given condition over the initial Calculated Attribute's
714
+ # definition.
715
+ # @return [Types::ConditionOverrides]
716
+ #
717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CalculatedAttributeDimension AWS API Documentation
718
+ #
719
+ class CalculatedAttributeDimension < Struct.new(
720
+ :dimension_type,
721
+ :values,
722
+ :condition_overrides)
723
+ SENSITIVE = [:condition_overrides]
724
+ include Aws::Structure
725
+ end
726
+
727
+ # The object containing the values of a single calculated attribute
728
+ # value.
729
+ #
730
+ # @!attribute [rw] calculated_attribute_name
731
+ # The unique name of the calculated attribute.
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] display_name
735
+ # The display name of the calculated attribute.
736
+ # @return [String]
737
+ #
738
+ # @!attribute [rw] is_data_partial
739
+ # Indicates whether the calculated attribute's value is based on
740
+ # partial data. If the data is partial, it is set to true.
741
+ # @return [String]
742
+ #
743
+ # @!attribute [rw] profile_id
744
+ # The profile id belonging to this calculated attribute value.
745
+ # @return [String]
746
+ #
747
+ # @!attribute [rw] value
748
+ # The value of the calculated attribute.
749
+ # @return [String]
750
+ #
751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CalculatedAttributeValue AWS API Documentation
752
+ #
753
+ class CalculatedAttributeValue < Struct.new(
754
+ :calculated_attribute_name,
755
+ :display_name,
756
+ :is_data_partial,
757
+ :profile_id,
758
+ :value)
759
+ SENSITIVE = []
760
+ include Aws::Structure
761
+ end
762
+
763
+ # An object to override the original condition block of a calculated
764
+ # attribute.
765
+ #
766
+ # @!attribute [rw] range
767
+ # The relative time period over which data is included in the
768
+ # aggregation for this override.
769
+ # @return [Types::RangeOverride]
770
+ #
771
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ConditionOverrides AWS API Documentation
772
+ #
773
+ class ConditionOverrides < Struct.new(
774
+ :range)
775
+ SENSITIVE = []
776
+ include Aws::Structure
777
+ end
778
+
490
779
  # The conditions including range, object count, and threshold for the
491
780
  # calculated attribute.
492
781
  #
@@ -619,6 +908,11 @@ module Aws::CustomerProfiles
619
908
  # calculated attribute.
620
909
  # @return [Types::Conditions]
621
910
  #
911
+ # @!attribute [rw] filter
912
+ # Defines how to filter incoming objects to include part of the
913
+ # Calculated Attribute.
914
+ # @return [Types::Filter]
915
+ #
622
916
  # @!attribute [rw] statistic
623
917
  # The aggregation operation to perform for the calculated attribute.
624
918
  # @return [String]
@@ -637,6 +931,7 @@ module Aws::CustomerProfiles
637
931
  :description,
638
932
  :attribute_details,
639
933
  :conditions,
934
+ :filter,
640
935
  :statistic,
641
936
  :tags)
642
937
  SENSITIVE = [:description, :attribute_details, :conditions, :statistic]
@@ -665,6 +960,10 @@ module Aws::CustomerProfiles
665
960
  # calculated attribute.
666
961
  # @return [Types::Conditions]
667
962
  #
963
+ # @!attribute [rw] filter
964
+ # The filter that was used as part of the request.
965
+ # @return [Types::Filter]
966
+ #
668
967
  # @!attribute [rw] statistic
669
968
  # The aggregation operation to perform for the calculated attribute.
670
969
  # @return [String]
@@ -692,6 +991,7 @@ module Aws::CustomerProfiles
692
991
  :description,
693
992
  :attribute_details,
694
993
  :conditions,
994
+ :filter,
695
995
  :statistic,
696
996
  :created_at,
697
997
  :last_updated_at,
@@ -1094,6 +1394,197 @@ module Aws::CustomerProfiles
1094
1394
  include Aws::Structure
1095
1395
  end
1096
1396
 
1397
+ # @!attribute [rw] domain_name
1398
+ # The unique name of the domain.
1399
+ # @return [String]
1400
+ #
1401
+ # @!attribute [rw] segment_definition_name
1402
+ # The unique name of the segment definition.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] display_name
1406
+ # The display name of the segment definition.
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] description
1410
+ # The description of the segment definition.
1411
+ # @return [String]
1412
+ #
1413
+ # @!attribute [rw] segment_groups
1414
+ # Specifies the base segments and dimensions for a segment definition
1415
+ # along with their respective relationship.
1416
+ # @return [Types::SegmentGroup]
1417
+ #
1418
+ # @!attribute [rw] tags
1419
+ # The tags used to organize, track, or control access for this
1420
+ # resource.
1421
+ # @return [Hash<String,String>]
1422
+ #
1423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentDefinitionRequest AWS API Documentation
1424
+ #
1425
+ class CreateSegmentDefinitionRequest < Struct.new(
1426
+ :domain_name,
1427
+ :segment_definition_name,
1428
+ :display_name,
1429
+ :description,
1430
+ :segment_groups,
1431
+ :tags)
1432
+ SENSITIVE = [:description, :segment_groups]
1433
+ include Aws::Structure
1434
+ end
1435
+
1436
+ # @!attribute [rw] segment_definition_name
1437
+ # The name of the segment definition.
1438
+ # @return [String]
1439
+ #
1440
+ # @!attribute [rw] display_name
1441
+ # The display name of the segment definition.
1442
+ # @return [String]
1443
+ #
1444
+ # @!attribute [rw] description
1445
+ # The description of the segment definition.
1446
+ # @return [String]
1447
+ #
1448
+ # @!attribute [rw] created_at
1449
+ # The timestamp of when the segment definition was created.
1450
+ # @return [Time]
1451
+ #
1452
+ # @!attribute [rw] segment_definition_arn
1453
+ # The arn of the segment definition.
1454
+ # @return [String]
1455
+ #
1456
+ # @!attribute [rw] tags
1457
+ # The tags used to organize, track, or control access for this
1458
+ # resource.
1459
+ # @return [Hash<String,String>]
1460
+ #
1461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentDefinitionResponse AWS API Documentation
1462
+ #
1463
+ class CreateSegmentDefinitionResponse < Struct.new(
1464
+ :segment_definition_name,
1465
+ :display_name,
1466
+ :description,
1467
+ :created_at,
1468
+ :segment_definition_arn,
1469
+ :tags)
1470
+ SENSITIVE = [:description]
1471
+ include Aws::Structure
1472
+ end
1473
+
1474
+ # @!attribute [rw] domain_name
1475
+ # The unique name of the domain.
1476
+ # @return [String]
1477
+ #
1478
+ # @!attribute [rw] segment_query
1479
+ # The segment query for calculating a segment estimate.
1480
+ # @return [Types::SegmentGroupStructure]
1481
+ #
1482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentEstimateRequest AWS API Documentation
1483
+ #
1484
+ class CreateSegmentEstimateRequest < Struct.new(
1485
+ :domain_name,
1486
+ :segment_query)
1487
+ SENSITIVE = []
1488
+ include Aws::Structure
1489
+ end
1490
+
1491
+ # @!attribute [rw] domain_name
1492
+ # The unique name of the domain.
1493
+ # @return [String]
1494
+ #
1495
+ # @!attribute [rw] estimate_id
1496
+ # A unique identifier for the resource. The value can be passed to
1497
+ # `GetSegmentEstimate` to retrieve the result of segment estimate
1498
+ # status.
1499
+ # @return [String]
1500
+ #
1501
+ # @!attribute [rw] status_code
1502
+ # The status code for the response.
1503
+ # @return [Integer]
1504
+ #
1505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentEstimateResponse AWS API Documentation
1506
+ #
1507
+ class CreateSegmentEstimateResponse < Struct.new(
1508
+ :domain_name,
1509
+ :estimate_id,
1510
+ :status_code)
1511
+ SENSITIVE = []
1512
+ include Aws::Structure
1513
+ end
1514
+
1515
+ # @!attribute [rw] domain_name
1516
+ # The unique name of the domain.
1517
+ # @return [String]
1518
+ #
1519
+ # @!attribute [rw] segment_definition_name
1520
+ # The name of the segment definition used in this snapshot request.
1521
+ # @return [String]
1522
+ #
1523
+ # @!attribute [rw] data_format
1524
+ # The format in which the segment will be exported.
1525
+ # @return [String]
1526
+ #
1527
+ # @!attribute [rw] encryption_key
1528
+ # The Amazon Resource Name (ARN) of the KMS key used to encrypt the
1529
+ # exported segment.
1530
+ # @return [String]
1531
+ #
1532
+ # @!attribute [rw] role_arn
1533
+ # The Amazon Resource Name (ARN) of the IAM role that allows Customer
1534
+ # Profiles service principal to assume the role for conducting KMS and
1535
+ # S3 operations.
1536
+ # @return [String]
1537
+ #
1538
+ # @!attribute [rw] destination_uri
1539
+ # The destination to which the segment will be exported. This field
1540
+ # must be provided if the request is not submitted from the Amazon
1541
+ # Connect Admin Website.
1542
+ # @return [String]
1543
+ #
1544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentSnapshotRequest AWS API Documentation
1545
+ #
1546
+ class CreateSegmentSnapshotRequest < Struct.new(
1547
+ :domain_name,
1548
+ :segment_definition_name,
1549
+ :data_format,
1550
+ :encryption_key,
1551
+ :role_arn,
1552
+ :destination_uri)
1553
+ SENSITIVE = []
1554
+ include Aws::Structure
1555
+ end
1556
+
1557
+ # @!attribute [rw] snapshot_id
1558
+ # The unique identifier of the segment snapshot.
1559
+ # @return [String]
1560
+ #
1561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateSegmentSnapshotResponse AWS API Documentation
1562
+ #
1563
+ class CreateSegmentSnapshotResponse < Struct.new(
1564
+ :snapshot_id)
1565
+ SENSITIVE = []
1566
+ include Aws::Structure
1567
+ end
1568
+
1569
+ # Object that segments on various Customer Profile's date fields.
1570
+ #
1571
+ # @!attribute [rw] dimension_type
1572
+ # The action to segment with.
1573
+ # @return [String]
1574
+ #
1575
+ # @!attribute [rw] values
1576
+ # The values to apply the DimensionType on.
1577
+ # @return [Array<String>]
1578
+ #
1579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DateDimension AWS API Documentation
1580
+ #
1581
+ class DateDimension < Struct.new(
1582
+ :dimension_type,
1583
+ :values)
1584
+ SENSITIVE = []
1585
+ include Aws::Structure
1586
+ end
1587
+
1097
1588
  # @!attribute [rw] domain_name
1098
1589
  # The unique name of the domain.
1099
1590
  # @return [String]
@@ -1326,6 +1817,35 @@ module Aws::CustomerProfiles
1326
1817
  include Aws::Structure
1327
1818
  end
1328
1819
 
1820
+ # @!attribute [rw] domain_name
1821
+ # The unique name of the domain.
1822
+ # @return [String]
1823
+ #
1824
+ # @!attribute [rw] segment_definition_name
1825
+ # The unique name of the segment definition.
1826
+ # @return [String]
1827
+ #
1828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteSegmentDefinitionRequest AWS API Documentation
1829
+ #
1830
+ class DeleteSegmentDefinitionRequest < Struct.new(
1831
+ :domain_name,
1832
+ :segment_definition_name)
1833
+ SENSITIVE = []
1834
+ include Aws::Structure
1835
+ end
1836
+
1837
+ # @!attribute [rw] message
1838
+ # A message that indicates the delete request is done.
1839
+ # @return [String]
1840
+ #
1841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteSegmentDefinitionResponse AWS API Documentation
1842
+ #
1843
+ class DeleteSegmentDefinitionResponse < Struct.new(
1844
+ :message)
1845
+ SENSITIVE = []
1846
+ include Aws::Structure
1847
+ end
1848
+
1329
1849
  # @!attribute [rw] domain_name
1330
1850
  # The unique name of the domain.
1331
1851
  # @return [String]
@@ -1428,6 +1948,36 @@ module Aws::CustomerProfiles
1428
1948
  include Aws::Structure
1429
1949
  end
1430
1950
 
1951
+ # Object that holds what profile and calculated attributes to segment
1952
+ # on.
1953
+ #
1954
+ # @note Dimension is a union - when making an API calls you must set exactly one of the members.
1955
+ #
1956
+ # @note Dimension is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Dimension corresponding to the set member.
1957
+ #
1958
+ # @!attribute [rw] profile_attributes
1959
+ # Object that holds the profile attributes to segment on.
1960
+ # @return [Types::ProfileAttributes]
1961
+ #
1962
+ # @!attribute [rw] calculated_attributes
1963
+ # Object that holds the calculated attributes to segment on.
1964
+ # @return [Hash<String,Types::CalculatedAttributeDimension>]
1965
+ #
1966
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Dimension AWS API Documentation
1967
+ #
1968
+ class Dimension < Struct.new(
1969
+ :profile_attributes,
1970
+ :calculated_attributes,
1971
+ :unknown)
1972
+ SENSITIVE = [:profile_attributes]
1973
+ include Aws::Structure
1974
+ include Aws::Structure::Union
1975
+
1976
+ class ProfileAttributes < Dimension; end
1977
+ class CalculatedAttributes < Dimension; end
1978
+ class Unknown < Dimension; end
1979
+ end
1980
+
1431
1981
  # Usage-specific statistics about the domain.
1432
1982
  #
1433
1983
  # @!attribute [rw] profile_count
@@ -1578,6 +2128,26 @@ module Aws::CustomerProfiles
1578
2128
  include Aws::Structure
1579
2129
  end
1580
2130
 
2131
+ # Object that segments on various Customer profile's fields that are
2132
+ # larger than normal.
2133
+ #
2134
+ # @!attribute [rw] dimension_type
2135
+ # The action to segment with.
2136
+ # @return [String]
2137
+ #
2138
+ # @!attribute [rw] values
2139
+ # The values to apply the DimensionType on.
2140
+ # @return [Array<String>]
2141
+ #
2142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ExtraLengthValueProfileDimension AWS API Documentation
2143
+ #
2144
+ class ExtraLengthValueProfileDimension < Struct.new(
2145
+ :dimension_type,
2146
+ :values)
2147
+ SENSITIVE = []
2148
+ include Aws::Structure
2149
+ end
2150
+
1581
2151
  # A duplicate customer profile that is to be merged into a main profile.
1582
2152
  #
1583
2153
  # @!attribute [rw] account_number
@@ -1695,6 +2265,80 @@ module Aws::CustomerProfiles
1695
2265
  include Aws::Structure
1696
2266
  end
1697
2267
 
2268
+ # Defines how to filter the objects coming in for calculated attributes.
2269
+ #
2270
+ # @!attribute [rw] include
2271
+ # Define whether to include or exclude objects for Calculated
2272
+ # Attributed calculation that fit the filter groups criteria.
2273
+ # @return [String]
2274
+ #
2275
+ # @!attribute [rw] groups
2276
+ # Holds the list of Filter groups within the Filter definition.
2277
+ # @return [Array<Types::FilterGroup>]
2278
+ #
2279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Filter AWS API Documentation
2280
+ #
2281
+ class Filter < Struct.new(
2282
+ :include,
2283
+ :groups)
2284
+ SENSITIVE = []
2285
+ include Aws::Structure
2286
+ end
2287
+
2288
+ # Object that defines how to filter the incoming objects for the
2289
+ # calculated attribute.
2290
+ #
2291
+ # @!attribute [rw] dimension_type
2292
+ # The action to filter with.
2293
+ # @return [String]
2294
+ #
2295
+ # @!attribute [rw] values
2296
+ # The values to apply the DimensionType on.
2297
+ # @return [Array<String>]
2298
+ #
2299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FilterAttributeDimension AWS API Documentation
2300
+ #
2301
+ class FilterAttributeDimension < Struct.new(
2302
+ :dimension_type,
2303
+ :values)
2304
+ SENSITIVE = []
2305
+ include Aws::Structure
2306
+ end
2307
+
2308
+ # Contains the map of attribute names to attribute dimensions.
2309
+ #
2310
+ # @!attribute [rw] attributes
2311
+ # Is the attribute within the FilterDimension map
2312
+ # @return [Hash<String,Types::FilterAttributeDimension>]
2313
+ #
2314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FilterDimension AWS API Documentation
2315
+ #
2316
+ class FilterDimension < Struct.new(
2317
+ :attributes)
2318
+ SENSITIVE = []
2319
+ include Aws::Structure
2320
+ end
2321
+
2322
+ # Object that holds the dimensions to filter on.
2323
+ #
2324
+ # @!attribute [rw] type
2325
+ # The type of logical relationship between the dimensions of the
2326
+ # Filter group.
2327
+ # @return [String]
2328
+ #
2329
+ # @!attribute [rw] dimensions
2330
+ # Object that holds the attributes to filter on.
2331
+ # @return [Array<Types::FilterDimension>]
2332
+ #
2333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FilterGroup AWS API Documentation
2334
+ #
2335
+ class FilterGroup < Struct.new(
2336
+ :type,
2337
+ :dimensions)
2338
+ SENSITIVE = []
2339
+ include Aws::Structure
2340
+ end
2341
+
1698
2342
  # The configurations that control how Customer Profiles retrieves data
1699
2343
  # from the source, Amazon AppFlow. Customer Profiles uses this
1700
2344
  # information to create an AppFlow flow on behalf of customers.
@@ -1866,6 +2510,10 @@ module Aws::CustomerProfiles
1866
2510
  # The aggregation operation to perform for the calculated attribute.
1867
2511
  # @return [String]
1868
2512
  #
2513
+ # @!attribute [rw] filter
2514
+ # The filter assigned to this calculated attribute definition.
2515
+ # @return [Types::Filter]
2516
+ #
1869
2517
  # @!attribute [rw] conditions
1870
2518
  # The conditions including range, object count, and threshold for the
1871
2519
  # calculated attribute.
@@ -1890,6 +2538,7 @@ module Aws::CustomerProfiles
1890
2538
  :created_at,
1891
2539
  :last_updated_at,
1892
2540
  :statistic,
2541
+ :filter,
1893
2542
  :conditions,
1894
2543
  :attribute_details,
1895
2544
  :tags)
@@ -2505,6 +3154,238 @@ module Aws::CustomerProfiles
2505
3154
  include Aws::Structure
2506
3155
  end
2507
3156
 
3157
+ # @!attribute [rw] domain_name
3158
+ # The unique name of the domain.
3159
+ # @return [String]
3160
+ #
3161
+ # @!attribute [rw] segment_definition_name
3162
+ # The unique name of the segment definition.
3163
+ # @return [String]
3164
+ #
3165
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentDefinitionRequest AWS API Documentation
3166
+ #
3167
+ class GetSegmentDefinitionRequest < Struct.new(
3168
+ :domain_name,
3169
+ :segment_definition_name)
3170
+ SENSITIVE = []
3171
+ include Aws::Structure
3172
+ end
3173
+
3174
+ # @!attribute [rw] segment_definition_name
3175
+ # The name of the segment definition.
3176
+ # @return [String]
3177
+ #
3178
+ # @!attribute [rw] display_name
3179
+ # The display name of the segment definition.
3180
+ # @return [String]
3181
+ #
3182
+ # @!attribute [rw] description
3183
+ # The description of the segment definition.
3184
+ # @return [String]
3185
+ #
3186
+ # @!attribute [rw] segment_groups
3187
+ # The segment criteria associated with this definition.
3188
+ # @return [Types::SegmentGroup]
3189
+ #
3190
+ # @!attribute [rw] segment_definition_arn
3191
+ # The arn of the segment definition.
3192
+ # @return [String]
3193
+ #
3194
+ # @!attribute [rw] created_at
3195
+ # The timestamp of when the segment definition was created.
3196
+ # @return [Time]
3197
+ #
3198
+ # @!attribute [rw] tags
3199
+ # The tags used to organize, track, or control access for this
3200
+ # resource.
3201
+ # @return [Hash<String,String>]
3202
+ #
3203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentDefinitionResponse AWS API Documentation
3204
+ #
3205
+ class GetSegmentDefinitionResponse < Struct.new(
3206
+ :segment_definition_name,
3207
+ :display_name,
3208
+ :description,
3209
+ :segment_groups,
3210
+ :segment_definition_arn,
3211
+ :created_at,
3212
+ :tags)
3213
+ SENSITIVE = [:description, :segment_groups]
3214
+ include Aws::Structure
3215
+ end
3216
+
3217
+ # @!attribute [rw] domain_name
3218
+ # The unique name of the domain.
3219
+ # @return [String]
3220
+ #
3221
+ # @!attribute [rw] estimate_id
3222
+ # The query Id passed by a previous `CreateSegmentEstimate` operation.
3223
+ # @return [String]
3224
+ #
3225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentEstimateRequest AWS API Documentation
3226
+ #
3227
+ class GetSegmentEstimateRequest < Struct.new(
3228
+ :domain_name,
3229
+ :estimate_id)
3230
+ SENSITIVE = []
3231
+ include Aws::Structure
3232
+ end
3233
+
3234
+ # @!attribute [rw] domain_name
3235
+ # The unique name of the domain.
3236
+ # @return [String]
3237
+ #
3238
+ # @!attribute [rw] estimate_id
3239
+ # The `QueryId` which is the same as the value passed in `QueryId`.
3240
+ # @return [String]
3241
+ #
3242
+ # @!attribute [rw] status
3243
+ # The current status of the query.
3244
+ # @return [String]
3245
+ #
3246
+ # @!attribute [rw] estimate
3247
+ # The estimated number of profiles contained in the segment.
3248
+ # @return [String]
3249
+ #
3250
+ # @!attribute [rw] message
3251
+ # The error message if there is any error.
3252
+ # @return [String]
3253
+ #
3254
+ # @!attribute [rw] status_code
3255
+ # The status code of the segment estimate.
3256
+ # @return [Integer]
3257
+ #
3258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentEstimateResponse AWS API Documentation
3259
+ #
3260
+ class GetSegmentEstimateResponse < Struct.new(
3261
+ :domain_name,
3262
+ :estimate_id,
3263
+ :status,
3264
+ :estimate,
3265
+ :message,
3266
+ :status_code)
3267
+ SENSITIVE = []
3268
+ include Aws::Structure
3269
+ end
3270
+
3271
+ # @!attribute [rw] domain_name
3272
+ # The unique name of the domain.
3273
+ # @return [String]
3274
+ #
3275
+ # @!attribute [rw] segment_definition_name
3276
+ # The Id of the wanted segment. Needs to be a valid, and existing
3277
+ # segment Id.
3278
+ # @return [String]
3279
+ #
3280
+ # @!attribute [rw] profile_ids
3281
+ # The list of profile IDs to query for.
3282
+ # @return [Array<String>]
3283
+ #
3284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentMembershipRequest AWS API Documentation
3285
+ #
3286
+ class GetSegmentMembershipRequest < Struct.new(
3287
+ :domain_name,
3288
+ :segment_definition_name,
3289
+ :profile_ids)
3290
+ SENSITIVE = []
3291
+ include Aws::Structure
3292
+ end
3293
+
3294
+ # @!attribute [rw] segment_definition_name
3295
+ # The unique name of the segment definition.
3296
+ # @return [String]
3297
+ #
3298
+ # @!attribute [rw] profiles
3299
+ # An array of maps where each contains a response per profile
3300
+ # requested.
3301
+ # @return [Array<Types::ProfileQueryResult>]
3302
+ #
3303
+ # @!attribute [rw] failures
3304
+ # An array of maps where each contains a response per profile failed
3305
+ # for the request.
3306
+ # @return [Array<Types::ProfileQueryFailures>]
3307
+ #
3308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentMembershipResponse AWS API Documentation
3309
+ #
3310
+ class GetSegmentMembershipResponse < Struct.new(
3311
+ :segment_definition_name,
3312
+ :profiles,
3313
+ :failures)
3314
+ SENSITIVE = []
3315
+ include Aws::Structure
3316
+ end
3317
+
3318
+ # @!attribute [rw] domain_name
3319
+ # The unique identifier of the domain.
3320
+ # @return [String]
3321
+ #
3322
+ # @!attribute [rw] segment_definition_name
3323
+ # The unique name of the segment definition.
3324
+ # @return [String]
3325
+ #
3326
+ # @!attribute [rw] snapshot_id
3327
+ # The unique identifier of the segment snapshot.
3328
+ # @return [String]
3329
+ #
3330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentSnapshotRequest AWS API Documentation
3331
+ #
3332
+ class GetSegmentSnapshotRequest < Struct.new(
3333
+ :domain_name,
3334
+ :segment_definition_name,
3335
+ :snapshot_id)
3336
+ SENSITIVE = []
3337
+ include Aws::Structure
3338
+ end
3339
+
3340
+ # @!attribute [rw] snapshot_id
3341
+ # The unique identifier of the segment snapshot.
3342
+ # @return [String]
3343
+ #
3344
+ # @!attribute [rw] status
3345
+ # The status of the asynchronous job for exporting the segment
3346
+ # snapshot.
3347
+ # @return [String]
3348
+ #
3349
+ # @!attribute [rw] status_message
3350
+ # The status message of the asynchronous job for exporting the segment
3351
+ # snapshot.
3352
+ # @return [String]
3353
+ #
3354
+ # @!attribute [rw] data_format
3355
+ # The format in which the segment will be exported.
3356
+ # @return [String]
3357
+ #
3358
+ # @!attribute [rw] encryption_key
3359
+ # The Amazon Resource Name (ARN) of the KMS key used to encrypt the
3360
+ # exported segment.
3361
+ # @return [String]
3362
+ #
3363
+ # @!attribute [rw] role_arn
3364
+ # The Amazon Resource Name (ARN) of the IAM role that allows Customer
3365
+ # Profiles service principal to assume the role for conducting KMS and
3366
+ # S3 operations.
3367
+ # @return [String]
3368
+ #
3369
+ # @!attribute [rw] destination_uri
3370
+ # The destination to which the segment will be exported. This field
3371
+ # must be provided if the request is not submitted from the Amazon
3372
+ # Connect Admin Website.
3373
+ # @return [String]
3374
+ #
3375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSegmentSnapshotResponse AWS API Documentation
3376
+ #
3377
+ class GetSegmentSnapshotResponse < Struct.new(
3378
+ :snapshot_id,
3379
+ :status,
3380
+ :status_message,
3381
+ :data_format,
3382
+ :encryption_key,
3383
+ :role_arn,
3384
+ :destination_uri)
3385
+ SENSITIVE = []
3386
+ include Aws::Structure
3387
+ end
3388
+
2508
3389
  # @!attribute [rw] next_token
2509
3390
  # The pagination token from the previous `GetSimilarProfiles` API
2510
3391
  # call.
@@ -2713,6 +3594,36 @@ module Aws::CustomerProfiles
2713
3594
  include Aws::Structure
2714
3595
  end
2715
3596
 
3597
+ # Contains dimensions that determine what to segment on.
3598
+ #
3599
+ # @!attribute [rw] dimensions
3600
+ # Defines the attributes to segment on.
3601
+ # @return [Array<Types::Dimension>]
3602
+ #
3603
+ # @!attribute [rw] source_segments
3604
+ # Defines the starting source of data.
3605
+ # @return [Array<Types::SourceSegment>]
3606
+ #
3607
+ # @!attribute [rw] source_type
3608
+ # Defines how to interact with the source data.
3609
+ # @return [String]
3610
+ #
3611
+ # @!attribute [rw] type
3612
+ # Defines how to interact with the profiles found in the current
3613
+ # filtering.
3614
+ # @return [String]
3615
+ #
3616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Group AWS API Documentation
3617
+ #
3618
+ class Group < Struct.new(
3619
+ :dimensions,
3620
+ :source_segments,
3621
+ :source_type,
3622
+ :type)
3623
+ SENSITIVE = []
3624
+ include Aws::Structure
3625
+ end
3626
+
2716
3627
  # Information about the Identity Resolution Job.
2717
3628
  #
2718
3629
  # @!attribute [rw] domain_name
@@ -3298,40 +4209,103 @@ module Aws::CustomerProfiles
3298
4209
  # @return [String]
3299
4210
  #
3300
4211
  # @!attribute [rw] next_token
3301
- # The pagination token from the previous ListIntegrations API call.
4212
+ # The pagination token from the previous ListIntegrations API call.
4213
+ # @return [String]
4214
+ #
4215
+ # @!attribute [rw] max_results
4216
+ # The maximum number of objects returned per page.
4217
+ # @return [Integer]
4218
+ #
4219
+ # @!attribute [rw] include_hidden
4220
+ # Boolean to indicate if hidden integration should be returned.
4221
+ # Defaults to `False`.
4222
+ # @return [Boolean]
4223
+ #
4224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsRequest AWS API Documentation
4225
+ #
4226
+ class ListIntegrationsRequest < Struct.new(
4227
+ :domain_name,
4228
+ :next_token,
4229
+ :max_results,
4230
+ :include_hidden)
4231
+ SENSITIVE = []
4232
+ include Aws::Structure
4233
+ end
4234
+
4235
+ # @!attribute [rw] items
4236
+ # The list of ListIntegrations instances.
4237
+ # @return [Array<Types::ListIntegrationItem>]
4238
+ #
4239
+ # @!attribute [rw] next_token
4240
+ # The pagination token from the previous ListIntegrations API call.
4241
+ # @return [String]
4242
+ #
4243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsResponse AWS API Documentation
4244
+ #
4245
+ class ListIntegrationsResponse < Struct.new(
4246
+ :items,
4247
+ :next_token)
4248
+ SENSITIVE = []
4249
+ include Aws::Structure
4250
+ end
4251
+
4252
+ # Item that contains the attribute and when it was last updated.
4253
+ #
4254
+ # @!attribute [rw] attribute_name
4255
+ # Name of the attribute.
4256
+ # @return [String]
4257
+ #
4258
+ # @!attribute [rw] last_updated_at
4259
+ # When the attribute was last updated.
4260
+ # @return [Time]
4261
+ #
4262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributeItem AWS API Documentation
4263
+ #
4264
+ class ListObjectTypeAttributeItem < Struct.new(
4265
+ :attribute_name,
4266
+ :last_updated_at)
4267
+ SENSITIVE = []
4268
+ include Aws::Structure
4269
+ end
4270
+
4271
+ # @!attribute [rw] next_token
4272
+ # The pagination token from the previous call.
3302
4273
  # @return [String]
3303
4274
  #
3304
4275
  # @!attribute [rw] max_results
3305
4276
  # The maximum number of objects returned per page.
3306
4277
  # @return [Integer]
3307
4278
  #
3308
- # @!attribute [rw] include_hidden
3309
- # Boolean to indicate if hidden integration should be returned.
3310
- # Defaults to `False`.
3311
- # @return [Boolean]
4279
+ # @!attribute [rw] domain_name
4280
+ # The unique identifier of the domain.
4281
+ # @return [String]
3312
4282
  #
3313
- # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsRequest AWS API Documentation
4283
+ # @!attribute [rw] object_type_name
4284
+ # The name of the profile object type.
4285
+ # @return [String]
3314
4286
  #
3315
- class ListIntegrationsRequest < Struct.new(
3316
- :domain_name,
4287
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributesRequest AWS API Documentation
4288
+ #
4289
+ class ListObjectTypeAttributesRequest < Struct.new(
3317
4290
  :next_token,
3318
4291
  :max_results,
3319
- :include_hidden)
4292
+ :domain_name,
4293
+ :object_type_name)
3320
4294
  SENSITIVE = []
3321
4295
  include Aws::Structure
3322
4296
  end
3323
4297
 
3324
4298
  # @!attribute [rw] items
3325
- # The list of ListIntegrations instances.
3326
- # @return [Array<Types::ListIntegrationItem>]
4299
+ # The items returned as part of the response.
4300
+ # @return [Array<Types::ListObjectTypeAttributeItem>]
3327
4301
  #
3328
4302
  # @!attribute [rw] next_token
3329
- # The pagination token from the previous ListIntegrations API call.
4303
+ # The pagination token from the previous call.
3330
4304
  # @return [String]
3331
4305
  #
3332
- # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListIntegrationsResponse AWS API Documentation
4306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListObjectTypeAttributesResponse AWS API Documentation
3333
4307
  #
3334
- class ListIntegrationsResponse < Struct.new(
4308
+ class ListObjectTypeAttributesResponse < Struct.new(
3335
4309
  :items,
3336
4310
  :next_token)
3337
4311
  SENSITIVE = []
@@ -3603,6 +4577,45 @@ module Aws::CustomerProfiles
3603
4577
  include Aws::Structure
3604
4578
  end
3605
4579
 
4580
+ # @!attribute [rw] domain_name
4581
+ # The unique identifier of the domain.
4582
+ # @return [String]
4583
+ #
4584
+ # @!attribute [rw] max_results
4585
+ # The maximum number of objects returned per page.
4586
+ # @return [Integer]
4587
+ #
4588
+ # @!attribute [rw] next_token
4589
+ # The pagination token from the previous call.
4590
+ # @return [String]
4591
+ #
4592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListSegmentDefinitionsRequest AWS API Documentation
4593
+ #
4594
+ class ListSegmentDefinitionsRequest < Struct.new(
4595
+ :domain_name,
4596
+ :max_results,
4597
+ :next_token)
4598
+ SENSITIVE = []
4599
+ include Aws::Structure
4600
+ end
4601
+
4602
+ # @!attribute [rw] next_token
4603
+ # The pagination token from the previous call.
4604
+ # @return [String]
4605
+ #
4606
+ # @!attribute [rw] items
4607
+ # List of segment definitions.
4608
+ # @return [Array<Types::SegmentDefinitionItem>]
4609
+ #
4610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListSegmentDefinitionsResponse AWS API Documentation
4611
+ #
4612
+ class ListSegmentDefinitionsResponse < Struct.new(
4613
+ :next_token,
4614
+ :items)
4615
+ SENSITIVE = []
4616
+ include Aws::Structure
4617
+ end
4618
+
3606
4619
  # @!attribute [rw] resource_arn
3607
4620
  # The ARN of the resource for which you want to view tags.
3608
4621
  # @return [String]
@@ -4176,6 +5189,235 @@ module Aws::CustomerProfiles
4176
5189
  include Aws::Structure
4177
5190
  end
4178
5191
 
5192
+ # @!attribute [rw] domain_name
5193
+ # The unique identifier of the domain.
5194
+ # @return [String]
5195
+ #
5196
+ # @!attribute [rw] attribute_name
5197
+ # The attribute name.
5198
+ # @return [String]
5199
+ #
5200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileAttributeValuesRequest AWS API Documentation
5201
+ #
5202
+ class ProfileAttributeValuesRequest < Struct.new(
5203
+ :domain_name,
5204
+ :attribute_name)
5205
+ SENSITIVE = []
5206
+ include Aws::Structure
5207
+ end
5208
+
5209
+ # @!attribute [rw] domain_name
5210
+ # The name of the domain.
5211
+ # @return [String]
5212
+ #
5213
+ # @!attribute [rw] attribute_name
5214
+ # The attribute name.
5215
+ # @return [String]
5216
+ #
5217
+ # @!attribute [rw] items
5218
+ # The items returned as part of the response.
5219
+ # @return [Array<Types::AttributeValueItem>]
5220
+ #
5221
+ # @!attribute [rw] status_code
5222
+ # The status code for the response.
5223
+ # @return [Integer]
5224
+ #
5225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileAttributeValuesResponse AWS API Documentation
5226
+ #
5227
+ class ProfileAttributeValuesResponse < Struct.new(
5228
+ :domain_name,
5229
+ :attribute_name,
5230
+ :items,
5231
+ :status_code)
5232
+ SENSITIVE = []
5233
+ include Aws::Structure
5234
+ end
5235
+
5236
+ # The object used to segment on attributes within the customer profile.
5237
+ #
5238
+ # @!attribute [rw] account_number
5239
+ # A field to describe values to segment on within account number.
5240
+ # @return [Types::ProfileDimension]
5241
+ #
5242
+ # @!attribute [rw] additional_information
5243
+ # A field to describe values to segment on within additional
5244
+ # information.
5245
+ # @return [Types::ExtraLengthValueProfileDimension]
5246
+ #
5247
+ # @!attribute [rw] first_name
5248
+ # A field to describe values to segment on within first name.
5249
+ # @return [Types::ProfileDimension]
5250
+ #
5251
+ # @!attribute [rw] last_name
5252
+ # A field to describe values to segment on within last name.
5253
+ # @return [Types::ProfileDimension]
5254
+ #
5255
+ # @!attribute [rw] middle_name
5256
+ # A field to describe values to segment on within middle name.
5257
+ # @return [Types::ProfileDimension]
5258
+ #
5259
+ # @!attribute [rw] gender_string
5260
+ # A field to describe values to segment on within genderString.
5261
+ # @return [Types::ProfileDimension]
5262
+ #
5263
+ # @!attribute [rw] party_type_string
5264
+ # A field to describe values to segment on within partyTypeString.
5265
+ # @return [Types::ProfileDimension]
5266
+ #
5267
+ # @!attribute [rw] birth_date
5268
+ # A field to describe values to segment on within birthDate.
5269
+ # @return [Types::DateDimension]
5270
+ #
5271
+ # @!attribute [rw] phone_number
5272
+ # A field to describe values to segment on within phone number.
5273
+ # @return [Types::ProfileDimension]
5274
+ #
5275
+ # @!attribute [rw] business_name
5276
+ # A field to describe values to segment on within business name.
5277
+ # @return [Types::ProfileDimension]
5278
+ #
5279
+ # @!attribute [rw] business_phone_number
5280
+ # A field to describe values to segment on within business phone
5281
+ # number.
5282
+ # @return [Types::ProfileDimension]
5283
+ #
5284
+ # @!attribute [rw] home_phone_number
5285
+ # A field to describe values to segment on within home phone number.
5286
+ # @return [Types::ProfileDimension]
5287
+ #
5288
+ # @!attribute [rw] mobile_phone_number
5289
+ # A field to describe values to segment on within mobile phone number.
5290
+ # @return [Types::ProfileDimension]
5291
+ #
5292
+ # @!attribute [rw] email_address
5293
+ # A field to describe values to segment on within email address.
5294
+ # @return [Types::ProfileDimension]
5295
+ #
5296
+ # @!attribute [rw] personal_email_address
5297
+ # A field to describe values to segment on within personal email
5298
+ # address.
5299
+ # @return [Types::ProfileDimension]
5300
+ #
5301
+ # @!attribute [rw] business_email_address
5302
+ # A field to describe values to segment on within business email
5303
+ # address.
5304
+ # @return [Types::ProfileDimension]
5305
+ #
5306
+ # @!attribute [rw] address
5307
+ # A field to describe values to segment on within address.
5308
+ # @return [Types::AddressDimension]
5309
+ #
5310
+ # @!attribute [rw] shipping_address
5311
+ # A field to describe values to segment on within shipping address.
5312
+ # @return [Types::AddressDimension]
5313
+ #
5314
+ # @!attribute [rw] mailing_address
5315
+ # A field to describe values to segment on within mailing address.
5316
+ # @return [Types::AddressDimension]
5317
+ #
5318
+ # @!attribute [rw] billing_address
5319
+ # A field to describe values to segment on within billing address.
5320
+ # @return [Types::AddressDimension]
5321
+ #
5322
+ # @!attribute [rw] attributes
5323
+ # A field to describe values to segment on within attributes.
5324
+ # @return [Hash<String,Types::AttributeDimension>]
5325
+ #
5326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileAttributes AWS API Documentation
5327
+ #
5328
+ class ProfileAttributes < Struct.new(
5329
+ :account_number,
5330
+ :additional_information,
5331
+ :first_name,
5332
+ :last_name,
5333
+ :middle_name,
5334
+ :gender_string,
5335
+ :party_type_string,
5336
+ :birth_date,
5337
+ :phone_number,
5338
+ :business_name,
5339
+ :business_phone_number,
5340
+ :home_phone_number,
5341
+ :mobile_phone_number,
5342
+ :email_address,
5343
+ :personal_email_address,
5344
+ :business_email_address,
5345
+ :address,
5346
+ :shipping_address,
5347
+ :mailing_address,
5348
+ :billing_address,
5349
+ :attributes)
5350
+ SENSITIVE = []
5351
+ include Aws::Structure
5352
+ end
5353
+
5354
+ # Object to hold the dimensions of a profile's fields to segment on.
5355
+ #
5356
+ # @!attribute [rw] dimension_type
5357
+ # The action to segment on.
5358
+ # @return [String]
5359
+ #
5360
+ # @!attribute [rw] values
5361
+ # The values to apply the DimensionType on.
5362
+ # @return [Array<String>]
5363
+ #
5364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileDimension AWS API Documentation
5365
+ #
5366
+ class ProfileDimension < Struct.new(
5367
+ :dimension_type,
5368
+ :values)
5369
+ SENSITIVE = []
5370
+ include Aws::Structure
5371
+ end
5372
+
5373
+ # Object that holds failures for membership.
5374
+ #
5375
+ # @!attribute [rw] profile_id
5376
+ # The profile id the failure belongs to.
5377
+ # @return [String]
5378
+ #
5379
+ # @!attribute [rw] message
5380
+ # A message describing the failure.
5381
+ # @return [String]
5382
+ #
5383
+ # @!attribute [rw] status
5384
+ # The status describing the failure.
5385
+ # @return [Integer]
5386
+ #
5387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileQueryFailures AWS API Documentation
5388
+ #
5389
+ class ProfileQueryFailures < Struct.new(
5390
+ :profile_id,
5391
+ :message,
5392
+ :status)
5393
+ SENSITIVE = []
5394
+ include Aws::Structure
5395
+ end
5396
+
5397
+ # Object that holds the results for membership.
5398
+ #
5399
+ # @!attribute [rw] profile_id
5400
+ # The profile id the result belongs to.
5401
+ # @return [String]
5402
+ #
5403
+ # @!attribute [rw] query_result
5404
+ # Describes whether the profile was absent or present in the segment.
5405
+ # @return [String]
5406
+ #
5407
+ # @!attribute [rw] profile
5408
+ # The standard profile of a customer.
5409
+ # @return [Types::Profile]
5410
+ #
5411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ProfileQueryResult AWS API Documentation
5412
+ #
5413
+ class ProfileQueryResult < Struct.new(
5414
+ :profile_id,
5415
+ :query_result,
5416
+ :profile)
5417
+ SENSITIVE = []
5418
+ include Aws::Structure
5419
+ end
5420
+
4179
5421
  # @!attribute [rw] domain_name
4180
5422
  # The unique name of the domain.
4181
5423
  # @return [String]
@@ -4522,6 +5764,30 @@ module Aws::CustomerProfiles
4522
5764
  include Aws::Structure
4523
5765
  end
4524
5766
 
5767
+ # Overrides the original range on a calculated attribute definition.
5768
+ #
5769
+ # @!attribute [rw] start
5770
+ # The start time of when to include objects.
5771
+ # @return [Integer]
5772
+ #
5773
+ # @!attribute [rw] end
5774
+ # The end time of when to include objects.
5775
+ # @return [Integer]
5776
+ #
5777
+ # @!attribute [rw] unit
5778
+ # The unit for start and end.
5779
+ # @return [String]
5780
+ #
5781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RangeOverride AWS API Documentation
5782
+ #
5783
+ class RangeOverride < Struct.new(
5784
+ :start,
5785
+ :end,
5786
+ :unit)
5787
+ SENSITIVE = []
5788
+ include Aws::Structure
5789
+ end
5790
+
4525
5791
  # The requested resource does not exist, or access was denied.
4526
5792
  #
4527
5793
  # @!attribute [rw] message
@@ -4922,6 +6188,85 @@ module Aws::CustomerProfiles
4922
6188
  include Aws::Structure
4923
6189
  end
4924
6190
 
6191
+ # Object holding the segment definition fields.
6192
+ #
6193
+ # @!attribute [rw] segment_definition_name
6194
+ # Name of the segment definition.
6195
+ # @return [String]
6196
+ #
6197
+ # @!attribute [rw] display_name
6198
+ # Display name of the segment definition.
6199
+ # @return [String]
6200
+ #
6201
+ # @!attribute [rw] description
6202
+ # The description of the segment definition.
6203
+ # @return [String]
6204
+ #
6205
+ # @!attribute [rw] segment_definition_arn
6206
+ # The arn of the segment definition.
6207
+ # @return [String]
6208
+ #
6209
+ # @!attribute [rw] created_at
6210
+ # When the segment definition was created.
6211
+ # @return [Time]
6212
+ #
6213
+ # @!attribute [rw] tags
6214
+ # The tags belonging to the segment definition.
6215
+ # @return [Hash<String,String>]
6216
+ #
6217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SegmentDefinitionItem AWS API Documentation
6218
+ #
6219
+ class SegmentDefinitionItem < Struct.new(
6220
+ :segment_definition_name,
6221
+ :display_name,
6222
+ :description,
6223
+ :segment_definition_arn,
6224
+ :created_at,
6225
+ :tags)
6226
+ SENSITIVE = [:description]
6227
+ include Aws::Structure
6228
+ end
6229
+
6230
+ # Contains all groups of the segment definition.
6231
+ #
6232
+ # @!attribute [rw] groups
6233
+ # Holds the list of groups within the segment definition.
6234
+ # @return [Array<Types::Group>]
6235
+ #
6236
+ # @!attribute [rw] include
6237
+ # Defines whether to include or exclude the profiles that fit the
6238
+ # segment criteria.
6239
+ # @return [String]
6240
+ #
6241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SegmentGroup AWS API Documentation
6242
+ #
6243
+ class SegmentGroup < Struct.new(
6244
+ :groups,
6245
+ :include)
6246
+ SENSITIVE = []
6247
+ include Aws::Structure
6248
+ end
6249
+
6250
+ # Contains all groups of the segment definition.
6251
+ #
6252
+ # @!attribute [rw] groups
6253
+ # Holds the list of groups within the segment definition.
6254
+ # @return [Array<Types::Group>]
6255
+ #
6256
+ # @!attribute [rw] include
6257
+ # Define whether to include or exclude the profiles that fit the
6258
+ # segment criteria.
6259
+ # @return [String]
6260
+ #
6261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SegmentGroupStructure AWS API Documentation
6262
+ #
6263
+ class SegmentGroupStructure < Struct.new(
6264
+ :groups,
6265
+ :include)
6266
+ SENSITIVE = []
6267
+ include Aws::Structure
6268
+ end
6269
+
4925
6270
  # The properties that are applied when ServiceNow is being used as a
4926
6271
  # source.
4927
6272
  #
@@ -5011,6 +6356,20 @@ module Aws::CustomerProfiles
5011
6356
  include Aws::Structure
5012
6357
  end
5013
6358
 
6359
+ # The source segments to build off of.
6360
+ #
6361
+ # @!attribute [rw] segment_definition_name
6362
+ # The unique name of the segment definition.
6363
+ # @return [String]
6364
+ #
6365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SourceSegment AWS API Documentation
6366
+ #
6367
+ class SourceSegment < Struct.new(
6368
+ :segment_definition_name)
6369
+ SENSITIVE = []
6370
+ include Aws::Structure
6371
+ end
6372
+
5014
6373
  # @!attribute [rw] resource_arn
5015
6374
  # The ARN of the resource that you're adding tags to.
5016
6375
  # @return [String]