CustomerProfiles / Client / batch_get_calculated_attribute_for_profile
batch_get_calculated_attribute_for_profile#
- CustomerProfiles.Client.batch_get_calculated_attribute_for_profile(**kwargs)#
Fetch the possible attribute values given the attribute name.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_calculated_attribute_for_profile( CalculatedAttributeName='string', DomainName='string', ProfileIds=[ 'string', ], ConditionOverrides={ 'Range': { 'Start': 123, 'End': 123, 'Unit': 'DAYS' } } )
- Parameters:
CalculatedAttributeName (string) –
[REQUIRED]
The unique name of the calculated attribute.
DomainName (string) –
[REQUIRED]
The unique name of the domain.
ProfileIds (list) –
[REQUIRED]
List of unique identifiers for customer profiles to retrieve.
(string) –
ConditionOverrides (dict) –
Overrides the condition block within the original calculated attribute definition.
Range (dict) –
The relative time period over which data is included in the aggregation for this override.
Start (integer) – [REQUIRED]
The start time of when to include objects.
End (integer) –
The end time of when to include objects.
Unit (string) – [REQUIRED]
The unit for start and end.
- Return type:
dict
- Returns:
Response Syntax
{ 'Errors': [ { 'Code': 'string', 'Message': 'string', 'ProfileId': 'string' }, ], 'CalculatedAttributeValues': [ { 'CalculatedAttributeName': 'string', 'DisplayName': 'string', 'IsDataPartial': 'string', 'ProfileId': 'string', 'Value': 'string' }, ], 'ConditionOverrides': { 'Range': { 'Start': 123, 'End': 123, 'Unit': 'DAYS' } } }
Response Structure
(dict) –
Errors (list) –
List of errors for calculated attribute values that could not be retrieved.
(dict) –
Error object describing why a specific profile and calculated attribute failed.
Code (string) –
Status code for why a specific profile and calculated attribute failed.
Message (string) –
Message describing why a specific profile and calculated attribute failed.
ProfileId (string) –
The profile id that failed.
CalculatedAttributeValues (list) –
List of calculated attribute values retrieved.
(dict) –
The object containing the values of a single calculated attribute value.
CalculatedAttributeName (string) –
The unique name of the calculated attribute.
DisplayName (string) –
The display name of the calculated attribute.
IsDataPartial (string) –
Indicates whether the calculated attribute’s value is based on partial data. If the data is partial, it is set to true.
ProfileId (string) –
The profile id belonging to this calculated attribute value.
Value (string) –
The value of the calculated attribute.
ConditionOverrides (dict) –
Overrides the condition block within the original calculated attribute definition.
Range (dict) –
The relative time period over which data is included in the aggregation for this override.
Start (integer) –
The start time of when to include objects.
End (integer) –
The end time of when to include objects.
Unit (string) –
The unit for start and end.
Exceptions
CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.AccessDeniedException
CustomerProfiles.Client.exceptions.ResourceNotFoundException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.InternalServerException