domain_object_types

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

Overview

Name	domain_object_types
Type	Resource
Id	aws.customer_profiles.domain_object_types

Fields

The following fields are returned by SELECT queries:

get_domain_object_type

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the domain object type was created.
description	string	The description of the domain object type.
encryption_key	string	The customer provided KMS key used to encrypt this type of domain object.
fields	object	A map of field names to their corresponding domain object type field definitions.
last_updated_at	string (date-time)	The timestamp of when the domain object type was most recently edited.
object_type_name	string	The unique name of the domain object type. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-]*$</code>)
tags	object	The tags used to organize, track, or control access for this resource.

list_domain_object_types

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the domain object type was created.
description	string	A description explaining the purpose and characteristics of this object type.
last_updated_at	string (date-time)	The timestamp of when the domain object type was most recently edited.
object_type_name	string	The name that identifies the object type within the domain. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-]*$</code>)
tags	object	The tags used to organize, track, or control access for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_domain_object_type	select	domain_name, object_type_name, region		Return a DomainObjectType for the input Domain and ObjectType names.
list_domain_object_types	select	domain_name, region	max-results, next-token	List all DomainObjectType(s) in a Customer Profiles domain.
put_domain_object_type	replace	domain_name, object_type_name, region		Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.
delete_domain_object_type	delete	domain_name, object_type_name, region		Delete a DomainObjectType for the given Domain and ObjectType name.

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 unique name of the domain object type.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of domain object types returned per page.
next-token	string	The pagination token from the previous call to ListDomainObjectTypes.

SELECT examples

get_domain_object_type

Return a DomainObjectType for the input Domain and ObjectType names.

SELECT
created_at,
description,
encryption_key,
fields,
last_updated_at,
object_type_name,
tags
FROM aws.customer_profiles.domain_object_types
WHERE domain_name = '{{ domain_name }}' -- required
AND object_type_name = '{{ object_type_name }}' -- required
AND region = '{{ region }}' -- required
;

list_domain_object_types

List all DomainObjectType(s) in a Customer Profiles domain.

SELECT
created_at,
description,
last_updated_at,
object_type_name,
tags
FROM aws.customer_profiles.domain_object_types
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

REPLACE examples

put_domain_object_type

Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.

REPLACE aws.customer_profiles.domain_object_types
SET 
Description = '{{ Description }}',
EncryptionKey = '{{ EncryptionKey }}',
Fields = '{{ Fields }}',
Tags = '{{ Tags }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND object_type_name = '{{ object_type_name }}' --required
AND region = '{{ region }}' --required
RETURNING
created_at,
description,
encryption_key,
fields,
last_updated_at,
object_type_name,
tags;

DELETE examples

delete_domain_object_type

Delete a DomainObjectType for the given Domain and ObjectType name.

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