# CreateCalculatedAttributeDefinition
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition"></a>

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](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html) 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`.

## Request Syntax
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax"></a>

```
POST /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1
Content-type: application/json

{
   "AttributeDetails": { 
      "Attributes": [ 
         { 
            "Name": "string"
         }
      ],
      "Expression": "string"
   },
   "Conditions": { 
      "ObjectCount": number,
      "Range": { 
         "TimestampFormat": "string",
         "TimestampSource": "string",
         "Unit": "string",
         "Value": number,
         "ValueRange": { 
            "End": number,
            "Start": number
         }
      },
      "Threshold": { 
         "Operator": "string",
         "Value": "string"
      }
   },
   "Description": "string",
   "DisplayName": "string",
   "Filter": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { 
                  "Attributes": { 
                     "string" : { 
                        "DimensionType": "string",
                        "Values": [ "string" ]
                     }
                  }
               }
            ],
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "Statistic": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UseHistoricalData": boolean
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CalculatedAttributeName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-uri-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AttributeDetails](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-AttributeDetails"></a>
Mathematical expression and a list of attribute items specified in that expression.  
Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object  
Required: Yes

 ** [Conditions](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Conditions"></a>
The conditions including range, object count, and threshold for the calculated attribute.  
Type: [Conditions](API_connect-customer-profiles_Conditions.md) object  
Required: No

 ** [Description](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Description"></a>
The description of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [DisplayName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-DisplayName"></a>
The display name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$`   
Required: No

 ** [Filter](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Filter"></a>
Defines how to filter incoming objects to include part of the Calculated Attribute.  
Type: [Filter](API_connect-customer-profiles_Filter.md) object  
Required: No

 ** [Statistic](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Statistic"></a>
The aggregation operation to perform for the calculated attribute.  
Type: String  
Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE`   
Required: Yes

 ** [Tags](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [UseHistoricalData](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-UseHistoricalData"></a>
Whether historical data ingested before the Calculated Attribute was created should be included in calculations.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AttributeDetails": { 
      "Attributes": [ 
         { 
            "Name": "string"
         }
      ],
      "Expression": "string"
   },
   "CalculatedAttributeName": "string",
   "Conditions": { 
      "ObjectCount": number,
      "Range": { 
         "TimestampFormat": "string",
         "TimestampSource": "string",
         "Unit": "string",
         "Value": number,
         "ValueRange": { 
            "End": number,
            "Start": number
         }
      },
      "Threshold": { 
         "Operator": "string",
         "Value": "string"
      }
   },
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "Filter": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { 
                  "Attributes": { 
                     "string" : { 
                        "DimensionType": "string",
                        "Values": [ "string" ]
                     }
                  }
               }
            ],
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "LastUpdatedAt": number,
   "Readiness": { 
      "Message": "string",
      "ProgressPercentage": number
   },
   "Statistic": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UseHistoricalData": boolean
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttributeDetails](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-AttributeDetails"></a>
Mathematical expression and a list of attribute items specified in that expression.  
Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object

 ** [CalculatedAttributeName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [Conditions](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Conditions"></a>
The conditions including range, object count, and threshold for the calculated attribute.  
Type: [Conditions](API_connect-customer-profiles_Conditions.md) object

 ** [CreatedAt](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-CreatedAt"></a>
The timestamp of when the calculated attribute definition was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Description"></a>
The description of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [DisplayName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-DisplayName"></a>
The display name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` 

 ** [Filter](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Filter"></a>
The filter that was used as part of the request.  
Type: [Filter](API_connect-customer-profiles_Filter.md) object

 ** [LastUpdatedAt](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-LastUpdatedAt"></a>
The timestamp of when the calculated attribute definition was most recently edited.  
Type: Timestamp

 ** [Readiness](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Readiness"></a>
Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.  
Type: [Readiness](API_connect-customer-profiles_Readiness.md) object

 ** [Statistic](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Statistic"></a>
The aggregation operation to perform for the calculated attribute.  
Type: String  
Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` 

 ** [Status](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Status"></a>
Status of the Calculated Attribute creation (whether all historical data has been indexed.)  
Type: String  
Valid Values: `PREPARING | IN_PROGRESS | COMPLETED | FAILED` 

 ** [Tags](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [UseHistoricalData](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-UseHistoricalData"></a>
Whether historical data ingested before the Calculated Attribute was created should be included in calculations.  
Type: Boolean

## Errors
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition)