asset_revisions

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

Overview

Name	asset_revisions
Type	Resource
Id	aws.datazone.asset_revisions

Fields

The following fields are returned by SELECT queries:

list_asset_revisions

Name	Datatype	Description
id	string	The identifier of the inventory asset revision. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
created_at	string (date-time)	The timestamp of when an inventory asset revison was created.
created_by	string	The Amazon DataZone user who created the asset revision.
domain_id	string	The Amazon DataZone user who created the inventory asset. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
revision	string	The revision details of the inventory asset.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_asset_revisions	select	domain_identifier, identifier, region	nextToken, maxResults	Lists the revisions for the asset. Prerequisites: The asset must exist in the domain. There must be at least one revision of the asset (which happens automatically after creation). The domain must be valid and active. User must have permissions on the asset and domain.
create_asset_revision	insert	domain_identifier, identifier, region, name		Creates a revision of the asset. Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary. Prerequisites: Asset must already exist in the domain with identifier. formsInput is required when asset has the form type. typeRevision should be the latest version of form type. The form content must include all required fields (e.g., bucketArn for S3ObjectCollectionForm). The owning project of the original asset must still exist and be active. User must have write access to the project and 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 unique identifier of the domain where the asset is being revised.
identifier	string	The identifier of the asset.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of revisions to return in a single call to ListAssetRevisions. When the number of revisions 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 ListAssetRevisions to list the next set of revisions.
nextToken	string	When the number of revisions 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 revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetRevisions to list the next set of revisions.

SELECT examples

list_asset_revisions

Lists the revisions for the asset. Prerequisites: The asset must exist in the domain. There must be at least one revision of the asset (which happens automatically after creation). The domain must be valid and active. User must have permissions on the asset and domain.

SELECT
id,
created_at,
created_by,
domain_id,
revision
FROM aws.datazone.asset_revisions
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_asset_revision

Creates a revision of the asset. Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary. Prerequisites: Asset must already exist in the domain with identifier. formsInput is required when asset has the form type. typeRevision should be the latest version of form type. The form content must include all required fields (e.g., bucketArn for S3ObjectCollectionForm). The owning project of the original asset must still exist and be active. User must have write access to the project and domain.

INSERT INTO aws.datazone.asset_revisions (
name,
typeRevision,
description,
glossaryTerms,
formsInput,
predictionConfiguration,
clientToken,
domain_identifier,
identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ typeRevision }}',
'{{ description }}',
'{{ glossaryTerms }}',
'{{ formsInput }}',
'{{ predictionConfiguration }}',
'{{ clientToken }}',
'{{ domain_identifier }}',
'{{ identifier }}',
'{{ region }}'
RETURNING
id,
name,
created_at,
created_by,
description,
domain_id,
external_identifier,
first_revision_created_at,
first_revision_created_by,
forms_output,
glossary_terms,
governed_glossary_terms,
latest_time_series_data_point_forms_output,
listing,
owning_project_id,
prediction_configuration,
read_only_forms_output,
revision,
type_identifier,
type_revision
;

Manifest

# Description fields are for documentation purposes
- name: asset_revisions
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the asset_revisions resource.
  - name: identifier
    value: "{{ identifier }}"
    description: Required parameter for the asset_revisions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the asset_revisions resource.
  - name: name
    value: "{{ name }}"
  - name: typeRevision
    value: "{{ typeRevision }}"
  - name: description
    value: "{{ description }}"
  - name: glossaryTerms
    value:
      - "{{ glossaryTerms }}"
  - name: formsInput
    value:
      - formName: "{{ formName }}"
        typeIdentifier: "{{ typeIdentifier }}"
        typeRevision: "{{ typeRevision }}"
        content: "{{ content }}"
  - name: predictionConfiguration
    description: |
      The configuration of the prediction.
    value:
      businessNameGeneration:
        enabled: {{ enabled }}
  - name: clientToken
    value: "{{ clientToken }}"