domains

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

Overview

Name	domains
Type	Resource
Id	aws.datazone.domains

Fields

The following fields are returned by SELECT queries:

search

Name	Datatype	Description
items_	array	The results of the Search action.
next_token	string	When the number of results 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 results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.
total_match_count	integer	Total number of search results.

get_domain

Name	Datatype	Description
id	string	The identifier of the specified Amazon DataZone domain. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
name	string	The name of the Amazon DataZone domain.
arn	string	The ARN of the specified Amazon DataZone domain.
created_at	string (date-time)	The timestamp of when the Amazon DataZone domain was created.
description	string	The description of the Amazon DataZone domain.
domain_execution_role	string	The domain execution role with which the Amazon DataZone domain is created. (pattern: <code>arn:aws[^:]:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)/[a-zA-Z0-9+=,.@_-]+</code>)
domain_version	string	The version of the domain. (V1, V2)
kms_key_identifier	string	The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. (pattern: <code>arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
last_updated_at	string (date-time)	The timestamp of when the Amazon DataZone domain was last updated.
portal_url	string	The URL of the data portal for this Amazon DataZone domain.
root_domain_unit_id	string	The ID of the root domain in Amazon Datazone. (pattern: <code>[a-z0-9_-]+</code>)
service_role	string	The service role of the domain. (pattern: <code>arn:aws[^:]:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)/[a-zA-Z0-9+=,.@_-]+</code>)
single_sign_on	object	The single sign-on details in Amazon DataZone.
status	string	The status of the specified Amazon DataZone domain. (CREATING, AVAILABLE, CREATION_FAILED, DELETING, DELETED, DELETION_FAILED)
tags	object	The tags specified for the Amazon DataZone domain.

list_domains

Name	Datatype	Description
id	string	The ID of the Amazon DataZone domain. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
name	string	A name of an Amazon DataZone domain.
arn	string	The ARN of the Amazon DataZone domain.
created_at	string (date-time)	A timestamp of when a Amazon DataZone domain was created.
description	string	A description of an Amazon DataZone domain.
domain_version	string	The domain version. (V1, V2)
last_updated_at	string (date-time)	A timestamp of when a Amazon DataZone domain was last updated.
managed_account_id	string	The identifier of the Amazon Web Services account that manages the domain.
portal_url	string	The data portal URL for the Amazon DataZone domain.
status	string	The status of the Amazon DataZone domain. (CREATING, AVAILABLE, CREATION_FAILED, DELETING, DELETED, DELETION_FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search	select	domain_identifier, region		Searches for assets in Amazon DataZone. Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently. Many search commands in Amazon DataZone are paginated, including search and search-types. When the result set is large, Amazon DataZone returns a nextToken in the response. This token can be used to retrieve the next page of results. Prerequisites: The --domain-identifier must refer to an existing Amazon DataZone domain. --search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY. The user must have search permissions in the specified domain. If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys. For paginated results, be prepared to use --next-token to fetch additional pages. To run a standard free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable. To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with @amazon.datazone#sortable), provide a filter using the intValue parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with @amazon.datazone#searchable for free-text search). Create/update timestamp filtering is supported using the special creationTime/lastUpdatedTime attributes. Filter types can be mixed and matched to power complex queries. To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.
get_domain	select	identifier, region		Gets an Amazon DataZone domain.
list_domains	select	region	status, maxResults, nextToken	Lists Amazon DataZone domains.
create_domain	insert	region, name		Creates an Amazon DataZone domain.
associate_governed_terms	update	domain_identifier, entity_identifier, entity_type, region, governedGlossaryTerms		Associates governed terms with an asset.
update_root_domain_unit_owner	update	domain_identifier, region, currentOwner, newOwner		Updates the owner of the root domain unit.
update_domain	update	identifier, region	clientToken	Updates a Amazon DataZone domain.
delete_domain	delete	identifier, region	clientToken, skipDeletionCheck	Deletes a Amazon DataZone domain.
accept_predictions	exec	domain_identifier, identifier, region	revision	Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.
batch_put_attributes_metadata	exec	domain_identifier, entity_type, entity_identifier, region, attributes		Writes the attribute metadata.
cancel_metadata_generation_run	exec	domain_identifier, identifier, region		Cancels the metadata generation run. Prerequisites: The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS). Runs in SUCCEEDED status cannot be cancelled. User must have access to the run and cancel permissions.
cancel_subscription	exec	domain_identifier, identifier, region		Cancels the subscription to the specified asset.
disassociate_governed_terms	exec	domain_identifier, entity_identifier, entity_type, region, governedGlossaryTerms		Disassociates restricted terms from an asset.
post_lineage_event	exec	domain_identifier, region, event	Client-Token	Posts a data lineage event.
start_metadata_generation_run	exec	domain_identifier, region, target, owningProjectIdentifier		Starts the metadata generation run. Prerequisites: Asset must be created and belong to the specified domain and project. Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table). Asset must have a structured schema with valid rows and columns. Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS. The user must have permission to run metadata generation in the domain/project.
query_graph	exec	domain_identifier, region, match	maxResults, nextToken	Queries entities in the graph store.
reject_predictions	exec	domain_identifier, identifier, region	revision	Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.

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 identifier of the Amazon DataZone domain.
entity_identifier	string	The ID of an asset from which you want to disassociate restricted terms.
entity_type	string	The type of the asset from which you want to disassociate restricted terms.
identifier	string	The identifier of the prediction.
region	string	AWS region (default: us-east-1)
Client-Token	string	A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
clientToken	string	A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
maxResults	integer	The maximum number of entities to return in a single call to QueryGraph. 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 QueryGraph 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 QueryGraph to list the next set of entities.
revision	string	The revision that is to be made to the asset.
skipDeletionCheck	boolean	Specifies the optional flag to delete all child entities within the domain.
status	string	The status of the data source.

