find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-datazone:amazon-datazone-form-types-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon DataZone Form Types API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon DataZone. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://datazone.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Form Types
paths:
  /v2/domains/{domainIdentifier}/form-types/{formTypeIdentifier}:
    delete:
      operationId: DeleteFormType
      summary: Delete Form Type
      description: '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.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFormTypeOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFormTypeInput'
      tags:
      - Form Types
    get:
      operationId: GetFormType
      summary: Get Form Type
      description: 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFormTypeOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFormTypeInput'
      tags:
      - Form Types
  /v2/domains/{domainIdentifier}/form-types:
    post:
      operationId: CreateFormType
      summary: Create Form Type
      description: 'Creates a metadata form type. Prerequisites: The domain must exist and be in an ENABLED state. The owning project must exist and be accessible. The name must be unique within the domain. For custom form types, to indicate that a field should be searchable, annotate it 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. To indicate that a field should be indexed for lexical search (which disables semantic search but supports stemmed and partial matches), annotate it with @amazon.datazone#searchable(modes:["LEXICAL"]). To indicate that a field should be indexed for technical identifier search (for more information on technical identifier search, see: https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/), annotate it with @amazon.datazone#searchable(modes:["TECHNICAL"]). To denote that a field will store glossary term ids (which are filterable via the Search/SearchListings APIs), annotate it with @amazon.datazone#glossaryterm("${GLOSSARY_ID}"), where'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFormTypeOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFormTypeInput'
      tags:
      - Form Types
components:
  schemas:
    Import:
      type: object
      properties:
        name:
          type: string
          description: The name of the import.
        revision:
          type: string
          description: The revision of the import.
      required:
      - name
      - revision
    Model:
      type: object
      properties:
        smithy:
          type: string
          description: Indicates the smithy model of the API.
      description: Exactly one member is set.
    CreateFormTypeOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain in which this metadata form type is created.
        name:
          type: string
          description: The name of this Amazon DataZone metadata form type.
        revision:
          type: string
          description: The revision of this Amazon DataZone metadata form type.
        description:
          type: string
          description: The description of this Amazon DataZone metadata form type.
        owningProjectId:
          type: string
          description: The ID of the project that owns this Amazon DataZone metadata form type.
        originDomainId:
          type: string
          description: The ID of the Amazon DataZone domain in which this metadata form type was originally created.
        originProjectId:
          type: string
          description: The ID of the project in which this Amazon DataZone metadata form type was originally created.
      required:
      - domainId
      - name
      - revision
    GetFormTypeInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which this metadata form type exists.
        formTypeIdentifier:
          type: string
          description: The ID of the metadata form type.
        revision:
          type: string
          description: The revision of this metadata form type.
      required:
      - domainIdentifier
      - formTypeIdentifier
    DeleteFormTypeOutput:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetFormTypeOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain in which this metadata form type exists.
        name:
          type: string
          description: The name of the metadata form type.
        revision:
          type: string
          description: The revision of the metadata form type.
        model:
          $ref: '#/components/schemas/Model'
        owningProjectId:
          type: string
          description: The ID of the project that owns this metadata form type.
        originDomainId:
          type: string
          description: The ID of the Amazon DataZone domain in which the metadata form type was originally created.
        originProjectId:
          type: string
          description: The ID of the project in which this metadata form type was originally created.
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status of the metadata form type.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when this metadata form type was created.
        createdBy:
          type: string
          description: The Amazon DataZone user who created this metadata form type.
        description:
          type: string
          description: The description of the metadata form type.
        imports:
          type: array
          items:
            $ref: '#/components/schemas/Import'
          description: The imports of the metadata form type.
      required:
      - domainId
      - name
      - revision
      - model
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateFormTypeInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which this metadata form type is created.
        name:
          type: string
          description: The name of this Amazon DataZone metadata form type.
        model:
          $ref: '#/components/schemas/Model'
        owningProjectIdentifier:
          type: string
          description: The ID of the Amazon DataZone project that owns this metadata form type.
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status of this Amazon DataZone metadata form type.
        description:
          type: string
          description: The description of this Amazon DataZone metadata form type.
      required:
      - domainIdentifier
      - name
      - model
      - owningProjectIdentifier
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteFormTypeInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the metadata form type is deleted.
        formTypeIdentifier:
          type: string
          description: The ID of the metadata form type that is deleted.
      required:
      - domainIdentifier
      - formTypeIdentifier
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: datazone
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/datazone/service/2018-05-10/datazone-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)