Amazon DataZone

Amazon DataZone Datazone Metadata Generation Runs API

The Datazone Metadata Generation Runs API from Amazon DataZone — 2 operation(s) for datazone metadata generation runs.

GitHub OpenAPI

Operations 3

POST /v2/domains/{domainIdentifier}/metadata-generation-runs Start Metadata Generation Run #
GET /v2/domains/{domainIdentifier}/metadata-generation-runs List Metadata Generation Runs #
GET /v2/domains/{domainIdentifier}/metadata-generation-runs/{identifier} Get Metadata Generation Run #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-datazone/openapi/amazon-datazone-metadata-generation-runs-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-metadata-generation-runs-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

amazon-datazone-metadata-generation-runs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon DataZone Metadata Generation Runs 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: Metadata Generation Runs
paths:
  /v2/domains/{domainIdentifier}/metadata-generation-runs:
    post:
      operationId: StartMetadataGenerationRun
      summary: Start Metadata Generation Run
      description: 'Starts the metadata generation run. Prerequisites: Asset must be created and belong to the specified domain and project. Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table). Asset must have a structured schema with valid rows and columns. Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS. The user must have permission to run metadata generation in the domain/project.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartMetadataGenerationRunOutput'
        '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'
        '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/StartMetadataGenerationRunInput'
      tags:
      - Metadata Generation Runs
    get:
      operationId: ListMetadataGenerationRuns
      summary: List Metadata Generation Runs
      description: 'Lists all metadata generation runs. Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness. Prerequisites: Valid domain identifier. User must have access to metadata generation runs in the domain.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMetadataGenerationRunsOutput'
        '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/ListMetadataGenerationRunsInput'
      tags:
      - Metadata Generation Runs
  /v2/domains/{domainIdentifier}/metadata-generation-runs/{identifier}:
    get:
      operationId: GetMetadataGenerationRun
      summary: Get Metadata Generation Run
      description: 'Gets a metadata generation run in Amazon DataZone. Prerequisites: Valid domain and run identifier. The metadata generation run must exist. User must have read access to the metadata run.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMetadataGenerationRunOutput'
        '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/GetMetadataGenerationRunInput'
      tags:
      - Metadata Generation Runs
components:
  schemas:
    GetMetadataGenerationRunInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain the metadata generation run of which you want to get.
        identifier:
          type: string
          description: The identifier of the metadata generation run.
        type:
          type: string
          enum:
          - BUSINESS_DESCRIPTIONS
          - BUSINESS_NAMES
          - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The type of the metadata generation run.
      required:
      - domainIdentifier
      - identifier
    MetadataGenerationRunTypeStat:
      type: object
      properties:
        type:
          type: string
          enum:
          - BUSINESS_DESCRIPTIONS
          - BUSINESS_NAMES
          - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The type of the metadata generation run type statistics.
        status:
          type: string
          enum:
          - SUBMITTED
          - IN_PROGRESS
          - CANCELED
          - SUCCEEDED
          - FAILED
          - PARTIALLY_SUCCEEDED
          description: The status of the metadata generation run type statistics.
        errorMessage:
          type: string
          description: The error message displayed if the action fails to run.
      required:
      - type
      - status
    ListMetadataGenerationRunsOutput:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/MetadataGenerationRunItem'
          description: The results of the ListMetadataGenerationRuns action.
        nextToken:
          type: string
          description: When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    StartMetadataGenerationRunOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain in which the metadata generation run was started.
        id:
          type: string
          description: The ID of the metadata generation run.
        status:
          type: string
          enum:
          - SUBMITTED
          - IN_PROGRESS
          - CANCELED
          - SUCCEEDED
          - FAILED
          - PARTIALLY_SUCCEEDED
          description: The status of the metadata generation run.
        type:
          type: string
          enum:
          - BUSINESS_DESCRIPTIONS
          - BUSINESS_NAMES
          - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The type of the metadata generation run.
        types:
          type: array
          items:
            type: string
            enum:
            - BUSINESS_DESCRIPTIONS
            - BUSINESS_NAMES
            - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The types of the metadata generation run.
        createdAt:
          type: string
          format: date-time
          description: The timestamp at which the metadata generation run was started.
        createdBy:
          type: string
          description: The ID of the user who started the metadata generation run.
        owningProjectId:
          type: string
          description: The ID of the project that owns the asset for which the metadata generation run was started.
      required:
      - domainId
      - id
    GetMetadataGenerationRunOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain the metadata generation run of which you want to get.
        id:
          type: string
          description: The ID of the metadata generation run.
        target:
          $ref: '#/components/schemas/MetadataGenerationRunTarget'
        status:
          type: string
          enum:
          - SUBMITTED
          - IN_PROGRESS
          - CANCELED
          - SUCCEEDED
          - FAILED
          - PARTIALLY_SUCCEEDED
          description: The status of the metadata generation run.
        type:
          type: string
          enum:
          - BUSINESS_DESCRIPTIONS
          - BUSINESS_NAMES
          - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The type of metadata generation run.
        types:
          type: array
          items:
            type: string
            enum:
            - BUSINESS_DESCRIPTIONS
            - BUSINESS_NAMES
            - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The types of the metadata generation run.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the metadata generation run was start.
        createdBy:
          type: string
          description: The Amazon DataZone user who started the metadata generation run.
        owningProjectId:
          type: string
          description: The ID of the project that owns the assets for which you're running metadata generation.
        typeStats:
          type: array
          items:
            $ref: '#/components/schemas/MetadataGenerationRunTypeStat'
          description: The type stats included in the metadata generation run output details.
      required:
      - domainId
      - id
      - owningProjectId
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    MetadataGenerationRunItem:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain in which the metadata generation run was created.
        id:
          type: string
          description: The ID of the metadata generation run.
        target:
          $ref: '#/components/schemas/MetadataGenerationRunTarget'
        status:
          type: string
          enum:
          - SUBMITTED
          - IN_PROGRESS
          - CANCELED
          - SUCCEEDED
          - FAILED
          - PARTIALLY_SUCCEEDED
          description: The status of the metadata generation run.
        type:
          type: string
          enum:
          - BUSINESS_DESCRIPTIONS
          - BUSINESS_NAMES
          - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The type of the metadata generation run.
        types:
          type: array
          items:
            type: string
            enum:
            - BUSINESS_DESCRIPTIONS
            - BUSINESS_NAMES
            - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The types of the metadata generation run.
        createdAt:
          type: string
          format: date-time
          description: The timestamp at which the metadata generation run was created.
        createdBy:
          type: string
          description: The user who created the metadata generation run.
        owningProjectId:
          type: string
          description: The ID of the project that owns the asset for which the metadata generation was ran.
      required:
      - domainId
      - id
      - owningProjectId
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListMetadataGenerationRunsInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain where you want to list metadata generation runs.
        status:
          type: string
          enum:
          - SUBMITTED
          - IN_PROGRESS
          - CANCELED
          - SUCCEEDED
          - FAILED
          - PARTIALLY_SUCCEEDED
          description: The status of the metadata generation runs.
        type:
          type: string
          enum:
          - BUSINESS_DESCRIPTIONS
          - BUSINESS_NAMES
          - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The type of the metadata generation runs.
        nextToken:
          type: string
          description: When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.
        maxResults:
          type: integer
          description: The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.
        targetIdentifier:
          type: string
          description: The target ID for which you want to list metadata generation runs.
      required:
      - domainIdentifier
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    MetadataGenerationRunTarget:
      type: object
      properties:
        type:
          type: string
          enum:
          - ASSET
          description: The type of the asset for which metadata was generated.
        identifier:
          type: string
          description: The ID of the metadata generation run's target.
        revision:
          type: string
          description: The revision of the asset for which metadata was generated.
      required:
      - type
      - identifier
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    StartMetadataGenerationRunInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain where you want to start a metadata generation run.
        type:
          type: string
          enum:
          - BUSINESS_DESCRIPTIONS
          - BUSINESS_NAMES
          - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The type of the metadata generation run.
        types:
          type: array
          items:
            type: string
            enum:
            - BUSINESS_DESCRIPTIONS
            - BUSINESS_NAMES
            - BUSINESS_GLOSSARY_ASSOCIATIONS
          description: The types of the metadata generation run.
        target:
          $ref: '#/components/schemas/MetadataGenerationRunTarget'
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
        owningProjectIdentifier:
          type: string
          description: The ID of the project that owns the asset for which you want to start a metadata generation run.
      required:
      - domainIdentifier
      - target
      - owningProjectIdentifier
  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)