aws-sdk-customerprofiles 1.27.0 → 1.29.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +422 -5
- data/lib/aws-sdk-customerprofiles/client_api.rb +252 -0
- data/lib/aws-sdk-customerprofiles/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-customerprofiles/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-customerprofiles/endpoints.rb +98 -0
- data/lib/aws-sdk-customerprofiles/plugins/endpoints.rb +14 -0
- data/lib/aws-sdk-customerprofiles/types.rb +632 -32
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- metadata +4 -4
@@ -291,6 +291,44 @@ module Aws::CustomerProfiles
|
|
291
291
|
include Aws::Structure
|
292
292
|
end
|
293
293
|
|
294
|
+
# Mathematical expression and a list of attribute items specified in
|
295
|
+
# that expression.
|
296
|
+
#
|
297
|
+
# @!attribute [rw] attributes
|
298
|
+
# A list of attribute items specified in the mathematical expression.
|
299
|
+
# @return [Array<Types::AttributeItem>]
|
300
|
+
#
|
301
|
+
# @!attribute [rw] expression
|
302
|
+
# Mathematical expression that is performed on attribute items
|
303
|
+
# provided in the attribute list. Each element in the expression
|
304
|
+
# should follow the structure of
|
305
|
+
# \\"\\\{ObjectTypeName.AttributeName\\}\\".
|
306
|
+
# @return [String]
|
307
|
+
#
|
308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AttributeDetails AWS API Documentation
|
309
|
+
#
|
310
|
+
class AttributeDetails < Struct.new(
|
311
|
+
:attributes,
|
312
|
+
:expression)
|
313
|
+
SENSITIVE = []
|
314
|
+
include Aws::Structure
|
315
|
+
end
|
316
|
+
|
317
|
+
# The details of a single attribute item specified in the mathematical
|
318
|
+
# expression.
|
319
|
+
#
|
320
|
+
# @!attribute [rw] name
|
321
|
+
# The name of an attribute defined in a profile object type.
|
322
|
+
# @return [String]
|
323
|
+
#
|
324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AttributeItem AWS API Documentation
|
325
|
+
#
|
326
|
+
class AttributeItem < Struct.new(
|
327
|
+
:name)
|
328
|
+
SENSITIVE = []
|
329
|
+
include Aws::Structure
|
330
|
+
end
|
331
|
+
|
294
332
|
# Configuration settings for how to perform the auto-merging of
|
295
333
|
# profiles.
|
296
334
|
#
|
@@ -363,6 +401,32 @@ module Aws::CustomerProfiles
|
|
363
401
|
include Aws::Structure
|
364
402
|
end
|
365
403
|
|
404
|
+
# The conditions including range, object count, and threshold for the
|
405
|
+
# calculated attribute.
|
406
|
+
#
|
407
|
+
# @!attribute [rw] range
|
408
|
+
# The relative time period over which data is included in the
|
409
|
+
# aggregation.
|
410
|
+
# @return [Types::Range]
|
411
|
+
#
|
412
|
+
# @!attribute [rw] object_count
|
413
|
+
# The number of profile objects used for the calculated attribute.
|
414
|
+
# @return [Integer]
|
415
|
+
#
|
416
|
+
# @!attribute [rw] threshold
|
417
|
+
# The threshold for the calculated attribute.
|
418
|
+
# @return [Types::Threshold]
|
419
|
+
#
|
420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Conditions AWS API Documentation
|
421
|
+
#
|
422
|
+
class Conditions < Struct.new(
|
423
|
+
:range,
|
424
|
+
:object_count,
|
425
|
+
:threshold)
|
426
|
+
SENSITIVE = []
|
427
|
+
include Aws::Structure
|
428
|
+
end
|
429
|
+
|
366
430
|
# How the auto-merging process should resolve conflicts between
|
367
431
|
# different profiles.
|
368
432
|
#
|
@@ -370,9 +434,9 @@ module Aws::CustomerProfiles
|
|
370
434
|
# How the auto-merging process should resolve conflicts between
|
371
435
|
# different profiles.
|
372
436
|
#
|
373
|
-
# * `RECENCY
|
437
|
+
# * `RECENCY`: Uses the data that was most recently updated.
|
374
438
|
#
|
375
|
-
# * `SOURCE
|
439
|
+
# * `SOURCE`: Uses the data from a specific source. For example, if a
|
376
440
|
# company has been aquired or two departments have merged, data from
|
377
441
|
# the specified source is used. If two duplicate profiles are from
|
378
442
|
# the same source, then `RECENCY` is used again.
|
@@ -443,6 +507,113 @@ module Aws::CustomerProfiles
|
|
443
507
|
include Aws::Structure
|
444
508
|
end
|
445
509
|
|
510
|
+
# @!attribute [rw] domain_name
|
511
|
+
# The unique name of the domain.
|
512
|
+
# @return [String]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] calculated_attribute_name
|
515
|
+
# The unique name of the calculated attribute.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @!attribute [rw] display_name
|
519
|
+
# The display name of the calculated attribute.
|
520
|
+
# @return [String]
|
521
|
+
#
|
522
|
+
# @!attribute [rw] description
|
523
|
+
# The description of the calculated attribute.
|
524
|
+
# @return [String]
|
525
|
+
#
|
526
|
+
# @!attribute [rw] attribute_details
|
527
|
+
# Mathematical expression and a list of attribute items specified in
|
528
|
+
# that expression.
|
529
|
+
# @return [Types::AttributeDetails]
|
530
|
+
#
|
531
|
+
# @!attribute [rw] conditions
|
532
|
+
# The conditions including range, object count, and threshold for the
|
533
|
+
# calculated attribute.
|
534
|
+
# @return [Types::Conditions]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] statistic
|
537
|
+
# The aggregation operation to perform for the calculated attribute.
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] tags
|
541
|
+
# The tags used to organize, track, or control access for this
|
542
|
+
# resource.
|
543
|
+
# @return [Hash<String,String>]
|
544
|
+
#
|
545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinitionRequest AWS API Documentation
|
546
|
+
#
|
547
|
+
class CreateCalculatedAttributeDefinitionRequest < Struct.new(
|
548
|
+
:domain_name,
|
549
|
+
:calculated_attribute_name,
|
550
|
+
:display_name,
|
551
|
+
:description,
|
552
|
+
:attribute_details,
|
553
|
+
:conditions,
|
554
|
+
:statistic,
|
555
|
+
:tags)
|
556
|
+
SENSITIVE = []
|
557
|
+
include Aws::Structure
|
558
|
+
end
|
559
|
+
|
560
|
+
# @!attribute [rw] calculated_attribute_name
|
561
|
+
# The unique name of the calculated attribute.
|
562
|
+
# @return [String]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] display_name
|
565
|
+
# The display name of the calculated attribute.
|
566
|
+
# @return [String]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] description
|
569
|
+
# The description of the calculated attribute.
|
570
|
+
# @return [String]
|
571
|
+
#
|
572
|
+
# @!attribute [rw] attribute_details
|
573
|
+
# Mathematical expression and a list of attribute items specified in
|
574
|
+
# that expression.
|
575
|
+
# @return [Types::AttributeDetails]
|
576
|
+
#
|
577
|
+
# @!attribute [rw] conditions
|
578
|
+
# The conditions including range, object count, and threshold for the
|
579
|
+
# calculated attribute.
|
580
|
+
# @return [Types::Conditions]
|
581
|
+
#
|
582
|
+
# @!attribute [rw] statistic
|
583
|
+
# The aggregation operation to perform for the calculated attribute.
|
584
|
+
# @return [String]
|
585
|
+
#
|
586
|
+
# @!attribute [rw] created_at
|
587
|
+
# The timestamp of when the calculated attribute definition was
|
588
|
+
# created.
|
589
|
+
# @return [Time]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] last_updated_at
|
592
|
+
# The timestamp of when the calculated attribute definition was most
|
593
|
+
# recently edited.
|
594
|
+
# @return [Time]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] tags
|
597
|
+
# The tags used to organize, track, or control access for this
|
598
|
+
# resource.
|
599
|
+
# @return [Hash<String,String>]
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinitionResponse AWS API Documentation
|
602
|
+
#
|
603
|
+
class CreateCalculatedAttributeDefinitionResponse < Struct.new(
|
604
|
+
:calculated_attribute_name,
|
605
|
+
:display_name,
|
606
|
+
:description,
|
607
|
+
:attribute_details,
|
608
|
+
:conditions,
|
609
|
+
:statistic,
|
610
|
+
:created_at,
|
611
|
+
:last_updated_at,
|
612
|
+
:tags)
|
613
|
+
SENSITIVE = []
|
614
|
+
include Aws::Structure
|
615
|
+
end
|
616
|
+
|
446
617
|
# @!attribute [rw] domain_name
|
447
618
|
# The unique name of the domain.
|
448
619
|
# @return [String]
|
@@ -766,6 +937,27 @@ module Aws::CustomerProfiles
|
|
766
937
|
include Aws::Structure
|
767
938
|
end
|
768
939
|
|
940
|
+
# @!attribute [rw] domain_name
|
941
|
+
# The unique name of the domain.
|
942
|
+
# @return [String]
|
943
|
+
#
|
944
|
+
# @!attribute [rw] calculated_attribute_name
|
945
|
+
# The unique name of the calculated attribute.
|
946
|
+
# @return [String]
|
947
|
+
#
|
948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinitionRequest AWS API Documentation
|
949
|
+
#
|
950
|
+
class DeleteCalculatedAttributeDefinitionRequest < Struct.new(
|
951
|
+
:domain_name,
|
952
|
+
:calculated_attribute_name)
|
953
|
+
SENSITIVE = []
|
954
|
+
include Aws::Structure
|
955
|
+
end
|
956
|
+
|
957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinitionResponse AWS API Documentation
|
958
|
+
#
|
959
|
+
class DeleteCalculatedAttributeDefinitionResponse < Aws::EmptyStructure; end
|
960
|
+
|
769
961
|
# @!attribute [rw] domain_name
|
770
962
|
# The unique name of the domain.
|
771
963
|
# @return [String]
|
@@ -1295,6 +1487,130 @@ module Aws::CustomerProfiles
|
|
1295
1487
|
include Aws::Structure
|
1296
1488
|
end
|
1297
1489
|
|
1490
|
+
# @!attribute [rw] domain_name
|
1491
|
+
# The unique name of the domain.
|
1492
|
+
# @return [String]
|
1493
|
+
#
|
1494
|
+
# @!attribute [rw] calculated_attribute_name
|
1495
|
+
# The unique name of the calculated attribute.
|
1496
|
+
# @return [String]
|
1497
|
+
#
|
1498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeDefinitionRequest AWS API Documentation
|
1499
|
+
#
|
1500
|
+
class GetCalculatedAttributeDefinitionRequest < Struct.new(
|
1501
|
+
:domain_name,
|
1502
|
+
:calculated_attribute_name)
|
1503
|
+
SENSITIVE = []
|
1504
|
+
include Aws::Structure
|
1505
|
+
end
|
1506
|
+
|
1507
|
+
# @!attribute [rw] calculated_attribute_name
|
1508
|
+
# The unique name of the calculated attribute.
|
1509
|
+
# @return [String]
|
1510
|
+
#
|
1511
|
+
# @!attribute [rw] display_name
|
1512
|
+
# The display name of the calculated attribute.
|
1513
|
+
# @return [String]
|
1514
|
+
#
|
1515
|
+
# @!attribute [rw] description
|
1516
|
+
# The description of the calculated attribute.
|
1517
|
+
# @return [String]
|
1518
|
+
#
|
1519
|
+
# @!attribute [rw] created_at
|
1520
|
+
# The timestamp of when the calculated attribute definition was
|
1521
|
+
# created.
|
1522
|
+
# @return [Time]
|
1523
|
+
#
|
1524
|
+
# @!attribute [rw] last_updated_at
|
1525
|
+
# The timestamp of when the calculated attribute definition was most
|
1526
|
+
# recently edited.
|
1527
|
+
# @return [Time]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] statistic
|
1530
|
+
# The aggregation operation to perform for the calculated attribute.
|
1531
|
+
# @return [String]
|
1532
|
+
#
|
1533
|
+
# @!attribute [rw] conditions
|
1534
|
+
# The conditions including range, object count, and threshold for the
|
1535
|
+
# calculated attribute.
|
1536
|
+
# @return [Types::Conditions]
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] attribute_details
|
1539
|
+
# Mathematical expression and a list of attribute items specified in
|
1540
|
+
# that expression.
|
1541
|
+
# @return [Types::AttributeDetails]
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] tags
|
1544
|
+
# The tags used to organize, track, or control access for this
|
1545
|
+
# resource.
|
1546
|
+
# @return [Hash<String,String>]
|
1547
|
+
#
|
1548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeDefinitionResponse AWS API Documentation
|
1549
|
+
#
|
1550
|
+
class GetCalculatedAttributeDefinitionResponse < Struct.new(
|
1551
|
+
:calculated_attribute_name,
|
1552
|
+
:display_name,
|
1553
|
+
:description,
|
1554
|
+
:created_at,
|
1555
|
+
:last_updated_at,
|
1556
|
+
:statistic,
|
1557
|
+
:conditions,
|
1558
|
+
:attribute_details,
|
1559
|
+
:tags)
|
1560
|
+
SENSITIVE = []
|
1561
|
+
include Aws::Structure
|
1562
|
+
end
|
1563
|
+
|
1564
|
+
# @!attribute [rw] domain_name
|
1565
|
+
# The unique name of the domain.
|
1566
|
+
# @return [String]
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] profile_id
|
1569
|
+
# The unique identifier of a customer profile.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] calculated_attribute_name
|
1573
|
+
# The unique name of the calculated attribute.
|
1574
|
+
# @return [String]
|
1575
|
+
#
|
1576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeForProfileRequest AWS API Documentation
|
1577
|
+
#
|
1578
|
+
class GetCalculatedAttributeForProfileRequest < Struct.new(
|
1579
|
+
:domain_name,
|
1580
|
+
:profile_id,
|
1581
|
+
:calculated_attribute_name)
|
1582
|
+
SENSITIVE = []
|
1583
|
+
include Aws::Structure
|
1584
|
+
end
|
1585
|
+
|
1586
|
+
# @!attribute [rw] calculated_attribute_name
|
1587
|
+
# The unique name of the calculated attribute.
|
1588
|
+
# @return [String]
|
1589
|
+
#
|
1590
|
+
# @!attribute [rw] display_name
|
1591
|
+
# The display name of the calculated attribute.
|
1592
|
+
# @return [String]
|
1593
|
+
#
|
1594
|
+
# @!attribute [rw] is_data_partial
|
1595
|
+
# Indicates whether the calculated attribute’s value is based on
|
1596
|
+
# partial data. If data is partial, it is set to true.
|
1597
|
+
# @return [String]
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] value
|
1600
|
+
# The value of the calculated attribute.
|
1601
|
+
# @return [String]
|
1602
|
+
#
|
1603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeForProfileResponse AWS API Documentation
|
1604
|
+
#
|
1605
|
+
class GetCalculatedAttributeForProfileResponse < Struct.new(
|
1606
|
+
:calculated_attribute_name,
|
1607
|
+
:display_name,
|
1608
|
+
:is_data_partial,
|
1609
|
+
:value)
|
1610
|
+
SENSITIVE = []
|
1611
|
+
include Aws::Structure
|
1612
|
+
end
|
1613
|
+
|
1298
1614
|
# @!attribute [rw] domain_name
|
1299
1615
|
# The unique name of the domain.
|
1300
1616
|
# @return [String]
|
@@ -1405,27 +1721,26 @@ module Aws::CustomerProfiles
|
|
1405
1721
|
# @!attribute [rw] status
|
1406
1722
|
# The status of the Identity Resolution Job.
|
1407
1723
|
#
|
1408
|
-
# * `PENDING
|
1724
|
+
# * `PENDING`: The Identity Resolution Job is scheduled but has not
|
1409
1725
|
# started yet. If you turn off the Identity Resolution feature in
|
1410
1726
|
# your domain, jobs in the `PENDING` state are deleted.
|
1411
1727
|
#
|
1412
|
-
# * `PREPROCESSING
|
1413
|
-
# data.
|
1728
|
+
# * `PREPROCESSING`: The Identity Resolution Job is loading your data.
|
1414
1729
|
#
|
1415
|
-
# * `FIND_MATCHING
|
1730
|
+
# * `FIND_MATCHING`: The Identity Resolution Job is using the machine
|
1416
1731
|
# learning model to identify profiles that belong to the same
|
1417
1732
|
# matching group.
|
1418
1733
|
#
|
1419
|
-
# * `MERGING
|
1734
|
+
# * `MERGING`: The Identity Resolution Job is merging duplicate
|
1420
1735
|
# profiles.
|
1421
1736
|
#
|
1422
|
-
# * `COMPLETED
|
1737
|
+
# * `COMPLETED`: The Identity Resolution Job completed successfully.
|
1423
1738
|
#
|
1424
|
-
# * `PARTIAL_SUCCESS
|
1425
|
-
#
|
1426
|
-
#
|
1739
|
+
# * `PARTIAL_SUCCESS`: There's a system error and not all of the data
|
1740
|
+
# is merged. The Identity Resolution Job writes a message indicating
|
1741
|
+
# the source of the problem.
|
1427
1742
|
#
|
1428
|
-
# * `FAILED
|
1743
|
+
# * `FAILED`: The Identity Resolution Job did not merge any data. It
|
1429
1744
|
# writes a message indicating the source of the problem.
|
1430
1745
|
# @return [String]
|
1431
1746
|
#
|
@@ -1902,27 +2217,26 @@ module Aws::CustomerProfiles
|
|
1902
2217
|
# @!attribute [rw] status
|
1903
2218
|
# The status of the Identity Resolution Job.
|
1904
2219
|
#
|
1905
|
-
# * `PENDING
|
2220
|
+
# * `PENDING`: The Identity Resolution Job is scheduled but has not
|
1906
2221
|
# started yet. If you turn off the Identity Resolution feature in
|
1907
2222
|
# your domain, jobs in the `PENDING` state are deleted.
|
1908
2223
|
#
|
1909
|
-
# * `PREPROCESSING
|
1910
|
-
# data.
|
2224
|
+
# * `PREPROCESSING`: The Identity Resolution Job is loading your data.
|
1911
2225
|
#
|
1912
|
-
# * `FIND_MATCHING
|
2226
|
+
# * `FIND_MATCHING`: The Identity Resolution Job is using the machine
|
1913
2227
|
# learning model to identify profiles that belong to the same
|
1914
2228
|
# matching group.
|
1915
2229
|
#
|
1916
|
-
# * `MERGING
|
2230
|
+
# * `MERGING`: The Identity Resolution Job is merging duplicate
|
1917
2231
|
# profiles.
|
1918
2232
|
#
|
1919
|
-
# * `COMPLETED
|
2233
|
+
# * `COMPLETED`: The Identity Resolution Job completed successfully.
|
1920
2234
|
#
|
1921
|
-
# * `PARTIAL_SUCCESS
|
1922
|
-
#
|
1923
|
-
#
|
2235
|
+
# * `PARTIAL_SUCCESS`: There's a system error and not all of the data
|
2236
|
+
# is merged. The Identity Resolution Job writes a message indicating
|
2237
|
+
# the source of the problem.
|
1924
2238
|
#
|
1925
|
-
# * `FAILED
|
2239
|
+
# * `FAILED`: The Identity Resolution Job did not merge any data. It
|
1926
2240
|
# writes a message indicating the source of the problem.
|
1927
2241
|
# @return [String]
|
1928
2242
|
#
|
@@ -2097,6 +2411,165 @@ module Aws::CustomerProfiles
|
|
2097
2411
|
include Aws::Structure
|
2098
2412
|
end
|
2099
2413
|
|
2414
|
+
# The details of a single calculated attribute definition.
|
2415
|
+
#
|
2416
|
+
# @!attribute [rw] calculated_attribute_name
|
2417
|
+
# The unique name of the calculated attribute.
|
2418
|
+
# @return [String]
|
2419
|
+
#
|
2420
|
+
# @!attribute [rw] display_name
|
2421
|
+
# The display name of the calculated attribute.
|
2422
|
+
# @return [String]
|
2423
|
+
#
|
2424
|
+
# @!attribute [rw] description
|
2425
|
+
# The threshold for the calculated attribute.
|
2426
|
+
# @return [String]
|
2427
|
+
#
|
2428
|
+
# @!attribute [rw] created_at
|
2429
|
+
# The threshold for the calculated attribute.
|
2430
|
+
# @return [Time]
|
2431
|
+
#
|
2432
|
+
# @!attribute [rw] last_updated_at
|
2433
|
+
# The timestamp of when the calculated attribute definition was most
|
2434
|
+
# recently edited.
|
2435
|
+
# @return [Time]
|
2436
|
+
#
|
2437
|
+
# @!attribute [rw] tags
|
2438
|
+
# The tags used to organize, track, or control access for this
|
2439
|
+
# resource.
|
2440
|
+
# @return [Hash<String,String>]
|
2441
|
+
#
|
2442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitionItem AWS API Documentation
|
2443
|
+
#
|
2444
|
+
class ListCalculatedAttributeDefinitionItem < Struct.new(
|
2445
|
+
:calculated_attribute_name,
|
2446
|
+
:display_name,
|
2447
|
+
:description,
|
2448
|
+
:created_at,
|
2449
|
+
:last_updated_at,
|
2450
|
+
:tags)
|
2451
|
+
SENSITIVE = []
|
2452
|
+
include Aws::Structure
|
2453
|
+
end
|
2454
|
+
|
2455
|
+
# @!attribute [rw] domain_name
|
2456
|
+
# The unique name of the domain.
|
2457
|
+
# @return [String]
|
2458
|
+
#
|
2459
|
+
# @!attribute [rw] next_token
|
2460
|
+
# The pagination token from the previous call to
|
2461
|
+
# ListCalculatedAttributeDefinitions.
|
2462
|
+
# @return [String]
|
2463
|
+
#
|
2464
|
+
# @!attribute [rw] max_results
|
2465
|
+
# The maximum number of calculated attribute definitions returned per
|
2466
|
+
# page.
|
2467
|
+
# @return [Integer]
|
2468
|
+
#
|
2469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitionsRequest AWS API Documentation
|
2470
|
+
#
|
2471
|
+
class ListCalculatedAttributeDefinitionsRequest < Struct.new(
|
2472
|
+
:domain_name,
|
2473
|
+
:next_token,
|
2474
|
+
:max_results)
|
2475
|
+
SENSITIVE = []
|
2476
|
+
include Aws::Structure
|
2477
|
+
end
|
2478
|
+
|
2479
|
+
# @!attribute [rw] items
|
2480
|
+
# The list of calculated attribute definitions.
|
2481
|
+
# @return [Array<Types::ListCalculatedAttributeDefinitionItem>]
|
2482
|
+
#
|
2483
|
+
# @!attribute [rw] next_token
|
2484
|
+
# The pagination token from the previous call to
|
2485
|
+
# ListCalculatedAttributeDefinitions.
|
2486
|
+
# @return [String]
|
2487
|
+
#
|
2488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitionsResponse AWS API Documentation
|
2489
|
+
#
|
2490
|
+
class ListCalculatedAttributeDefinitionsResponse < Struct.new(
|
2491
|
+
:items,
|
2492
|
+
:next_token)
|
2493
|
+
SENSITIVE = []
|
2494
|
+
include Aws::Structure
|
2495
|
+
end
|
2496
|
+
|
2497
|
+
# The details of a single calculated attribute for a profile.
|
2498
|
+
#
|
2499
|
+
# @!attribute [rw] calculated_attribute_name
|
2500
|
+
# The unique name of the calculated attribute.
|
2501
|
+
# @return [String]
|
2502
|
+
#
|
2503
|
+
# @!attribute [rw] display_name
|
2504
|
+
# The display name of the calculated attribute.
|
2505
|
+
# @return [String]
|
2506
|
+
#
|
2507
|
+
# @!attribute [rw] is_data_partial
|
2508
|
+
# Indicates whether the calculated attribute’s value is based on
|
2509
|
+
# partial data. If data is partial, it is set to true.
|
2510
|
+
# @return [String]
|
2511
|
+
#
|
2512
|
+
# @!attribute [rw] value
|
2513
|
+
# The value of the calculated attribute.
|
2514
|
+
# @return [String]
|
2515
|
+
#
|
2516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeForProfileItem AWS API Documentation
|
2517
|
+
#
|
2518
|
+
class ListCalculatedAttributeForProfileItem < Struct.new(
|
2519
|
+
:calculated_attribute_name,
|
2520
|
+
:display_name,
|
2521
|
+
:is_data_partial,
|
2522
|
+
:value)
|
2523
|
+
SENSITIVE = []
|
2524
|
+
include Aws::Structure
|
2525
|
+
end
|
2526
|
+
|
2527
|
+
# @!attribute [rw] next_token
|
2528
|
+
# The pagination token from the previous call to
|
2529
|
+
# ListCalculatedAttributesForProfile.
|
2530
|
+
# @return [String]
|
2531
|
+
#
|
2532
|
+
# @!attribute [rw] max_results
|
2533
|
+
# The maximum number of calculated attributes returned per page.
|
2534
|
+
# @return [Integer]
|
2535
|
+
#
|
2536
|
+
# @!attribute [rw] domain_name
|
2537
|
+
# The unique name of the domain.
|
2538
|
+
# @return [String]
|
2539
|
+
#
|
2540
|
+
# @!attribute [rw] profile_id
|
2541
|
+
# The unique identifier of a customer profile.
|
2542
|
+
# @return [String]
|
2543
|
+
#
|
2544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributesForProfileRequest AWS API Documentation
|
2545
|
+
#
|
2546
|
+
class ListCalculatedAttributesForProfileRequest < Struct.new(
|
2547
|
+
:next_token,
|
2548
|
+
:max_results,
|
2549
|
+
:domain_name,
|
2550
|
+
:profile_id)
|
2551
|
+
SENSITIVE = []
|
2552
|
+
include Aws::Structure
|
2553
|
+
end
|
2554
|
+
|
2555
|
+
# @!attribute [rw] items
|
2556
|
+
# The list of calculated attributes.
|
2557
|
+
# @return [Array<Types::ListCalculatedAttributeForProfileItem>]
|
2558
|
+
#
|
2559
|
+
# @!attribute [rw] next_token
|
2560
|
+
# The pagination token from the previous call to
|
2561
|
+
# ListCalculatedAttributesForProfile.
|
2562
|
+
# @return [String]
|
2563
|
+
#
|
2564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributesForProfileResponse AWS API Documentation
|
2565
|
+
#
|
2566
|
+
class ListCalculatedAttributesForProfileResponse < Struct.new(
|
2567
|
+
:items,
|
2568
|
+
:next_token)
|
2569
|
+
SENSITIVE = []
|
2570
|
+
include Aws::Structure
|
2571
|
+
end
|
2572
|
+
|
2100
2573
|
# An object in a list that represents a domain.
|
2101
2574
|
#
|
2102
2575
|
# @!attribute [rw] domain_name
|
@@ -2492,8 +2965,7 @@ module Aws::CustomerProfiles
|
|
2492
2965
|
#
|
2493
2966
|
# @!attribute [rw] object_filter
|
2494
2967
|
# Applies a filter to the response to include profile objects with the
|
2495
|
-
# specified index values.
|
2496
|
-
# ObjectTypeName \_asset, \_case and \_order.
|
2968
|
+
# specified index values.
|
2497
2969
|
# @return [Types::ObjectFilter]
|
2498
2970
|
#
|
2499
2971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectsRequest AWS API Documentation
|
@@ -2805,16 +3277,15 @@ module Aws::CustomerProfiles
|
|
2805
3277
|
include Aws::Structure
|
2806
3278
|
end
|
2807
3279
|
|
2808
|
-
# The filter applied to ListProfileObjects response to include profile
|
2809
|
-
# objects with the specified index values.
|
2810
|
-
# for ObjectTypeName \_asset, \_case and \_order.
|
3280
|
+
# The filter applied to `ListProfileObjects` response to include profile
|
3281
|
+
# objects with the specified index values.
|
2811
3282
|
#
|
2812
3283
|
# @!attribute [rw] key_name
|
2813
|
-
# A searchable identifier of a
|
2814
|
-
#
|
2815
|
-
#
|
2816
|
-
#
|
2817
|
-
#
|
3284
|
+
# A searchable identifier of a profile object. The predefined keys you
|
3285
|
+
# can use to search for `_asset` include: `_assetId`, `_assetName`,
|
3286
|
+
# and `_serialNumber`. The predefined keys you can use to search for
|
3287
|
+
# `_case` include: `_caseId`. The predefined keys you can use to
|
3288
|
+
# search for `_order` include: `_orderId`.
|
2818
3289
|
# @return [String]
|
2819
3290
|
#
|
2820
3291
|
# @!attribute [rw] values
|
@@ -3348,6 +3819,26 @@ module Aws::CustomerProfiles
|
|
3348
3819
|
include Aws::Structure
|
3349
3820
|
end
|
3350
3821
|
|
3822
|
+
# The relative time period over which data is included in the
|
3823
|
+
# aggregation.
|
3824
|
+
#
|
3825
|
+
# @!attribute [rw] value
|
3826
|
+
# The amount of time of the specified unit.
|
3827
|
+
# @return [Integer]
|
3828
|
+
#
|
3829
|
+
# @!attribute [rw] unit
|
3830
|
+
# The unit of time.
|
3831
|
+
# @return [String]
|
3832
|
+
#
|
3833
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Range AWS API Documentation
|
3834
|
+
#
|
3835
|
+
class Range < Struct.new(
|
3836
|
+
:value,
|
3837
|
+
:unit)
|
3838
|
+
SENSITIVE = []
|
3839
|
+
include Aws::Structure
|
3840
|
+
end
|
3841
|
+
|
3351
3842
|
# The requested resource does not exist, or access was denied.
|
3352
3843
|
#
|
3353
3844
|
# @!attribute [rw] message
|
@@ -3740,6 +4231,25 @@ module Aws::CustomerProfiles
|
|
3740
4231
|
include Aws::Structure
|
3741
4232
|
end
|
3742
4233
|
|
4234
|
+
# The threshold for the calculated attribute.
|
4235
|
+
#
|
4236
|
+
# @!attribute [rw] value
|
4237
|
+
# The value of the threshold.
|
4238
|
+
# @return [String]
|
4239
|
+
#
|
4240
|
+
# @!attribute [rw] operator
|
4241
|
+
# The operator of the threshold.
|
4242
|
+
# @return [String]
|
4243
|
+
#
|
4244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Threshold AWS API Documentation
|
4245
|
+
#
|
4246
|
+
class Threshold < Struct.new(
|
4247
|
+
:value,
|
4248
|
+
:operator)
|
4249
|
+
SENSITIVE = []
|
4250
|
+
include Aws::Structure
|
4251
|
+
end
|
4252
|
+
|
3743
4253
|
# You exceeded the maximum number of requests.
|
3744
4254
|
#
|
3745
4255
|
# @!attribute [rw] message
|
@@ -3873,6 +4383,96 @@ module Aws::CustomerProfiles
|
|
3873
4383
|
include Aws::Structure
|
3874
4384
|
end
|
3875
4385
|
|
4386
|
+
# @!attribute [rw] domain_name
|
4387
|
+
# The unique name of the domain.
|
4388
|
+
# @return [String]
|
4389
|
+
#
|
4390
|
+
# @!attribute [rw] calculated_attribute_name
|
4391
|
+
# The unique name of the calculated attribute.
|
4392
|
+
# @return [String]
|
4393
|
+
#
|
4394
|
+
# @!attribute [rw] display_name
|
4395
|
+
# The display name of the calculated attribute.
|
4396
|
+
# @return [String]
|
4397
|
+
#
|
4398
|
+
# @!attribute [rw] description
|
4399
|
+
# The description of the calculated attribute.
|
4400
|
+
# @return [String]
|
4401
|
+
#
|
4402
|
+
# @!attribute [rw] conditions
|
4403
|
+
# The conditions including range, object count, and threshold for the
|
4404
|
+
# calculated attribute.
|
4405
|
+
# @return [Types::Conditions]
|
4406
|
+
#
|
4407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinitionRequest AWS API Documentation
|
4408
|
+
#
|
4409
|
+
class UpdateCalculatedAttributeDefinitionRequest < Struct.new(
|
4410
|
+
:domain_name,
|
4411
|
+
:calculated_attribute_name,
|
4412
|
+
:display_name,
|
4413
|
+
:description,
|
4414
|
+
:conditions)
|
4415
|
+
SENSITIVE = []
|
4416
|
+
include Aws::Structure
|
4417
|
+
end
|
4418
|
+
|
4419
|
+
# @!attribute [rw] calculated_attribute_name
|
4420
|
+
# The unique name of the calculated attribute.
|
4421
|
+
# @return [String]
|
4422
|
+
#
|
4423
|
+
# @!attribute [rw] display_name
|
4424
|
+
# The display name of the calculated attribute.
|
4425
|
+
# @return [String]
|
4426
|
+
#
|
4427
|
+
# @!attribute [rw] description
|
4428
|
+
# The description of the calculated attribute.
|
4429
|
+
# @return [String]
|
4430
|
+
#
|
4431
|
+
# @!attribute [rw] created_at
|
4432
|
+
# The timestamp of when the calculated attribute definition was
|
4433
|
+
# created.
|
4434
|
+
# @return [Time]
|
4435
|
+
#
|
4436
|
+
# @!attribute [rw] last_updated_at
|
4437
|
+
# The timestamp of when the calculated attribute definition was most
|
4438
|
+
# recently edited.
|
4439
|
+
# @return [Time]
|
4440
|
+
#
|
4441
|
+
# @!attribute [rw] statistic
|
4442
|
+
# The aggregation operation to perform for the calculated attribute.
|
4443
|
+
# @return [String]
|
4444
|
+
#
|
4445
|
+
# @!attribute [rw] conditions
|
4446
|
+
# The conditions including range, object count, and threshold for the
|
4447
|
+
# calculated attribute.
|
4448
|
+
# @return [Types::Conditions]
|
4449
|
+
#
|
4450
|
+
# @!attribute [rw] attribute_details
|
4451
|
+
# The mathematical expression and a list of attribute items specified
|
4452
|
+
# in that expression.
|
4453
|
+
# @return [Types::AttributeDetails]
|
4454
|
+
#
|
4455
|
+
# @!attribute [rw] tags
|
4456
|
+
# The tags used to organize, track, or control access for this
|
4457
|
+
# resource.
|
4458
|
+
# @return [Hash<String,String>]
|
4459
|
+
#
|
4460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinitionResponse AWS API Documentation
|
4461
|
+
#
|
4462
|
+
class UpdateCalculatedAttributeDefinitionResponse < Struct.new(
|
4463
|
+
:calculated_attribute_name,
|
4464
|
+
:display_name,
|
4465
|
+
:description,
|
4466
|
+
:created_at,
|
4467
|
+
:last_updated_at,
|
4468
|
+
:statistic,
|
4469
|
+
:conditions,
|
4470
|
+
:attribute_details,
|
4471
|
+
:tags)
|
4472
|
+
SENSITIVE = []
|
4473
|
+
include Aws::Structure
|
4474
|
+
end
|
4475
|
+
|
3876
4476
|
# @!attribute [rw] domain_name
|
3877
4477
|
# The unique name of the domain.
|
3878
4478
|
# @return [String]
|