aws-sdk-customerprofiles 1.27.0 → 1.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f1dac31b90c040ce2c2a94d8392276a79ab6fb64c81174f1b59da8b3b3e505a7
|
4
|
+
data.tar.gz: e64459d385eeebfb7577326a02663628552cf4e3e947da36aed2124aacf1185a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 53f75eafda9af2766ef5d47313a1d4ae85a87ebaa9030e07ee5926b6327dcce19950e0ecb173ddfd5002f0991fb0e632d300d3c9ec3384cfa6688961036aaa1a
|
7
|
+
data.tar.gz: a53869bc502188ebd96e34796f3d8a072bd5f76e4013527c9470577ba08f1c33467edfc7e1d837d9219f5c8531ba512d007451bf80c355106290d50c5d754230
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.29.0 (2023-06-01)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release introduces calculated attribute related APIs.
|
8
|
+
|
9
|
+
1.28.0 (2023-05-31)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.27.0 (2023-02-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.29.0
|
@@ -275,6 +275,11 @@ module Aws::CustomerProfiles
|
|
275
275
|
# in the future.
|
276
276
|
#
|
277
277
|
#
|
278
|
+
# @option options [String] :sdk_ua_app_id
|
279
|
+
# A unique and opaque application ID that is appended to the
|
280
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
281
|
+
# maximum length of 50.
|
282
|
+
#
|
278
283
|
# @option options [String] :secret_access_key
|
279
284
|
#
|
280
285
|
# @option options [String] :session_token
|
@@ -422,6 +427,116 @@ module Aws::CustomerProfiles
|
|
422
427
|
req.send_request(options)
|
423
428
|
end
|
424
429
|
|
430
|
+
# Creates a new calculated attribute definition. After creation, new
|
431
|
+
# object data ingested into Customer Profiles will be included in the
|
432
|
+
# calculated attribute, which can be retrieved for a profile using the
|
433
|
+
# [GetCalculatedAttributeForProfile][1] API. Defining a calculated
|
434
|
+
# attribute makes it available for all profiles within a domain. Each
|
435
|
+
# calculated attribute can only reference one `ObjectType` and at most,
|
436
|
+
# two fields from that `ObjectType`.
|
437
|
+
#
|
438
|
+
#
|
439
|
+
#
|
440
|
+
# [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html
|
441
|
+
#
|
442
|
+
# @option params [required, String] :domain_name
|
443
|
+
# The unique name of the domain.
|
444
|
+
#
|
445
|
+
# @option params [required, String] :calculated_attribute_name
|
446
|
+
# The unique name of the calculated attribute.
|
447
|
+
#
|
448
|
+
# @option params [String] :display_name
|
449
|
+
# The display name of the calculated attribute.
|
450
|
+
#
|
451
|
+
# @option params [String] :description
|
452
|
+
# The description of the calculated attribute.
|
453
|
+
#
|
454
|
+
# @option params [required, Types::AttributeDetails] :attribute_details
|
455
|
+
# Mathematical expression and a list of attribute items specified in
|
456
|
+
# that expression.
|
457
|
+
#
|
458
|
+
# @option params [Types::Conditions] :conditions
|
459
|
+
# The conditions including range, object count, and threshold for the
|
460
|
+
# calculated attribute.
|
461
|
+
#
|
462
|
+
# @option params [required, String] :statistic
|
463
|
+
# The aggregation operation to perform for the calculated attribute.
|
464
|
+
#
|
465
|
+
# @option params [Hash<String,String>] :tags
|
466
|
+
# The tags used to organize, track, or control access for this resource.
|
467
|
+
#
|
468
|
+
# @return [Types::CreateCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
469
|
+
#
|
470
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
|
471
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#display_name #display_name} => String
|
472
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#description #description} => String
|
473
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
474
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
475
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
476
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
477
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
478
|
+
# * {Types::CreateCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
479
|
+
#
|
480
|
+
# @example Request syntax with placeholder values
|
481
|
+
#
|
482
|
+
# resp = client.create_calculated_attribute_definition({
|
483
|
+
# domain_name: "name", # required
|
484
|
+
# calculated_attribute_name: "typeName", # required
|
485
|
+
# display_name: "displayName",
|
486
|
+
# description: "text",
|
487
|
+
# attribute_details: { # required
|
488
|
+
# attributes: [ # required
|
489
|
+
# {
|
490
|
+
# name: "attributeName", # required
|
491
|
+
# },
|
492
|
+
# ],
|
493
|
+
# expression: "string1To255", # required
|
494
|
+
# },
|
495
|
+
# conditions: {
|
496
|
+
# range: {
|
497
|
+
# value: 1, # required
|
498
|
+
# unit: "DAYS", # required, accepts DAYS
|
499
|
+
# },
|
500
|
+
# object_count: 1,
|
501
|
+
# threshold: {
|
502
|
+
# value: "string1To255", # required
|
503
|
+
# operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
|
504
|
+
# },
|
505
|
+
# },
|
506
|
+
# statistic: "FIRST_OCCURRENCE", # required, accepts FIRST_OCCURRENCE, LAST_OCCURRENCE, COUNT, SUM, MINIMUM, MAXIMUM, AVERAGE, MAX_OCCURRENCE
|
507
|
+
# tags: {
|
508
|
+
# "TagKey" => "TagValue",
|
509
|
+
# },
|
510
|
+
# })
|
511
|
+
#
|
512
|
+
# @example Response structure
|
513
|
+
#
|
514
|
+
# resp.calculated_attribute_name #=> String
|
515
|
+
# resp.display_name #=> String
|
516
|
+
# resp.description #=> String
|
517
|
+
# resp.attribute_details.attributes #=> Array
|
518
|
+
# resp.attribute_details.attributes[0].name #=> String
|
519
|
+
# resp.attribute_details.expression #=> String
|
520
|
+
# resp.conditions.range.value #=> Integer
|
521
|
+
# resp.conditions.range.unit #=> String, one of "DAYS"
|
522
|
+
# resp.conditions.object_count #=> Integer
|
523
|
+
# resp.conditions.threshold.value #=> String
|
524
|
+
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
525
|
+
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
526
|
+
# resp.created_at #=> Time
|
527
|
+
# resp.last_updated_at #=> Time
|
528
|
+
# resp.tags #=> Hash
|
529
|
+
# resp.tags["TagKey"] #=> String
|
530
|
+
#
|
531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition AWS API Documentation
|
532
|
+
#
|
533
|
+
# @overload create_calculated_attribute_definition(params = {})
|
534
|
+
# @param [Hash] params ({})
|
535
|
+
def create_calculated_attribute_definition(params = {}, options = {})
|
536
|
+
req = build_request(:create_calculated_attribute_definition, params)
|
537
|
+
req.send_request(options)
|
538
|
+
end
|
539
|
+
|
425
540
|
# Creates a domain, which is a container for all customer data, such as
|
426
541
|
# customer profile attributes, object types, profile keys, and
|
427
542
|
# encryption keys. You can create multiple domains, and each domain can
|
@@ -430,7 +545,7 @@ module Aws::CustomerProfiles
|
|
430
545
|
# Each Amazon Connect instance can be associated with only one domain.
|
431
546
|
# Multiple Amazon Connect instances can be associated with one domain.
|
432
547
|
#
|
433
|
-
# Use this API or [UpdateDomain][1] to enable [identity resolution][2]
|
548
|
+
# Use this API or [UpdateDomain][1] to enable [identity resolution][2]:
|
434
549
|
# set `Matching` to true.
|
435
550
|
#
|
436
551
|
# To prevent cross-service impersonation when you call this API, see
|
@@ -863,6 +978,36 @@ module Aws::CustomerProfiles
|
|
863
978
|
req.send_request(options)
|
864
979
|
end
|
865
980
|
|
981
|
+
# Deletes an existing calculated attribute definition. Note that
|
982
|
+
# deleting a default calculated attribute is possible, however once
|
983
|
+
# deleted, you will be unable to undo that action and will need to
|
984
|
+
# recreate it on your own using the CreateCalculatedAttributeDefinition
|
985
|
+
# API if you want it back.
|
986
|
+
#
|
987
|
+
# @option params [required, String] :domain_name
|
988
|
+
# The unique name of the domain.
|
989
|
+
#
|
990
|
+
# @option params [required, String] :calculated_attribute_name
|
991
|
+
# The unique name of the calculated attribute.
|
992
|
+
#
|
993
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
994
|
+
#
|
995
|
+
# @example Request syntax with placeholder values
|
996
|
+
#
|
997
|
+
# resp = client.delete_calculated_attribute_definition({
|
998
|
+
# domain_name: "name", # required
|
999
|
+
# calculated_attribute_name: "typeName", # required
|
1000
|
+
# })
|
1001
|
+
#
|
1002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition AWS API Documentation
|
1003
|
+
#
|
1004
|
+
# @overload delete_calculated_attribute_definition(params = {})
|
1005
|
+
# @param [Hash] params ({})
|
1006
|
+
def delete_calculated_attribute_definition(params = {}, options = {})
|
1007
|
+
req = build_request(:delete_calculated_attribute_definition, params)
|
1008
|
+
req.send_request(options)
|
1009
|
+
end
|
1010
|
+
|
866
1011
|
# Deletes a specific domain and all of its customer data, such as
|
867
1012
|
# customer profile attributes and their related objects.
|
868
1013
|
#
|
@@ -1171,6 +1316,104 @@ module Aws::CustomerProfiles
|
|
1171
1316
|
req.send_request(options)
|
1172
1317
|
end
|
1173
1318
|
|
1319
|
+
# Provides more information on a calculated attribute definition for
|
1320
|
+
# Customer Profiles.
|
1321
|
+
#
|
1322
|
+
# @option params [required, String] :domain_name
|
1323
|
+
# The unique name of the domain.
|
1324
|
+
#
|
1325
|
+
# @option params [required, String] :calculated_attribute_name
|
1326
|
+
# The unique name of the calculated attribute.
|
1327
|
+
#
|
1328
|
+
# @return [Types::GetCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1329
|
+
#
|
1330
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
|
1331
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#display_name #display_name} => String
|
1332
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#description #description} => String
|
1333
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
1334
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
1335
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
1336
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
1337
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
1338
|
+
# * {Types::GetCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
1339
|
+
#
|
1340
|
+
# @example Request syntax with placeholder values
|
1341
|
+
#
|
1342
|
+
# resp = client.get_calculated_attribute_definition({
|
1343
|
+
# domain_name: "name", # required
|
1344
|
+
# calculated_attribute_name: "typeName", # required
|
1345
|
+
# })
|
1346
|
+
#
|
1347
|
+
# @example Response structure
|
1348
|
+
#
|
1349
|
+
# resp.calculated_attribute_name #=> String
|
1350
|
+
# resp.display_name #=> String
|
1351
|
+
# resp.description #=> String
|
1352
|
+
# resp.created_at #=> Time
|
1353
|
+
# resp.last_updated_at #=> Time
|
1354
|
+
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
1355
|
+
# resp.conditions.range.value #=> Integer
|
1356
|
+
# resp.conditions.range.unit #=> String, one of "DAYS"
|
1357
|
+
# resp.conditions.object_count #=> Integer
|
1358
|
+
# resp.conditions.threshold.value #=> String
|
1359
|
+
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
1360
|
+
# resp.attribute_details.attributes #=> Array
|
1361
|
+
# resp.attribute_details.attributes[0].name #=> String
|
1362
|
+
# resp.attribute_details.expression #=> String
|
1363
|
+
# resp.tags #=> Hash
|
1364
|
+
# resp.tags["TagKey"] #=> String
|
1365
|
+
#
|
1366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition AWS API Documentation
|
1367
|
+
#
|
1368
|
+
# @overload get_calculated_attribute_definition(params = {})
|
1369
|
+
# @param [Hash] params ({})
|
1370
|
+
def get_calculated_attribute_definition(params = {}, options = {})
|
1371
|
+
req = build_request(:get_calculated_attribute_definition, params)
|
1372
|
+
req.send_request(options)
|
1373
|
+
end
|
1374
|
+
|
1375
|
+
# Retrieve a calculated attribute for a customer profile.
|
1376
|
+
#
|
1377
|
+
# @option params [required, String] :domain_name
|
1378
|
+
# The unique name of the domain.
|
1379
|
+
#
|
1380
|
+
# @option params [required, String] :profile_id
|
1381
|
+
# The unique identifier of a customer profile.
|
1382
|
+
#
|
1383
|
+
# @option params [required, String] :calculated_attribute_name
|
1384
|
+
# The unique name of the calculated attribute.
|
1385
|
+
#
|
1386
|
+
# @return [Types::GetCalculatedAttributeForProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1387
|
+
#
|
1388
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#calculated_attribute_name #calculated_attribute_name} => String
|
1389
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#display_name #display_name} => String
|
1390
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#is_data_partial #is_data_partial} => String
|
1391
|
+
# * {Types::GetCalculatedAttributeForProfileResponse#value #value} => String
|
1392
|
+
#
|
1393
|
+
# @example Request syntax with placeholder values
|
1394
|
+
#
|
1395
|
+
# resp = client.get_calculated_attribute_for_profile({
|
1396
|
+
# domain_name: "name", # required
|
1397
|
+
# profile_id: "uuid", # required
|
1398
|
+
# calculated_attribute_name: "typeName", # required
|
1399
|
+
# })
|
1400
|
+
#
|
1401
|
+
# @example Response structure
|
1402
|
+
#
|
1403
|
+
# resp.calculated_attribute_name #=> String
|
1404
|
+
# resp.display_name #=> String
|
1405
|
+
# resp.is_data_partial #=> String
|
1406
|
+
# resp.value #=> String
|
1407
|
+
#
|
1408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile AWS API Documentation
|
1409
|
+
#
|
1410
|
+
# @overload get_calculated_attribute_for_profile(params = {})
|
1411
|
+
# @param [Hash] params ({})
|
1412
|
+
def get_calculated_attribute_for_profile(params = {}, options = {})
|
1413
|
+
req = build_request(:get_calculated_attribute_for_profile, params)
|
1414
|
+
req.send_request(options)
|
1415
|
+
end
|
1416
|
+
|
1174
1417
|
# Returns information about a specific domain.
|
1175
1418
|
#
|
1176
1419
|
# @option params [required, String] :domain_name
|
@@ -1724,6 +1967,100 @@ module Aws::CustomerProfiles
|
|
1724
1967
|
req.send_request(options)
|
1725
1968
|
end
|
1726
1969
|
|
1970
|
+
# Lists calculated attribute definitions for Customer Profiles
|
1971
|
+
#
|
1972
|
+
# @option params [required, String] :domain_name
|
1973
|
+
# The unique name of the domain.
|
1974
|
+
#
|
1975
|
+
# @option params [String] :next_token
|
1976
|
+
# The pagination token from the previous call to
|
1977
|
+
# ListCalculatedAttributeDefinitions.
|
1978
|
+
#
|
1979
|
+
# @option params [Integer] :max_results
|
1980
|
+
# The maximum number of calculated attribute definitions returned per
|
1981
|
+
# page.
|
1982
|
+
#
|
1983
|
+
# @return [Types::ListCalculatedAttributeDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1984
|
+
#
|
1985
|
+
# * {Types::ListCalculatedAttributeDefinitionsResponse#items #items} => Array<Types::ListCalculatedAttributeDefinitionItem>
|
1986
|
+
# * {Types::ListCalculatedAttributeDefinitionsResponse#next_token #next_token} => String
|
1987
|
+
#
|
1988
|
+
# @example Request syntax with placeholder values
|
1989
|
+
#
|
1990
|
+
# resp = client.list_calculated_attribute_definitions({
|
1991
|
+
# domain_name: "name", # required
|
1992
|
+
# next_token: "token",
|
1993
|
+
# max_results: 1,
|
1994
|
+
# })
|
1995
|
+
#
|
1996
|
+
# @example Response structure
|
1997
|
+
#
|
1998
|
+
# resp.items #=> Array
|
1999
|
+
# resp.items[0].calculated_attribute_name #=> String
|
2000
|
+
# resp.items[0].display_name #=> String
|
2001
|
+
# resp.items[0].description #=> String
|
2002
|
+
# resp.items[0].created_at #=> Time
|
2003
|
+
# resp.items[0].last_updated_at #=> Time
|
2004
|
+
# resp.items[0].tags #=> Hash
|
2005
|
+
# resp.items[0].tags["TagKey"] #=> String
|
2006
|
+
# resp.next_token #=> String
|
2007
|
+
#
|
2008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions AWS API Documentation
|
2009
|
+
#
|
2010
|
+
# @overload list_calculated_attribute_definitions(params = {})
|
2011
|
+
# @param [Hash] params ({})
|
2012
|
+
def list_calculated_attribute_definitions(params = {}, options = {})
|
2013
|
+
req = build_request(:list_calculated_attribute_definitions, params)
|
2014
|
+
req.send_request(options)
|
2015
|
+
end
|
2016
|
+
|
2017
|
+
# Retrieve a list of calculated attributes for a customer profile.
|
2018
|
+
#
|
2019
|
+
# @option params [String] :next_token
|
2020
|
+
# The pagination token from the previous call to
|
2021
|
+
# ListCalculatedAttributesForProfile.
|
2022
|
+
#
|
2023
|
+
# @option params [Integer] :max_results
|
2024
|
+
# The maximum number of calculated attributes returned per page.
|
2025
|
+
#
|
2026
|
+
# @option params [required, String] :domain_name
|
2027
|
+
# The unique name of the domain.
|
2028
|
+
#
|
2029
|
+
# @option params [required, String] :profile_id
|
2030
|
+
# The unique identifier of a customer profile.
|
2031
|
+
#
|
2032
|
+
# @return [Types::ListCalculatedAttributesForProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2033
|
+
#
|
2034
|
+
# * {Types::ListCalculatedAttributesForProfileResponse#items #items} => Array<Types::ListCalculatedAttributeForProfileItem>
|
2035
|
+
# * {Types::ListCalculatedAttributesForProfileResponse#next_token #next_token} => String
|
2036
|
+
#
|
2037
|
+
# @example Request syntax with placeholder values
|
2038
|
+
#
|
2039
|
+
# resp = client.list_calculated_attributes_for_profile({
|
2040
|
+
# next_token: "token",
|
2041
|
+
# max_results: 1,
|
2042
|
+
# domain_name: "name", # required
|
2043
|
+
# profile_id: "uuid", # required
|
2044
|
+
# })
|
2045
|
+
#
|
2046
|
+
# @example Response structure
|
2047
|
+
#
|
2048
|
+
# resp.items #=> Array
|
2049
|
+
# resp.items[0].calculated_attribute_name #=> String
|
2050
|
+
# resp.items[0].display_name #=> String
|
2051
|
+
# resp.items[0].is_data_partial #=> String
|
2052
|
+
# resp.items[0].value #=> String
|
2053
|
+
# resp.next_token #=> String
|
2054
|
+
#
|
2055
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile AWS API Documentation
|
2056
|
+
#
|
2057
|
+
# @overload list_calculated_attributes_for_profile(params = {})
|
2058
|
+
# @param [Hash] params ({})
|
2059
|
+
def list_calculated_attributes_for_profile(params = {}, options = {})
|
2060
|
+
req = build_request(:list_calculated_attributes_for_profile, params)
|
2061
|
+
req.send_request(options)
|
2062
|
+
end
|
2063
|
+
|
1727
2064
|
# Returns a list of all the domains for an AWS account that have been
|
1728
2065
|
# created.
|
1729
2066
|
#
|
@@ -1972,8 +2309,7 @@ module Aws::CustomerProfiles
|
|
1972
2309
|
#
|
1973
2310
|
# @option params [Types::ObjectFilter] :object_filter
|
1974
2311
|
# Applies a filter to the response to include profile objects with the
|
1975
|
-
# specified index values.
|
1976
|
-
# ObjectTypeName \_asset, \_case and \_order.
|
2312
|
+
# specified index values.
|
1977
2313
|
#
|
1978
2314
|
# @return [Types::ListProfileObjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1979
2315
|
#
|
@@ -2772,12 +3108,93 @@ module Aws::CustomerProfiles
|
|
2772
3108
|
req.send_request(options)
|
2773
3109
|
end
|
2774
3110
|
|
3111
|
+
# Updates an existing calculated attribute definition. When updating the
|
3112
|
+
# Conditions, note that increasing the date range of a calculated
|
3113
|
+
# attribute will not trigger inclusion of historical data greater than
|
3114
|
+
# the current date range.
|
3115
|
+
#
|
3116
|
+
# @option params [required, String] :domain_name
|
3117
|
+
# The unique name of the domain.
|
3118
|
+
#
|
3119
|
+
# @option params [required, String] :calculated_attribute_name
|
3120
|
+
# The unique name of the calculated attribute.
|
3121
|
+
#
|
3122
|
+
# @option params [String] :display_name
|
3123
|
+
# The display name of the calculated attribute.
|
3124
|
+
#
|
3125
|
+
# @option params [String] :description
|
3126
|
+
# The description of the calculated attribute.
|
3127
|
+
#
|
3128
|
+
# @option params [Types::Conditions] :conditions
|
3129
|
+
# The conditions including range, object count, and threshold for the
|
3130
|
+
# calculated attribute.
|
3131
|
+
#
|
3132
|
+
# @return [Types::UpdateCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3133
|
+
#
|
3134
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
|
3135
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#display_name #display_name} => String
|
3136
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#description #description} => String
|
3137
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
|
3138
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
|
3139
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
|
3140
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
|
3141
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
|
3142
|
+
# * {Types::UpdateCalculatedAttributeDefinitionResponse#tags #tags} => Hash<String,String>
|
3143
|
+
#
|
3144
|
+
# @example Request syntax with placeholder values
|
3145
|
+
#
|
3146
|
+
# resp = client.update_calculated_attribute_definition({
|
3147
|
+
# domain_name: "name", # required
|
3148
|
+
# calculated_attribute_name: "typeName", # required
|
3149
|
+
# display_name: "displayName",
|
3150
|
+
# description: "text",
|
3151
|
+
# conditions: {
|
3152
|
+
# range: {
|
3153
|
+
# value: 1, # required
|
3154
|
+
# unit: "DAYS", # required, accepts DAYS
|
3155
|
+
# },
|
3156
|
+
# object_count: 1,
|
3157
|
+
# threshold: {
|
3158
|
+
# value: "string1To255", # required
|
3159
|
+
# operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
|
3160
|
+
# },
|
3161
|
+
# },
|
3162
|
+
# })
|
3163
|
+
#
|
3164
|
+
# @example Response structure
|
3165
|
+
#
|
3166
|
+
# resp.calculated_attribute_name #=> String
|
3167
|
+
# resp.display_name #=> String
|
3168
|
+
# resp.description #=> String
|
3169
|
+
# resp.created_at #=> Time
|
3170
|
+
# resp.last_updated_at #=> Time
|
3171
|
+
# resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
|
3172
|
+
# resp.conditions.range.value #=> Integer
|
3173
|
+
# resp.conditions.range.unit #=> String, one of "DAYS"
|
3174
|
+
# resp.conditions.object_count #=> Integer
|
3175
|
+
# resp.conditions.threshold.value #=> String
|
3176
|
+
# resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
|
3177
|
+
# resp.attribute_details.attributes #=> Array
|
3178
|
+
# resp.attribute_details.attributes[0].name #=> String
|
3179
|
+
# resp.attribute_details.expression #=> String
|
3180
|
+
# resp.tags #=> Hash
|
3181
|
+
# resp.tags["TagKey"] #=> String
|
3182
|
+
#
|
3183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition AWS API Documentation
|
3184
|
+
#
|
3185
|
+
# @overload update_calculated_attribute_definition(params = {})
|
3186
|
+
# @param [Hash] params ({})
|
3187
|
+
def update_calculated_attribute_definition(params = {}, options = {})
|
3188
|
+
req = build_request(:update_calculated_attribute_definition, params)
|
3189
|
+
req.send_request(options)
|
3190
|
+
end
|
3191
|
+
|
2775
3192
|
# Updates the properties of a domain, including creating or selecting a
|
2776
3193
|
# dead letter queue or an encryption key.
|
2777
3194
|
#
|
2778
3195
|
# After a domain is created, the name can’t be changed.
|
2779
3196
|
#
|
2780
|
-
# Use this API or [CreateDomain][1] to enable [identity resolution][2]
|
3197
|
+
# Use this API or [CreateDomain][1] to enable [identity resolution][2]:
|
2781
3198
|
# set `Matching` to true.
|
2782
3199
|
#
|
2783
3200
|
# To prevent cross-service impersonation when you call this API, see
|
@@ -3106,7 +3523,7 @@ module Aws::CustomerProfiles
|
|
3106
3523
|
params: params,
|
3107
3524
|
config: config)
|
3108
3525
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
3109
|
-
context[:gem_version] = '1.
|
3526
|
+
context[:gem_version] = '1.29.0'
|
3110
3527
|
Seahorse::Client::Request.new(handlers, context)
|
3111
3528
|
end
|
3112
3529
|
|