form_types

Creates, updates, deletes, gets or lists a form_types resource.

Overview

Name	form_types
Type	Resource
Id	aws.glue.form_types

Fields

The following fields are returned by SELECT queries:

get_form_type

Name	Datatype	Description
id	string	The identifier of the form type.
name	string	The name of the form type. (pattern: <code>^[A-Z]\w*$</code>)
schema	string	The Smithy IDL schema of the form type.

list_form_types

Name	Datatype	Description
id	string	The identifier of the form type.
name	string	The name of the form type. (pattern: <code>^[A-Z]\w*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_form_type	select	region		Retrieves a form type in Glue Data Catalog by its identifier.
list_form_types	select	region		Lists the form types defined in Glue Data Catalog.
put_form_type	replace	region		Creates or updates a form type in Glue Data Catalog. A form type defines the schema for structured metadata that can be attached to assets.
delete_form_type	delete	region		Deletes a form type from Glue Data Catalog. A form type cannot be deleted if it is still referenced by an asset type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_form_type

Retrieves a form type in Glue Data Catalog by its identifier.

SELECT
id,
name,
schema
FROM aws.glue.form_types
WHERE region = '{{ region }}' -- required
;

list_form_types

Lists the form types defined in Glue Data Catalog.

SELECT
id,
name
FROM aws.glue.form_types
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_form_type

Creates or updates a form type in Glue Data Catalog. A form type defines the schema for structured metadata that can be attached to assets.

REPLACE aws.glue.form_types
SET 
Name = '{{ Name }}',
Schema = '{{ Schema }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
RETURNING
id,
name,
schema;

DELETE examples

delete_form_type

Deletes a form type from Glue Data Catalog. A form type cannot be deleted if it is still referenced by an asset type.

DELETE FROM aws.glue.form_types
WHERE region = '{{ region }}' --required
;