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

GetFormType

Gets a metadata form type in Amazon DataZone.

Form types define the structure and validation rules for collecting metadata about assets in Amazon DataZone. They act as templates that ensure consistent metadata capture across similar types of assets, while allowing for customization to meet specific organizational needs. Form types can include required fields, validation rules, and dependencies, helping maintain high-quality metadata that makes data assets more discoverable and usable.

The form type with the specified identifier must exist in the given domain.
The domain must be valid and active.
User must have permission on the form type.
The form type should not be deleted or in an invalid state.

Request Syntax


GET /v2/domains/domainIdentifier/form-types/formTypeIdentifier?revision=revision HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

formTypeIdentifier

The ID of the metadata form type.

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

Pattern: (?!\.)[\w\.]*\w

Required: Yes

revision

The revision of this metadata form type.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "imports": [ 
      { 
         "name": "string",
         "revision": "string"
      }
   ],
   "model": { ... },
   "name": "string",
   "originDomainId": "string",
   "originProjectId": "string",
   "owningProjectId": "string",
   "revision": "string",
   "status": "string"
}

Response Elements

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

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

createdAt

The timestamp of when this metadata form type was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created this metadata form type.

Type: String

description

The description of the 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 exists.

Type: String

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

imports

The imports of the metadata form type.

Type: Array of Import objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

model

The model of the metadata form type.

Type: Model object

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

name

The name of the 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 the 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 metadata form type was originally created.

Type: String

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

owningProjectId

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

Type: String

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

revision

The revision of the metadata form type.

Type: String

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

status

The status of the metadata form type.

Type: String

Valid Values: ENABLED | DISABLED

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

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

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

Examples

Example

This example illustrates one usage of GetFormType.

Sample Request



aws datazone get-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--form-type-identifier "CustomerProfileFormType"

Sample Response



{
    "createdAt": 1752600481.72,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "imports": [],
    "model": {
        "smithy": "structure CustomerProfileFormType {\n    @required\n    customerId: String,\n    firstName: String,\n    lastName: String,\n    email: String\n}"
    },
    "name": "CustomerProfileFormType",
    "owningProjectId": "prj7nx82mkl",
    "revision": "2",
    "status": "ENABLED"
}

Example

Failure case - missing parameter:

Sample Request



aws datazone get-form-type \
--domain-identifier "dzd_53ielnpxktdilj"

Sample Response



aws: error: the following arguments are required: —form-type-identifier

Example

Failure case - resource does not exist:

Sample Request



aws datazone get-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--form-type-identifier "NonExistentFormType"

Sample Response



An error occurred (ResourceNotFoundException) when calling the GetFormType operation: The given FormType doesn't exist. Try creating FormType before accessing it.

Example

Failure case - invalid input:

Sample Request



aws datazone get-form-type \
--domain-identifier "invalid_domain" \
--form-type-identifier "CustomerProfileFormType"

Sample Response



An error occurred (ValidationException) when calling the GetFormType operation: 1 validation error detected: Value at 'domainIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: dzd[-_][a-zA-Z0-9_-]{1,36}