profile_object_types

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

Overview

Name	profile_object_types
Type	Resource
Id	aws.customer_profiles.profile_object_types

Fields

The following fields are returned by SELECT queries:

get_profile_object_type

Name	Datatype	Description
allow_profile_creation	boolean	Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
created_at	string (date-time)	The timestamp of when the domain was created.
description	string	The description of the profile object type.
encryption_key	string	The customer-provided key to encrypt the profile object that will be created in this profile object type.
expiration_days	integer	The number of days until the data in the object expires.
fields	object	A map of the name and ObjectType field.
keys	object	A list of unique keys that can be used to map data to the profile.
last_updated_at	string (date-time)	The timestamp of when the domain was most recently edited.
max_available_profile_object_count	integer	The amount of provisioned profile object max count available.
max_profile_object_count	integer	The amount of profile object max count assigned to the object type.
object_type_name	string	The name of the profile object type. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-]*$</code>)
source_last_updated_timestamp_format	string	The format of your sourceLastUpdatedTimestamp that was previously set up.
source_priority	integer	An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority.
tags	object	The tags used to organize, track, or control access for this resource.
template_id	string	A unique identifier for the object template. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)

list_profile_object_types

Name	Datatype	Description
items	array	The list of ListProfileObjectTypes instances.
next_token	string	Identifies the next page of results to return.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile_object_type	select	domain_name, object_type_name, region		Returns the object types for a specific domain.
list_profile_object_types	select	domain_name, region	next-token, max-results	Lists all of the templates available within the service.
put_profile_object_type	replace	domain_name, object_type_name, region		Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
delete_profile_object_type	delete	domain_name, object_type_name, region		Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.

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.
object_type_name	string	The name of the profile object type.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of objects returned per page.
next-token	string	Identifies the next page of results to return.

SELECT examples

get_profile_object_type

Returns the object types for a specific domain.

SELECT
allow_profile_creation,
created_at,
description,
encryption_key,
expiration_days,
fields,
keys,
last_updated_at,
max_available_profile_object_count,
max_profile_object_count,
object_type_name,
source_last_updated_timestamp_format,
source_priority,
tags,
template_id
FROM aws.customer_profiles.profile_object_types
WHERE domain_name = '{{ domain_name }}' -- required
AND object_type_name = '{{ object_type_name }}' -- required
AND region = '{{ region }}' -- required
;

list_profile_object_types

Lists all of the templates available within the service.

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

REPLACE examples

put_profile_object_type

Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource/UntagResource.

REPLACE aws.customer_profiles.profile_object_types
SET 
Description = '{{ Description }}',
TemplateId = '{{ TemplateId }}',
ExpirationDays = {{ ExpirationDays }},
EncryptionKey = '{{ EncryptionKey }}',
AllowProfileCreation = {{ AllowProfileCreation }},
SourceLastUpdatedTimestampFormat = '{{ SourceLastUpdatedTimestampFormat }}',
MaxProfileObjectCount = {{ MaxProfileObjectCount }},
SourcePriority = {{ SourcePriority }},
Fields = '{{ Fields }}',
Keys = '{{ Keys }}',
Tags = '{{ Tags }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND object_type_name = '{{ object_type_name }}' --required
AND region = '{{ region }}' --required
RETURNING
allow_profile_creation,
created_at,
description,
encryption_key,
expiration_days,
fields,
keys,
last_updated_at,
max_available_profile_object_count,
max_profile_object_count,
object_type_name,
source_last_updated_timestamp_format,
source_priority,
tags,
template_id;

DELETE examples

delete_profile_object_type

Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.

DELETE FROM aws.customer_profiles.profile_object_types
WHERE domain_name = '{{ domain_name }}' --required
AND object_type_name = '{{ object_type_name }}' --required
AND region = '{{ region }}' --required
;