calculated_attribute_for_profiles
Creates, updates, deletes, gets or lists a calculated_attribute_for_profiles resource.
Overview
| Name | calculated_attribute_for_profiles |
| Type | Resource |
| Id | aws.customer_profiles.calculated_attribute_for_profiles |
Fields
The following fields are returned by SELECT queries:
- batch_get_calculated_attribute_for_profile
- get_calculated_attribute_for_profile
| Name | Datatype | Description |
|---|---|---|
calculated_attribute_values | array | List of calculated attribute values retrieved. |
condition_overrides | object | An object to override the original condition block of a calculated attribute. |
errors | array | List of errors for calculated attribute values that could not be retrieved. |
| Name | Datatype | Description |
|---|---|---|
calculated_attribute_name | string | The unique name of the calculated attribute. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-]*$</code>) |
display_name | string | The display name of the calculated attribute. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-\s]*$</code>) |
is_data_partial | string | Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true. |
last_object_timestamp | string (date-time) | The timestamp of the newest object included in the calculated attribute calculation. |
value | string | The value of the calculated attribute. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
batch_get_calculated_attribute_for_profile | select | calculated_attribute_name, domain_name, region | Fetch the possible attribute values given the attribute name. | |
get_calculated_attribute_for_profile | select | domain_name, profile_id, calculated_attribute_name, region | Retrieve a calculated attribute for a customer profile. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
calculated_attribute_name | string | The unique name of the calculated attribute. |
domain_name | string | The unique name of the domain. |
profile_id | string | The unique identifier of a customer profile. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- batch_get_calculated_attribute_for_profile
- get_calculated_attribute_for_profile
Fetch the possible attribute values given the attribute name.
SELECT
calculated_attribute_values,
condition_overrides,
errors
FROM aws.customer_profiles.calculated_attribute_for_profiles
WHERE calculated_attribute_name = '{{ calculated_attribute_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;
Retrieve a calculated attribute for a customer profile.
SELECT
calculated_attribute_name,
display_name,
is_data_partial,
last_object_timestamp,
value
FROM aws.customer_profiles.calculated_attribute_for_profiles
WHERE domain_name = '{{ domain_name }}' -- required
AND profile_id = '{{ profile_id }}' -- required
AND calculated_attribute_name = '{{ calculated_attribute_name }}' -- required
AND region = '{{ region }}' -- required
;