asset_types

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

Overview

Name	asset_types
Type	Resource
Id	aws.datazone.asset_types

Fields

The following fields are returned by SELECT queries:

get_asset_type

Name	Datatype	Description
name	string	The name of the asset type. (pattern: <code>[^.].</code>)
created_at	string (date-time)	The timestamp of when the asset type was created.
created_by	string	The Amazon DataZone user who created the asset type.
description	string	The description of the asset type.
domain_id	string	The ID of the Amazon DataZone domain in which the asset type exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
forms_output	object	The metadata forms attached to the asset type.
origin_domain_id	string	The ID of the Amazon DataZone domain in which the asset type was originally created. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
origin_project_id	string	The ID of the Amazon DataZone project in which the asset type was originally created. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
owning_project_id	string	The ID of the Amazon DataZone project that owns the asset type. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
revision	string	The revision of the asset type.
updated_at	string (date-time)	The timestamp of when the asset type was updated.
updated_by	string	The Amazon DataZone user that updated the asset type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_asset_type	select	domain_identifier, identifier, region	revision	Gets an Amazon DataZone asset type. Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other Amazon Web Services services. Asset types can range from built-in types like Amazon S3 buckets and Amazon Web Services Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial for properly organizing and managing different kinds of data resources. Prerequisites: The asset type with identifier must exist in the domain. ResourceNotFoundException. You must have the GetAssetType permission. Ensure the domain-identifier value is correct and accessible.
create_asset_type	insert	domain_identifier, region, name, formsInput, owningProjectIdentifier		Creates a custom asset type. Prerequisites: The formsInput field is required, however, can be passed as empty (e.g. -forms-input {}). You must have CreateAssetType permissions. The domain-identifier and owning-project-identifier must be valid and active. The name of the asset type must be unique within the domain — duplicate names will cause failure. JSON input must be valid — incorrect formatting causes Invalid JSON errors.
delete_asset_type	delete	domain_identifier, identifier, region		Deletes an asset type in Amazon DataZone. Prerequisites: The asset type must exist in the domain. You must have DeleteAssetType permission. The asset type must not be in use (e.g., assigned to any asset). If used, deletion will fail. You should retrieve the asset type using get-asset-type to confirm its presence before deletion.

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 in which the asset type is deleted.
identifier	string	The identifier of the asset type that is deleted.
region	string	AWS region (default: us-east-1)
revision	string	The revision of the asset type.

SELECT examples

get_asset_type

Gets an Amazon DataZone asset type. Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other Amazon Web Services services. Asset types can range from built-in types like Amazon S3 buckets and Amazon Web Services Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial for properly organizing and managing different kinds of data resources. Prerequisites: The asset type with identifier must exist in the domain. ResourceNotFoundException. You must have the GetAssetType permission. Ensure the domain-identifier value is correct and accessible.

SELECT
name,
created_at,
created_by,
description,
domain_id,
forms_output,
origin_domain_id,
origin_project_id,
owning_project_id,
revision,
updated_at,
updated_by
FROM aws.datazone.asset_types
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND revision = '{{ revision }}'
;

INSERT examples

create_asset_type

Creates a custom asset type. Prerequisites: The formsInput field is required, however, can be passed as empty (e.g. -forms-input {}). You must have CreateAssetType permissions. The domain-identifier and owning-project-identifier must be valid and active. The name of the asset type must be unique within the domain — duplicate names will cause failure. JSON input must be valid — incorrect formatting causes Invalid JSON errors.

INSERT INTO aws.datazone.asset_types (
name,
description,
formsInput,
owningProjectIdentifier,
domain_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ formsInput }}' /* required */,
'{{ owningProjectIdentifier }}' /* required */,
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
name,
created_at,
created_by,
description,
domain_id,
forms_output,
origin_domain_id,
origin_project_id,
owning_project_id,
revision,
updated_at,
updated_by
;

Manifest

# Description fields are for documentation purposes
- name: asset_types
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the asset_types resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the asset_types resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: formsInput
    value: "{{ formsInput }}"
  - name: owningProjectIdentifier
    value: "{{ owningProjectIdentifier }}"

DELETE examples

delete_asset_type

Deletes an asset type in Amazon DataZone. Prerequisites: The asset type must exist in the domain. You must have DeleteAssetType permission. The asset type must not be in use (e.g., assigned to any asset). If used, deletion will fail. You should retrieve the asset type using get-asset-type to confirm its presence before deletion.

DELETE FROM aws.datazone.asset_types
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;