BatchGetCalculatedAttributeForProfile
Fetch the possible attribute values given the attribute name.
Request Syntax
POST /domains/DomainName
/calculated-attributes/CalculatedAttributeName
/batch-get-for-profiles HTTP/1.1
Content-type: application/json
{
"ConditionOverrides": {
"Range": {
"End": number
,
"Start": number
,
"Unit": "string
"
}
},
"ProfileIds": [ "string
" ]
}
URI Request Parameters
The request uses the following URI parameters.
- CalculatedAttributeName
-
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
-
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
The request accepts the following data in JSON format.
- ConditionOverrides
-
Overrides the condition block within the original calculated attribute definition.
Type: ConditionOverrides object
Required: No
- ProfileIds
-
List of unique identifiers for customer profiles to retrieve.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern:
[a-f0-9]{32}
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CalculatedAttributeValues": [
{
"CalculatedAttributeName": "string",
"DisplayName": "string",
"IsDataPartial": "string",
"ProfileId": "string",
"Value": "string"
}
],
"ConditionOverrides": {
"Range": {
"End": number,
"Start": number,
"Unit": "string"
}
},
"Errors": [
{
"Code": "string",
"Message": "string",
"ProfileId": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CalculatedAttributeValues
-
List of calculated attribute values retrieved.
Type: Array of CalculatedAttributeValue objects
- ConditionOverrides
-
Overrides the condition block within the original calculated attribute definition.
Type: ConditionOverrides object
- Errors
-
List of errors for calculated attribute values that could not be retrieved.
Type: Array of BatchGetCalculatedAttributeForProfileError objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
For more information about using this API in one of the language-specific AWS SDKs, see the following: