data_product_revisions

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

Overview

Name	data_product_revisions
Type	Resource
Id	aws.datazone.data_product_revisions

Fields

The following fields are returned by SELECT queries:

list_data_product_revisions

Name	Datatype	Description
id	string	The ID of the data product revision. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
created_at	string (date-time)	The timestamp at which the data product revision was created.
created_by	string	The user who created the data product revision.
domain_id	string	The ID of the domain where the data product revision lives. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
revision	string	The data product revision.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_data_product_revisions	select	domain_identifier, identifier, region	maxResults, nextToken	Lists data product revisions. Prerequisites: The data product ID must exist within the domain. User must have view permissions on the data product. The domain must be in a valid and accessible state.
create_data_product_revision	insert	domain_identifier, identifier, region, name		Creates a data product revision. Prerequisites: The original data product must exist in the given domain. User must have permissions on the data product. The domain must be valid and accessible. The new revision name must comply with naming constraints (if required).

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 the data product revision is created.
identifier	string	The ID of the data product revision.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of asset filters to return in a single call to ListDataProductRevisions. When the number of data product 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 ListDataProductRevisions to list the next set of data product revisions.
nextToken	string	When the number of data product 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 data product revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

SELECT examples

list_data_product_revisions

Lists data product revisions. Prerequisites: The data product ID must exist within the domain. User must have view permissions on the data product. The domain must be in a valid and accessible state.

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

INSERT examples

create_data_product_revision

Creates a data product revision. Prerequisites: The original data product must exist in the given domain. User must have permissions on the data product. The domain must be valid and accessible. The new revision name must comply with naming constraints (if required).

INSERT INTO aws.datazone.data_product_revisions (
name,
description,
glossaryTerms,
items,
formsInput,
clientToken,
domain_identifier,
identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ glossaryTerms }}',
'{{ items }}',
'{{ formsInput }}',
'{{ clientToken }}',
'{{ domain_identifier }}',
'{{ identifier }}',
'{{ region }}'
RETURNING
id,
name,
created_at,
created_by,
description,
domain_id,
first_revision_created_at,
first_revision_created_by,
forms_output,
glossary_terms,
items_,
owning_project_id,
revision,
status
;

Manifest

# Description fields are for documentation purposes
- name: data_product_revisions
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the data_product_revisions resource.
  - name: identifier
    value: "{{ identifier }}"
    description: Required parameter for the data_product_revisions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_product_revisions resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: glossaryTerms
    value:
      - "{{ glossaryTerms }}"
  - name: items
    value:
      - itemType: "{{ itemType }}"
        identifier: "{{ identifier }}"
        revision: "{{ revision }}"
        glossaryTerms: "{{ glossaryTerms }}"
  - name: formsInput
    value:
      - formName: "{{ formName }}"
        typeIdentifier: "{{ typeIdentifier }}"
        typeRevision: "{{ typeRevision }}"
        content: "{{ content }}"
  - name: clientToken
    value: "{{ clientToken }}"