CreateFormType

Creates a metadata form type.

Prerequisites:

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.

Request Syntax

POST /v2/domains/domainIdentifier/form-types HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "model": { ... },
   "name": "string",
   "owningProjectIdentifier": "string",
   "status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Request Body

The request accepts the following data in JSON format.

Response Syntax

HTTP/1.1 201
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "name": "string",
   "originDomainId": "string",
   "originProjectId": "string",
   "owningProjectId": "string",
   "revision": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example illustrates one usage of CreateFormType.

Sample Request

aws datazone create-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj9vn4wxyz8k2m" \
--name "DataProductMetadataForm" \
--status ENABLED \
--model '{ 
    "smithy": "namespace dzd_53ielnpxktdilj\n\nstructure DataProductMetadataForm {\n @required\n name: smithy.api#String,\n @required\n databaseName: smithy.api#String,\n @required\n catalog: smithy.api#String\n}" 
}'
            

Sample Response

{
    "domainId": "dzd_53ielnpxktdilj",
    "name": "DataProductMetadataForm",
    "revision": "1"
}
            

Example

Failure case - missing parameter:

Sample Request

aws datazone create-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerPreferencesFormType" \
--model '{"smithy": "structure CustomerPreferencesFormType { }"}'
    

Sample Response

aws: error: the following arguments are required: —owning-project-identifier
    

Example

Failure case - wrong Smithy:

Sample Request

aws datazone create-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerPreferencesFormType" \
--model '{"smithy": "structure CustomerPreferencesFormType {"}'  # malformed closing brace

            

Sample Response

Unknown options: malformed, closing, brace, #
            

Example

This example illustrates a usage of CreateFormType, using Smithy traits to specify that attributes should be indexed for search. In this case, we will create a single required field name that will be indexed for technical identifier search.

Sample Request

aws datazone create-form-type \
--domain-identifier "dzd_4q2el0k35ngqa8" \
--owning-project-identifier "4mo2oiauaqbrtc" \
--name "DataProductMetadataForm" \
--status ENABLED \
--model '{ "smithy": "namespace dzd_4q2el0k35ngqa8\n\nstructure DataProductMetadataForm {\n @required\n @amazon.datazone#searchable(modes:[\"TECHNICAL\"])\n name: smithy.api#String\n}" }'
            

Sample Response

{
    "domainId": "dzd_4q2el0k35ngqa8",
    "name": "DataProductMetadataForm",
    "revision": "1"
}
            

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: