Skip to content

/AWS1/IF_DZN=>CREATEFORMTYPE()

About CreateFormType

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.

Method Signature

METHODS /AWS1/IF_DZN~CREATEFORMTYPE
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_NAME TYPE /AWS1/DZNFORMTYPENAME OPTIONAL
    !IO_MODEL TYPE REF TO /AWS1/CL_DZNMODEL OPTIONAL
    !IV_OWNINGPROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_STATUS TYPE /AWS1/DZNFORMTYPESTATUS OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/DZNDESCRIPTION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dzncreateformtypeout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNCONFLICTEXCEPTION
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNSERVICEQUOTAEXCDEX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

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

iv_name TYPE /AWS1/DZNFORMTYPENAME /AWS1/DZNFORMTYPENAME

The name of this Amazon DataZone metadata form type.

io_model TYPE REF TO /AWS1/CL_DZNMODEL /AWS1/CL_DZNMODEL

The model of this Amazon DataZone metadata form type.

iv_owningprojectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

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

Optional arguments:

iv_status TYPE /AWS1/DZNFORMTYPESTATUS /AWS1/DZNFORMTYPESTATUS

The status of this Amazon DataZone metadata form type.

iv_description TYPE /AWS1/DZNDESCRIPTION /AWS1/DZNDESCRIPTION

The description of this Amazon DataZone metadata form type.

RETURNING

oo_output TYPE REF TO /aws1/cl_dzncreateformtypeout /AWS1/CL_DZNCREATEFORMTYPEOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createformtype(
  io_model = new /aws1/cl_dznmodel( |string| )
  iv_description = |string|
  iv_domainidentifier = |string|
  iv_name = |string|
  iv_owningprojectidentifier = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_domainid = lo_result->get_domainid( ).
  lv_formtypename = lo_result->get_name( ).
  lv_revision = lo_result->get_revision( ).
  lv_description = lo_result->get_description( ).
  lv_projectid = lo_result->get_owningprojectid( ).
  lv_domainid = lo_result->get_origindomainid( ).
  lv_projectid = lo_result->get_originprojectid( ).
ENDIF.