entity_owners

Creates, updates, deletes, gets or lists an entity_owners resource.

Overview

Name	entity_owners
Type	Resource
Id	aws.datazone.entity_owners

Fields

The following fields are returned by SELECT queries:

list_entity_owners

Name	Datatype	Description
group	object	Specifies that the domain unit owner is a group.
user	object	Specifies that the domain unit owner is a user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_entity_owners	select	domain_identifier, entity_type, entity_identifier, region	maxResults, nextToken	Lists the entity (domain units) owners.
add_entity_owner	update	domain_identifier, entity_type, entity_identifier, region, owner		Adds the owner of an entity (a domain unit).
remove_entity_owner	exec	domain_identifier, entity_type, entity_identifier, region, owner		Removes an owner from an entity.

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_identifier	string	The ID of the domain where you want to remove an owner from an entity.
entity_identifier	string	The ID of the entity from which you want to remove an owner.
entity_type	string	The type of the entity from which you want to remove an owner.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of entities to return in a single call to ListEntityOwners. When the number of entities to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEntityOwners to list the next set of entities.
nextToken	string	When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

SELECT examples

list_entity_owners

Lists the entity (domain units) owners.

SELECT
group,
user
FROM aws.datazone.entity_owners
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND entity_type = '{{ entity_type }}' -- required
AND entity_identifier = '{{ entity_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

add_entity_owner

Adds the owner of an entity (a domain unit).

UPDATE aws.datazone.entity_owners
SET 
owner = '{{ owner }}',
clientToken = '{{ clientToken }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND entity_type = '{{ entity_type }}' --required
AND entity_identifier = '{{ entity_identifier }}' --required
AND region = '{{ region }}' --required
AND owner = '{{ owner }}' --required;

Lifecycle Methods

remove_entity_owner

Removes an owner from an entity.

EXEC aws.datazone.entity_owners.remove_entity_owner 
@domain_identifier='{{ domain_identifier }}' --required, 
@entity_type='{{ entity_type }}' --required, 
@entity_identifier='{{ entity_identifier }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"owner": "{{ owner }}", 
"clientToken": "{{ clientToken }}"
}'
;