Skip to content

Create Data Product

datazone_create_data_product R Documentation

Creates a data product

Description

Creates a data product.

A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It's designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance.

Prerequisites:

  • The domain must exist and be accessible.

  • The owning project must be valid and active.

  • The name must be unique within the domain (no existing data product with the same name).

  • User must have create permissions for data products in the project.

Usage

datazone_create_data_product(domainIdentifier, name,
  owningProjectIdentifier, description, glossaryTerms, formsInput, items,
  clientToken)

Arguments

domainIdentifier

[required] The ID of the domain where the data product is created.

name

[required] The name of the data product.

owningProjectIdentifier

[required] The ID of the owning project of the data product.

description

The description of the data product.

glossaryTerms

The glossary terms of the data product.

formsInput

The metadata forms of the data product.

items

The data assets of the data product.

clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Value

A list with the following syntax:

list(
  domainId = "string",
  id = "string",
  revision = "string",
  owningProjectId = "string",
  name = "string",
  status = "CREATED"|"CREATING"|"CREATE_FAILED",
  description = "string",
  glossaryTerms = list(
    "string"
  ),
  items = list(
    list(
      itemType = "ASSET",
      identifier = "string",
      revision = "string",
      glossaryTerms = list(
        "string"
      )
    )
  ),
  formsOutput = list(
    list(
      formName = "string",
      typeName = "string",
      typeRevision = "string",
      content = "string"
    )
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  firstRevisionCreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  firstRevisionCreatedBy = "string"
)

Request syntax

svc$create_data_product(
  domainIdentifier = "string",
  name = "string",
  owningProjectIdentifier = "string",
  description = "string",
  glossaryTerms = list(
    "string"
  ),
  formsInput = list(
    list(
      formName = "string",
      typeIdentifier = "string",
      typeRevision = "string",
      content = "string"
    )
  ),
  items = list(
    list(
      itemType = "ASSET",
      identifier = "string",
      revision = "string",
      glossaryTerms = list(
        "string"
      )
    )
  ),
  clientToken = "string"
)