aws-sdk-customerprofiles 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206a9c41b5bf79cbfcc1c919b9a316a13acf8ce4773e0368e5a04eefe0258692
-  data.tar.gz: 281922444e0e0f48f736d7c067373d85057d91889c55a128444263df318db185
+  metadata.gz: f1dac31b90c040ce2c2a94d8392276a79ab6fb64c81174f1b59da8b3b3e505a7
+  data.tar.gz: e64459d385eeebfb7577326a02663628552cf4e3e947da36aed2124aacf1185a
 SHA512:
-  metadata.gz: 42fa8766629715c3bea5a5bbcc9c473e012e539562de9cce376a2eae1f3f619641968f2ea73f6f32061b663c1870d0533343be4d4dc871379ddf24d4abfc7fb6
-  data.tar.gz: ea1485acfb744bfa3fc1499faad19df90a54b48938df07e7801d106bd9cc0bee408dd8c53995a3c62ebdb11623380823cb490dd09cbf33f0be7111d21f270af7
+  metadata.gz: 53f75eafda9af2766ef5d47313a1d4ae85a87ebaa9030e07ee5926b6327dcce19950e0ecb173ddfd5002f0991fb0e632d300d3c9ec3384cfa6688961036aaa1a
+  data.tar.gz: a53869bc502188ebd96e34796f3d8a072bd5f76e4013527c9470577ba08f1c33467edfc7e1d837d9219f5c8531ba512d007451bf80c355106290d50c5d754230

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.29.0 (2023-06-01)
+------------------
+
+* Feature - This release introduces calculated attribute related APIs.
+
 1.28.0 (2023-05-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.28.0
+1.29.0

data/lib/aws-sdk-customerprofiles/client.rb

@@ -427,6 +427,116 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # Creates a new calculated attribute definition. After creation, new
+    # object data ingested into Customer Profiles will be included in the
+    # calculated attribute, which can be retrieved for a profile using the
+    # [GetCalculatedAttributeForProfile][1] API. Defining a calculated
+    # attribute makes it available for all profiles within a domain. Each
+    # calculated attribute can only reference one `ObjectType` and at most,
+    # two fields from that `ObjectType`.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [required, String] :calculated_attribute_name
+    #   The unique name of the calculated attribute.
+    #
+    # @option params [String] :display_name
+    #   The display name of the calculated attribute.
+    #
+    # @option params [String] :description
+    #   The description of the calculated attribute.
+    #
+    # @option params [required, Types::AttributeDetails] :attribute_details
+    #   Mathematical expression and a list of attribute items specified in
+    #   that expression.
+    #
+    # @option params [Types::Conditions] :conditions
+    #   The conditions including range, object count, and threshold for the
+    #   calculated attribute.
+    #
+    # @option params [required, String] :statistic
+    #   The aggregation operation to perform for the calculated attribute.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   The tags used to organize, track, or control access for this resource.
+    #
+    # @return [Types::CreateCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#display_name #display_name} => String
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#description #description} => String
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
+    #   * {Types::CreateCalculatedAttributeDefinitionResponse#tags #tags} => Hash&lt;String,String&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_calculated_attribute_definition({
+    #     domain_name: "name", # required
+    #     calculated_attribute_name: "typeName", # required
+    #     display_name: "displayName",
+    #     description: "text",
+    #     attribute_details: { # required
+    #       attributes: [ # required
+    #         {
+    #           name: "attributeName", # required
+    #         },
+    #       ],
+    #       expression: "string1To255", # required
+    #     },
+    #     conditions: {
+    #       range: {
+    #         value: 1, # required
+    #         unit: "DAYS", # required, accepts DAYS
+    #       },
+    #       object_count: 1,
+    #       threshold: {
+    #         value: "string1To255", # required
+    #         operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
+    #       },
+    #     },
+    #     statistic: "FIRST_OCCURRENCE", # required, accepts FIRST_OCCURRENCE, LAST_OCCURRENCE, COUNT, SUM, MINIMUM, MAXIMUM, AVERAGE, MAX_OCCURRENCE
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.calculated_attribute_name #=> String
+    #   resp.display_name #=> String
+    #   resp.description #=> String
+    #   resp.attribute_details.attributes #=> Array
+    #   resp.attribute_details.attributes[0].name #=> String
+    #   resp.attribute_details.expression #=> String
+    #   resp.conditions.range.value #=> Integer
+    #   resp.conditions.range.unit #=> String, one of "DAYS"
+    #   resp.conditions.object_count #=> Integer
+    #   resp.conditions.threshold.value #=> String
+    #   resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
+    #   resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
+    #   resp.created_at #=> Time
+    #   resp.last_updated_at #=> Time
+    #   resp.tags #=> Hash
+    #   resp.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition AWS API Documentation
+    #
+    # @overload create_calculated_attribute_definition(params = {})
+    # @param [Hash] params ({})
+    def create_calculated_attribute_definition(params = {}, options = {})
+      req = build_request(:create_calculated_attribute_definition, params)
+      req.send_request(options)
+    end
+
     # Creates a domain, which is a container for all customer data, such as
     # customer profile attributes, object types, profile keys, and
     # encryption keys. You can create multiple domains, and each domain can
@@ -868,6 +978,36 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # Deletes an existing calculated attribute definition. Note that
+    # deleting a default calculated attribute is possible, however once
+    # deleted, you will be unable to undo that action and will need to
+    # recreate it on your own using the CreateCalculatedAttributeDefinition
+    # API if you want it back.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [required, String] :calculated_attribute_name
+    #   The unique name of the calculated attribute.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_calculated_attribute_definition({
+    #     domain_name: "name", # required
+    #     calculated_attribute_name: "typeName", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition AWS API Documentation
+    #
+    # @overload delete_calculated_attribute_definition(params = {})
+    # @param [Hash] params ({})
+    def delete_calculated_attribute_definition(params = {}, options = {})
+      req = build_request(:delete_calculated_attribute_definition, params)
+      req.send_request(options)
+    end
+
     # Deletes a specific domain and all of its customer data, such as
     # customer profile attributes and their related objects.
     #
@@ -1176,6 +1316,104 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # Provides more information on a calculated attribute definition for
+    # Customer Profiles.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [required, String] :calculated_attribute_name
+    #   The unique name of the calculated attribute.
+    #
+    # @return [Types::GetCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#display_name #display_name} => String
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#description #description} => String
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#statistic #statistic} => String
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
+    #   * {Types::GetCalculatedAttributeDefinitionResponse#tags #tags} => Hash&lt;String,String&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_calculated_attribute_definition({
+    #     domain_name: "name", # required
+    #     calculated_attribute_name: "typeName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.calculated_attribute_name #=> String
+    #   resp.display_name #=> String
+    #   resp.description #=> String
+    #   resp.created_at #=> Time
+    #   resp.last_updated_at #=> Time
+    #   resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
+    #   resp.conditions.range.value #=> Integer
+    #   resp.conditions.range.unit #=> String, one of "DAYS"
+    #   resp.conditions.object_count #=> Integer
+    #   resp.conditions.threshold.value #=> String
+    #   resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
+    #   resp.attribute_details.attributes #=> Array
+    #   resp.attribute_details.attributes[0].name #=> String
+    #   resp.attribute_details.expression #=> String
+    #   resp.tags #=> Hash
+    #   resp.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition AWS API Documentation
+    #
+    # @overload get_calculated_attribute_definition(params = {})
+    # @param [Hash] params ({})
+    def get_calculated_attribute_definition(params = {}, options = {})
+      req = build_request(:get_calculated_attribute_definition, params)
+      req.send_request(options)
+    end
+
+    # Retrieve a calculated attribute for a customer profile.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [required, String] :profile_id
+    #   The unique identifier of a customer profile.
+    #
+    # @option params [required, String] :calculated_attribute_name
+    #   The unique name of the calculated attribute.
+    #
+    # @return [Types::GetCalculatedAttributeForProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetCalculatedAttributeForProfileResponse#calculated_attribute_name #calculated_attribute_name} => String
+    #   * {Types::GetCalculatedAttributeForProfileResponse#display_name #display_name} => String
+    #   * {Types::GetCalculatedAttributeForProfileResponse#is_data_partial #is_data_partial} => String
+    #   * {Types::GetCalculatedAttributeForProfileResponse#value #value} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_calculated_attribute_for_profile({
+    #     domain_name: "name", # required
+    #     profile_id: "uuid", # required
+    #     calculated_attribute_name: "typeName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.calculated_attribute_name #=> String
+    #   resp.display_name #=> String
+    #   resp.is_data_partial #=> String
+    #   resp.value #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile AWS API Documentation
+    #
+    # @overload get_calculated_attribute_for_profile(params = {})
+    # @param [Hash] params ({})
+    def get_calculated_attribute_for_profile(params = {}, options = {})
+      req = build_request(:get_calculated_attribute_for_profile, params)
+      req.send_request(options)
+    end
+
     # Returns information about a specific domain.
     #
     # @option params [required, String] :domain_name
@@ -1729,6 +1967,100 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # Lists calculated attribute definitions for Customer Profiles
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [String] :next_token
+    #   The pagination token from the previous call to
+    #   ListCalculatedAttributeDefinitions.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of calculated attribute definitions returned per
+    #   page.
+    #
+    # @return [Types::ListCalculatedAttributeDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListCalculatedAttributeDefinitionsResponse#items #items} => Array&lt;Types::ListCalculatedAttributeDefinitionItem&gt;
+    #   * {Types::ListCalculatedAttributeDefinitionsResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_calculated_attribute_definitions({
+    #     domain_name: "name", # required
+    #     next_token: "token",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.items #=> Array
+    #   resp.items[0].calculated_attribute_name #=> String
+    #   resp.items[0].display_name #=> String
+    #   resp.items[0].description #=> String
+    #   resp.items[0].created_at #=> Time
+    #   resp.items[0].last_updated_at #=> Time
+    #   resp.items[0].tags #=> Hash
+    #   resp.items[0].tags["TagKey"] #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions AWS API Documentation
+    #
+    # @overload list_calculated_attribute_definitions(params = {})
+    # @param [Hash] params ({})
+    def list_calculated_attribute_definitions(params = {}, options = {})
+      req = build_request(:list_calculated_attribute_definitions, params)
+      req.send_request(options)
+    end
+
+    # Retrieve a list of calculated attributes for a customer profile.
+    #
+    # @option params [String] :next_token
+    #   The pagination token from the previous call to
+    #   ListCalculatedAttributesForProfile.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of calculated attributes returned per page.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [required, String] :profile_id
+    #   The unique identifier of a customer profile.
+    #
+    # @return [Types::ListCalculatedAttributesForProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListCalculatedAttributesForProfileResponse#items #items} => Array&lt;Types::ListCalculatedAttributeForProfileItem&gt;
+    #   * {Types::ListCalculatedAttributesForProfileResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_calculated_attributes_for_profile({
+    #     next_token: "token",
+    #     max_results: 1,
+    #     domain_name: "name", # required
+    #     profile_id: "uuid", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.items #=> Array
+    #   resp.items[0].calculated_attribute_name #=> String
+    #   resp.items[0].display_name #=> String
+    #   resp.items[0].is_data_partial #=> String
+    #   resp.items[0].value #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile AWS API Documentation
+    #
+    # @overload list_calculated_attributes_for_profile(params = {})
+    # @param [Hash] params ({})
+    def list_calculated_attributes_for_profile(params = {}, options = {})
+      req = build_request(:list_calculated_attributes_for_profile, params)
+      req.send_request(options)
+    end
+
     # Returns a list of all the domains for an AWS account that have been
     # created.
     #
@@ -1977,8 +2309,7 @@ module Aws::CustomerProfiles
     #
     # @option params [Types::ObjectFilter] :object_filter
     #   Applies a filter to the response to include profile objects with the
-    #   specified index values. This filter is only supported for
-    #   ObjectTypeName \_asset, \_case and \_order.
+    #   specified index values.
     #
     # @return [Types::ListProfileObjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -2777,6 +3108,87 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # Updates an existing calculated attribute definition. When updating the
+    # Conditions, note that increasing the date range of a calculated
+    # attribute will not trigger inclusion of historical data greater than
+    # the current date range.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [required, String] :calculated_attribute_name
+    #   The unique name of the calculated attribute.
+    #
+    # @option params [String] :display_name
+    #   The display name of the calculated attribute.
+    #
+    # @option params [String] :description
+    #   The description of the calculated attribute.
+    #
+    # @option params [Types::Conditions] :conditions
+    #   The conditions including range, object count, and threshold for the
+    #   calculated attribute.
+    #
+    # @return [Types::UpdateCalculatedAttributeDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#calculated_attribute_name #calculated_attribute_name} => String
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#display_name #display_name} => String
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#description #description} => String
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#created_at #created_at} => Time
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#last_updated_at #last_updated_at} => Time
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#statistic #statistic} => String
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#conditions #conditions} => Types::Conditions
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#attribute_details #attribute_details} => Types::AttributeDetails
+    #   * {Types::UpdateCalculatedAttributeDefinitionResponse#tags #tags} => Hash&lt;String,String&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_calculated_attribute_definition({
+    #     domain_name: "name", # required
+    #     calculated_attribute_name: "typeName", # required
+    #     display_name: "displayName",
+    #     description: "text",
+    #     conditions: {
+    #       range: {
+    #         value: 1, # required
+    #         unit: "DAYS", # required, accepts DAYS
+    #       },
+    #       object_count: 1,
+    #       threshold: {
+    #         value: "string1To255", # required
+    #         operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
+    #       },
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.calculated_attribute_name #=> String
+    #   resp.display_name #=> String
+    #   resp.description #=> String
+    #   resp.created_at #=> Time
+    #   resp.last_updated_at #=> Time
+    #   resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE"
+    #   resp.conditions.range.value #=> Integer
+    #   resp.conditions.range.unit #=> String, one of "DAYS"
+    #   resp.conditions.object_count #=> Integer
+    #   resp.conditions.threshold.value #=> String
+    #   resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
+    #   resp.attribute_details.attributes #=> Array
+    #   resp.attribute_details.attributes[0].name #=> String
+    #   resp.attribute_details.expression #=> String
+    #   resp.tags #=> Hash
+    #   resp.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition AWS API Documentation
+    #
+    # @overload update_calculated_attribute_definition(params = {})
+    # @param [Hash] params ({})
+    def update_calculated_attribute_definition(params = {}, options = {})
+      req = build_request(:update_calculated_attribute_definition, params)
+      req.send_request(options)
+    end
+
     # Updates the properties of a domain, including creating or selecting a
     # dead letter queue or an encryption key.
     #
@@ -3111,7 +3523,7 @@ module Aws::CustomerProfiles
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-customerprofiles'
-      context[:gem_version] = '1.28.0'
+      context[:gem_version] = '1.29.0'
       Seahorse::Client::Request.new(handlers, context)
     end