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-data-products-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 Data Products 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: Data Products
paths:
  /v2/domains/{domainIdentifier}/data-products:
    post:
      operationId: CreateDataProduct
      summary: Create Data Product
      description: 'Creates a data product. A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It''s designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance. Prerequisites: The domain must exist and be accessible. The owning project must be valid and active. The name must be unique within the domain (no existing data product with the same name). User must have create permissions for data products in the project.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataProductOutput'
        '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/CreateDataProductInput'
      tags:
      - Data Products
  /v2/domains/{domainIdentifier}/data-products/{identifier}:
    get:
      operationId: GetDataProduct
      summary: Get Data Product
      description: 'Gets the data product. Prerequisites: The data product ID must exist. The domain must be valid and accessible. User must have read or discovery permissions for the data product.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataProductOutput'
        '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/GetDataProductInput'
      tags:
      - Data Products
    delete:
      operationId: DeleteDataProduct
      summary: Delete Data Product
      description: 'Deletes a data product in Amazon DataZone. Prerequisites: The data product must exist and not be deleted or archived. The user must have delete permissions for the data product. Domain and project must be active.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDataProductOutput'
        '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/DeleteDataProductInput'
      tags:
      - Data Products
components:
  schemas:
    CreateDataProductInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain where the data product is created.
        name:
          type: string
          description: The name of the data product.
        owningProjectIdentifier:
          type: string
          description: The ID of the owning project of the data product.
        description:
          type: string
          description: The description of the data product.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms of the data product.
        formsInput:
          type: array
          items:
            $ref: '#/components/schemas/FormInput'
          description: The metadata forms of the data product.
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataProductItem'
          description: The data assets of the data product.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
      required:
      - domainIdentifier
      - name
      - owningProjectIdentifier
    DeleteDataProductInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the data product is deleted.
        identifier:
          type: string
          description: The identifier of the data product that is deleted.
      required:
      - domainIdentifier
      - identifier
    DataProductItem:
      type: object
      properties:
        itemType:
          type: string
          enum:
          - ASSET
          description: The type of the data product.
        identifier:
          type: string
          description: The ID of the data product.
        revision:
          type: string
          description: The revision of the data product.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms of the data product.
      required:
      - itemType
      - identifier
    GetDataProductOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the domain where the data product lives.
        id:
          type: string
          description: The ID of the data product.
        revision:
          type: string
          description: The revision of the data product.
        owningProjectId:
          type: string
          description: The ID of the owning project of the data product.
        name:
          type: string
          description: The name of the data product.
        status:
          type: string
          enum:
          - CREATED
          - CREATING
          - CREATE_FAILED
          description: The status of the data product.
        description:
          type: string
          description: The description of the data product.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms of the data product.
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataProductItem'
          description: The data assets of the data product.
        formsOutput:
          type: array
          items:
            $ref: '#/components/schemas/FormOutput'
          description: The metadata forms of the data product.
        createdAt:
          type: string
          format: date-time
          description: The timestamp at which the data product is created.
        createdBy:
          type: string
          description: The user who created the data product.
        firstRevisionCreatedAt:
          type: string
          format: date-time
          description: The timestamp at which the first revision of the data product is created.
        firstRevisionCreatedBy:
          type: string
          description: The user who created the first revision of the data product.
      required:
      - domainId
      - id
      - revision
      - owningProjectId
      - name
      - status
    GetDataProductInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain where the data product lives.
        identifier:
          type: string
          description: The ID of the data product.
        revision:
          type: string
          description: The revision of the data product.
      required:
      - domainIdentifier
      - identifier
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    FormOutput:
      type: object
      properties:
        formName:
          type: string
          description: The name of the metadata form.
        typeName:
          type: string
          description: The name of the metadata form type.
        typeRevision:
          type: string
          description: The revision of the metadata form type.
        content:
          type: string
          description: The content of the metadata form.
      required:
      - formName
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateDataProductOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the domain where the data product lives.
        id:
          type: string
          description: The ID of the data product.
        revision:
          type: string
          description: The revision of the data product.
        owningProjectId:
          type: string
          description: The ID of the owning project of the data product.
        name:
          type: string
          description: The name of the data product.
        status:
          type: string
          enum:
          - CREATED
          - CREATING
          - CREATE_FAILED
          description: The status of the data product.
        description:
          type: string
          description: The description of the data product.
        glossaryTerms:
          type: array
          items:
            type: string
          description: The glossary terms of the data product.
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataProductItem'
          description: The data assets of the data product.
        formsOutput:
          type: array
          items:
            $ref: '#/components/schemas/FormOutput'
          description: The metadata forms of the data product.
        createdAt:
          type: string
          format: date-time
          description: The timestamp at which the data product was created.
        createdBy:
          type: string
          description: The user who created the data product.
        firstRevisionCreatedAt:
          type: string
          format: date-time
          description: The timestamp at which the first revision of the data product was created.
        firstRevisionCreatedBy:
          type: string
          description: The user who created the first revision of the data product.
      required:
      - domainId
      - id
      - revision
      - owningProjectId
      - name
      - status
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    FormInput:
      type: object
      properties:
        formName:
          type: string
          description: The name of the metadata form.
        typeIdentifier:
          type: string
          description: The ID of the metadata form type.
        typeRevision:
          type: string
          description: The revision of the metadata form type.
        content:
          type: string
          description: The content of the metadata form.
      required:
      - formName
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteDataProductOutput:
      type: object
      properties: {}
  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)