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

DeleteFormType

Deletes and metadata form type in Amazon DataZone.

Prerequisites:

The form type must exist in the domain.
The form type must not be in use by any asset types or assets.
The domain must be valid and accessible.
User must have delete permissions on the form type.
Any dependencies (such as linked asset types) must be removed first.

Request Syntax


DELETE /v2/domains/domainIdentifier/form-types/formTypeIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

formTypeIdentifier

The ID of the metadata form type that is deleted.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

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

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

Sample Request



aws datazone delete-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--form-type-identifier "CustomerPreferencesFormType"

Example

Failure case - missing parameter:

Sample Request



aws datazone delete-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 delete-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--form-type-identifier "NonExistentFormType"

Sample Response



An error occurred (ResourceNotFoundException) when calling the DeleteFormType operation: Requested FormType cannot be found in domain