DataZone / Client / get_form_type

get_form_type

DataZone.Client.get_form_type(**kwargs)

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.

One use case for this API is to determine whether a form field is indexed for search.

A searchable field will be annotated with @amazon.datazone#searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. If a field is indexed technical identifier search, it will be annotated with @amazon.datazone#searchable(modes:["TECHNICAL"]). If a field is indexed for lexical search (supports stemmed and prefix matches but not semantic matches), it will be annotated with @amazon.datazone#searchable(modes:["LEXICAL"]).

A field storing glossary term IDs (which is filterable) will be annotated with @amazon.datazone#glossaryterm("${glossaryId}").

See also: AWS API Documentation

Request Syntax

response = client.get_form_type(
    domainIdentifier='string',
    formTypeIdentifier='string',
    revision='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

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

  • formTypeIdentifier (string) –

    [REQUIRED]

    The ID of the metadata form type.

  • revision (string) – The revision of this metadata form type.

Return type:

dict

Returns:

Response Syntax

{
    'domainId': 'string',
    'name': 'string',
    'revision': 'string',
    'model': {
        'smithy': 'string'
    },
    'owningProjectId': 'string',
    'originDomainId': 'string',
    'originProjectId': 'string',
    'status': 'ENABLED'|'DISABLED',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'imports': [
        {
            'name': 'string',
            'revision': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • domainId (string) –

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

    • name (string) –

      The name of the metadata form type.

    • revision (string) –

      The revision of the metadata form type.

    • model (dict) –

      The model of the metadata form type.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: smithy. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • smithy (string) –

        Indicates the smithy model of the API.

    • owningProjectId (string) –

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

    • originDomainId (string) –

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

    • originProjectId (string) –

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

    • status (string) –

      The status of the metadata form type.

    • createdAt (datetime) –

      The timestamp of when this metadata form type was created.

    • createdBy (string) –

      The Amazon DataZone user who created this metadata form type.

    • description (string) –

      The description of the metadata form type.

    • imports (list) –

      The imports of the metadata form type.

      • (dict) –

        The details of the import of the metadata form type.

        • name (string) –

          The name of the import.

        • revision (string) –

          The revision of the import.

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.ResourceNotFoundException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException