AWS CLI Command Reference

[ aws . datazone ]

create-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.

See also: AWS API Documentation

Synopsis

  create-form-type
[--description <value>]
--domain-identifier <value>
--model <value>
--name <value>
--owning-project-identifier <value>
[--status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--description (string)

The description of this Amazon DataZone metadata form type.

Constraints:

  • min: 0
  • max: 2048

--domain-identifier (string) [required]

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

Constraints:

  • pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

--model (tagged union structure) [required]

The model of this Amazon DataZone metadata form type.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: smithy.

smithy -> (string)

Indicates the smithy model of the API.

Constraints:

  • min: 1
  • max: 100000

Shorthand Syntax:

smithy=string

JSON Syntax:

{
  "smithy": "string"
}

--name (string) [required]

The name of this Amazon DataZone metadata form type.

Constraints:

  • min: 1
  • max: 128
  • pattern: ^(amazon.datazone.)?(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$

--owning-project-identifier (string) [required]

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

Constraints:

  • pattern: ^[a-zA-Z0-9_-]{1,36}$

--status (string)

The status of this Amazon DataZone metadata form type.

Possible values:

  • ENABLED
  • DISABLED

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

description -> (string)

The description of this Amazon DataZone metadata form type.

Constraints:

  • min: 0
  • max: 2048

domainId -> (string)

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

Constraints:

  • pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

name -> (string)

The name of this Amazon DataZone metadata form type.

Constraints:

  • min: 1
  • max: 128
  • pattern: ^(amazon.datazone.)?(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$

originDomainId -> (string)

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

Constraints:

  • pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

originProjectId -> (string)

The ID of the project in which this Amazon DataZone metadata form type was originally created.

Constraints:

  • pattern: ^[a-zA-Z0-9_-]{1,36}$

owningProjectId -> (string)

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

Constraints:

  • pattern: ^[a-zA-Z0-9_-]{1,36}$

revision -> (string)

The revision of this Amazon DataZone metadata form type.

Constraints:

  • min: 1
  • max: 64
© Copyright 2025, Amazon Web Services. Created using Sphinx.