Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateFormType

Creates a metadata form type.

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.

domainIdentifier

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The description of this Amazon DataZone metadata form type.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

model

The model of this Amazon DataZone metadata form type.

Type: Model object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

name

The name of this Amazon DataZone metadata form type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(amazon.datazone.)?(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$

Required: Yes

owningProjectIdentifier

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

Type: String

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

Required: Yes

status

The status of this Amazon DataZone metadata form type.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

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.

description

The description of this Amazon DataZone metadata form type.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

domainId

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

Type: String

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

name

The name of this Amazon DataZone metadata form type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(amazon.datazone.)?(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$

originDomainId

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

Type: String

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

originProjectId

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

Type: String

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

owningProjectId

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

Type: String

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

revision

The revision of this Amazon DataZone metadata form type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400