Skip to content

Creates a metadata form type

Description

Creates a metadata form type.

Prerequisites:

  • The domain must exist and be in an ENABLED state.
  • The owning project must exist and be accessible.
  • The name must be unique within the domain.

For custom form types, to indicate that a field should be searchable, annotate it with @amazon.datazone#searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. To indicate that a field should be indexed for lexical search (which disables semantic search but supports stemmed and partial matches), annotate it with @amazon.datazone#searchable(modes:["LEXICAL"]). To indicate that a field should be indexed for technical identifier search (for more information on technical identifier search, see: https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/), annotate it with @amazon.datazone#searchable(modes:["TECHNICAL"]).

To denote that a field will store glossary term ids (which are filterable via the Search/SearchListings APIs), annotate it with @amazon.datazone#glossaryterm("${GLOSSARY_ID}"), where ${GLOSSARY_ID} is the id of the glossary that the glossary terms stored in the field belong to.

Usage

datazone_create_form_type(domainIdentifier, name, model,
  owningProjectIdentifier, status, description)

Arguments

  • domainIdentifier

[required] The ID of the Amazon DataZone domain in which this metadata form type is created.

  • name

[required] The name of this Amazon DataZone metadata form type.

  • model

[required] The model of this Amazon DataZone metadata form type.

  • owningProjectIdentifier

[required] The ID of the Amazon DataZone project that owns this metadata form type.

  • status

The status of this Amazon DataZone metadata form type.

  • description

The description of this Amazon DataZone metadata form type.

Value

A list with the following syntax:

list(
  domainId = "string",
  name = "string",
  revision = "string",
  description = "string",
  owningProjectId = "string",
  originDomainId = "string",
  originProjectId = "string"
)

Request syntax

svc$create_form_type(
  domainIdentifier = "string",
  name = "string",
  model = list(
    smithy = "string"
  ),
  owningProjectIdentifier = "string",
  status = "ENABLED"|"DISABLED",
  description = "string"
)