DataZone / Client / get_form_type

get_form_type#

DataZone.Client.get_form_type(**kwargs)#

Gets a metadata form type in Amazon DataZone.

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

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

Response Structure

  • (dict) –

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

    • domainId (string) –

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

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

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

    • name (string) –

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

    • owningProjectId (string) –

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

    • revision (string) –

      The revision of the metadata form type.

    • status (string) –

      The status of the metadata form type.

Exceptions