profile_history_records

Creates, updates, deletes, gets or lists a profile_history_records resource.

Overview

Name	profile_history_records
Type	Resource
Id	aws.customer_profiles.profile_history_records

Fields

The following fields are returned by SELECT queries:

get_profile_history_record

Name	Datatype	Description
action_type	string	The action type of the profile history record. (ADDED_PROFILE_KEY, DELETED_PROFILE_KEY, CREATED, UPDATED, INGESTED, DELETED_BY_CUSTOMER, EXPIRED, MERGED, DELETED_BY_MERGE)
content	string	A string containing the customer profile, profile object, or profile key content.
created_at	string (date-time)	The timestamp of when the profile history record was created.
id	string	The unique identifier of the profile history record. (pattern: <code>[a-f0-9]{32}</code>)
last_updated_at	string (date-time)	The timestamp of when the profile history record was last updated.
object_type_name	string	The name of the profile object type. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-]*$</code>)
performed_by	string	The Amazon Resource Name (ARN) of the person or service principal who performed the action.
profile_object_unique_key	string	The unique identifier of the profile object generated by the service.

list_profile_history_records

Name	Datatype	Description
next_token	string	If there are additional results, this is the token for the next set of results.
profile_history_records	array	The list of profile history records.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile_history_record	select	domain_name, profile_id, id, region		Returns a history record for a specific profile, for a specific domain.
list_profile_history_records	select	domain_name, region	next-token, max-results	Returns a list of history records for a specific profile, for a specific domain.

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
domain_name	string	The unique name of the domain for which to return profile history records.
id	string	The unique identifier of the profile history record to return.
profile_id	string	The unique identifier of the profile for which to return a history record.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return per page.
next-token	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

get_profile_history_record

Returns a history record for a specific profile, for a specific domain.

SELECT
action_type,
content,
created_at,
id,
last_updated_at,
object_type_name,
performed_by,
profile_object_unique_key
FROM aws.customer_profiles.profile_history_records
WHERE domain_name = '{{ domain_name }}' -- required
AND profile_id = '{{ profile_id }}' -- required
AND id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_profile_history_records

Returns a list of history records for a specific profile, for a specific domain.

SELECT
next_token,
profile_history_records
FROM aws.customer_profiles.profile_history_records
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;