SELECT examples

search

Searches for assets in Amazon DataZone. Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently. Many search commands in Amazon DataZone are paginated, including search and search-types. When the result set is large, Amazon DataZone returns a nextToken in the response. This token can be used to retrieve the next page of results. Prerequisites: The --domain-identifier must refer to an existing Amazon DataZone domain. --search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY. The user must have search permissions in the specified domain. If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys. For paginated results, be prepared to use --next-token to fetch additional pages. To run a standard free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable. To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with @amazon.datazone#sortable), provide a filter using the intValue parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with @amazon.datazone#searchable for free-text search). Create/update timestamp filtering is supported using the special creationTime/lastUpdatedTime attributes. Filter types can be mixed and matched to power complex queries. To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.

SELECT
items_,
next_token,
total_match_count
FROM aws.datazone.domains
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
;

get_domain

Gets an Amazon DataZone domain.

SELECT
id,
name,
arn,
created_at,
description,
domain_execution_role,
domain_version,
kms_key_identifier,
last_updated_at,
portal_url,
root_domain_unit_id,
service_role,
single_sign_on,
status,
tags
FROM aws.datazone.domains
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_domains

Lists Amazon DataZone domains.

SELECT
id,
name,
arn,
created_at,
description,
domain_version,
last_updated_at,
managed_account_id,
portal_url,
status
FROM aws.datazone.domains
WHERE region = '{{ region }}' -- required
AND status = '{{ status }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_domain

Creates an Amazon DataZone domain.

INSERT INTO aws.datazone.domains (
name,
description,
singleSignOn,
domainExecutionRole,
kmsKeyIdentifier,
tags,
domainVersion,
serviceRole,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ singleSignOn }}',
'{{ domainExecutionRole }}',
'{{ kmsKeyIdentifier }}',
'{{ tags }}',
'{{ domainVersion }}',
'{{ serviceRole }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
id,
name,
arn,
description,
domain_execution_role,
domain_version,
kms_key_identifier,
portal_url,
root_domain_unit_id,
service_role,
single_sign_on,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domains resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: singleSignOn
    description: |
      The single sign-on details in Amazon DataZone.
    value:
      type_: "{{ type_ }}"
      userAssignment: "{{ userAssignment }}"
      idcInstanceArn: "{{ idcInstanceArn }}"
  - name: domainExecutionRole
    value: "{{ domainExecutionRole }}"
  - name: kmsKeyIdentifier
    value: "{{ kmsKeyIdentifier }}"
  - name: tags
    value: "{{ tags }}"
  - name: domainVersion
    value: "{{ domainVersion }}"
    valid_values: ['V1', 'V2']
  - name: serviceRole
    value: "{{ serviceRole }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

associate_governed_terms

Associates governed terms with an asset.

UPDATE aws.datazone.domains
SET 
governedGlossaryTerms = '{{ governedGlossaryTerms }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND entity_identifier = '{{ entity_identifier }}' --required
AND entity_type = '{{ entity_type }}' --required
AND region = '{{ region }}' --required
AND governedGlossaryTerms = '{{ governedGlossaryTerms }}' --required;

update_root_domain_unit_owner

Updates the owner of the root domain unit.

UPDATE aws.datazone.domains
SET 
currentOwner = '{{ currentOwner }}',
newOwner = '{{ newOwner }}',
clientToken = '{{ clientToken }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND region = '{{ region }}' --required
AND currentOwner = '{{ currentOwner }}' --required
AND newOwner = '{{ newOwner }}' --required;

update_domain

Updates a Amazon DataZone domain.

UPDATE aws.datazone.domains
SET 
description = '{{ description }}',
singleSignOn = '{{ singleSignOn }}',
domainExecutionRole = '{{ domainExecutionRole }}',
serviceRole = '{{ serviceRole }}',
name = '{{ name }}'
WHERE 
identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken}}'
RETURNING
id,
name,
description,
domain_execution_role,
last_updated_at,
root_domain_unit_id,
service_role,
single_sign_on;

DELETE examples

delete_domain

Deletes a Amazon DataZone domain.

DELETE FROM aws.datazone.domains
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
AND skipDeletionCheck = '{{ skipDeletionCheck }}'
;

Lifecycle Methods

accept_predictions

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

EXEC aws.datazone.domains.accept_predictions 
@domain_identifier='{{ domain_identifier }}' --required, 
@identifier='{{ identifier }}' --required, 
@region='{{ region }}' --required, 
@revision='{{ revision }}' 
@@json=
'{
"acceptRule": "{{ acceptRule }}", 
"acceptChoices": "{{ acceptChoices }}", 
"clientToken": "{{ clientToken }}"
}'
;

batch_put_attributes_metadata

Writes the attribute metadata.

EXEC aws.datazone.domains.batch_put_attributes_metadata 
@domain_identifier='{{ domain_identifier }}' --required, 
@entity_type='{{ entity_type }}' --required, 
@entity_identifier='{{ entity_identifier }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"clientToken": "{{ clientToken }}", 
"attributes": "{{ attributes }}"
}'
;

cancel_metadata_generation_run

Cancels the metadata generation run. Prerequisites: The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS). Runs in SUCCEEDED status cannot be cancelled. User must have access to the run and cancel permissions.

EXEC aws.datazone.domains.cancel_metadata_generation_run 
@domain_identifier='{{ domain_identifier }}' --required, 
@identifier='{{ identifier }}' --required, 
@region='{{ region }}' --required
;

cancel_subscription

Cancels the subscription to the specified asset.

EXEC aws.datazone.domains.cancel_subscription 
@domain_identifier='{{ domain_identifier }}' --required, 
@identifier='{{ identifier }}' --required, 
@region='{{ region }}' --required
;

disassociate_governed_terms

Disassociates restricted terms from an asset.

EXEC aws.datazone.domains.disassociate_governed_terms 
@domain_identifier='{{ domain_identifier }}' --required, 
@entity_identifier='{{ entity_identifier }}' --required, 
@entity_type='{{ entity_type }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"governedGlossaryTerms": "{{ governedGlossaryTerms }}"
}'
;

post_lineage_event

Posts a data lineage event.

EXEC aws.datazone.domains.post_lineage_event 
@domain_identifier='{{ domain_identifier }}' --required, 
@region='{{ region }}' --required, 
@Client-Token='{{ Client-Token }}' 
@@json=
'{
"event": "{{ event }}"
}'
;

start_metadata_generation_run

Starts the metadata generation run. Prerequisites: Asset must be created and belong to the specified domain and project. Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table). Asset must have a structured schema with valid rows and columns. Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS. The user must have permission to run metadata generation in the domain/project.

EXEC aws.datazone.domains.start_metadata_generation_run 
@domain_identifier='{{ domain_identifier }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"type": "{{ type }}", 
"types": "{{ types }}", 
"target": "{{ target }}", 
"clientToken": "{{ clientToken }}", 
"owningProjectIdentifier": "{{ owningProjectIdentifier }}"
}'
;

query_graph

Queries entities in the graph store.

EXEC aws.datazone.domains.query_graph 
@domain_identifier='{{ domain_identifier }}' --required, 
@region='{{ region }}' --required, 
@maxResults='{{ maxResults }}', 
@nextToken='{{ nextToken }}' 
@@json=
'{
"match": "{{ match }}", 
"additionalAttributes": "{{ additionalAttributes }}"
}'
;

reject_predictions

Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.

EXEC aws.datazone.domains.reject_predictions 
@domain_identifier='{{ domain_identifier }}' --required, 
@identifier='{{ identifier }}' --required, 
@region='{{ region }}' --required, 
@revision='{{ revision }}' 
@@json=
'{
"rejectRule": "{{ rejectRule }}", 
"rejectChoices": "{{ rejectChoices }}", 
"clientToken": "{{ clientToken }}"
}'
;