metadata_generation_runs

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

Overview

Name	metadata_generation_runs
Type	Resource
Id	aws.datazone.metadata_generation_runs

Fields

The following fields are returned by SELECT queries:

get_metadata_generation_run

Name	Datatype	Description
id	string	The ID of the metadata generation run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
created_at	string (date-time)	The timestamp of when the metadata generation run was start.
created_by	string	The Amazon DataZone user who started the metadata generation run.
domain_id	string	The ID of the Amazon DataZone domain the metadata generation run of which you want to get. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
owning_project_id	string	The ID of the project that owns the assets for which you're running metadata generation. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
status	string	The status of the metadata generation run. (SUBMITTED, IN_PROGRESS, CANCELED, SUCCEEDED, FAILED, PARTIALLY_SUCCEEDED)
target	object	The asset for which you're generating metadata.
type_stats	array	The type stats included in the metadata generation run output details.
type_	string	The type of metadata generation run. (BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS)
types	array	The types of the metadata generation run.

list_metadata_generation_runs

Name	Datatype	Description
id	string	The ID of the metadata generation run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
created_at	string (date-time)	The timestamp at which the metadata generation run was created.
created_by	string	The user who created the metadata generation run.
domain_id	string	The ID of the Amazon DataZone domain in which the metadata generation run was created. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
owning_project_id	string	The ID of the project that owns the asset for which the metadata generation was ran. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
status	string	The status of the metadata generation run. (SUBMITTED, IN_PROGRESS, CANCELED, SUCCEEDED, FAILED, PARTIALLY_SUCCEEDED)
target	object	The asset for which metadata was generated.
type_	string	The type of the metadata generation run. (BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS)
types	array	The types of the metadata generation run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_metadata_generation_run	select	domain_identifier, identifier, region	type	Gets a metadata generation run in Amazon DataZone. Prerequisites: Valid domain and run identifier. The metadata generation run must exist. User must have read access to the metadata run.
list_metadata_generation_runs	select	domain_identifier, region	status, type, nextToken, maxResults, targetIdentifier	Lists all metadata generation runs. Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness. Prerequisites: Valid domain identifier. User must have access to metadata generation runs in the 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_identifier	string	The ID of the Amazon DataZone domain where you want to list metadata generation runs.
identifier	string	The identifier of the metadata generation run.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs 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 ListMetadataGenerationRuns to list the next set of revisions.
nextToken	string	When the number of metadata generation runs 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 metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.
status	string	The status of the metadata generation runs.
targetIdentifier	string	The target ID for which you want to list metadata generation runs.
type	string	The type of the metadata generation runs.

SELECT examples

get_metadata_generation_run

Gets a metadata generation run in Amazon DataZone. Prerequisites: Valid domain and run identifier. The metadata generation run must exist. User must have read access to the metadata run.

SELECT
id,
created_at,
created_by,
domain_id,
owning_project_id,
status,
target,
type_stats,
type_,
types
FROM aws.datazone.metadata_generation_runs
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND type = '{{ type }}'
;

list_metadata_generation_runs

Lists all metadata generation runs. Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness. Prerequisites: Valid domain identifier. User must have access to metadata generation runs in the domain.

SELECT
id,
created_at,
created_by,
domain_id,
owning_project_id,
status,
target,
type_,
types
FROM aws.datazone.metadata_generation_runs
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND status = '{{ status }}'
AND type = '{{ type }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND targetIdentifier = '{{ targetIdentifier }}'
;