CreateFormTypeCommand

Suggest an Edit

Creates a metadata form type.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, CreateFormTypeCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateFormTypeCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateFormTypeInput
  domainIdentifier: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
  model: { // Model Union: only one key present
    smithy: "STRING_VALUE",
  },
  owningProjectIdentifier: "STRING_VALUE", // required
  status: "ENABLED" || "DISABLED",
  description: "STRING_VALUE",
};
const command = new CreateFormTypeCommand(input);
const response = await client.send(command);
// { // CreateFormTypeOutput
//   domainId: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   revision: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   owningProjectId: "STRING_VALUE",
//   originDomainId: "STRING_VALUE",
//   originProjectId: "STRING_VALUE",
// };

CreateFormTypeCommand Input

See CreateFormTypeCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

model
Required
Model | undefined

The model of this Amazon DataZone metadata form type.

name
Required
string | undefined

The name of this Amazon DataZone metadata form type.

owningProjectIdentifier
Required
string | undefined

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

description
string | undefined

The description of this Amazon DataZone metadata form type.

status
FormTypeStatus | undefined

The status of this Amazon DataZone metadata form type.

CreateFormTypeCommand Output

See CreateFormTypeCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainId
Required
string | undefined

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

name
Required
string | undefined

The name of this Amazon DataZone metadata form type.

revision
Required
string | undefined

The revision of this Amazon DataZone metadata form type.

description
string | undefined

The description of this Amazon DataZone metadata form type.

originDomainId
string | undefined

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

originProjectId
string | undefined

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

owningProjectId
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.