Amazon DataZone Datazone Glossary Terms API

openapi: 3.2.0
info:
  title: Amazon DataZone Glossary Terms API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon DataZone. 4 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: Glossary Terms
paths:
  /v2/domains/{domainIdentifier}/glossary-terms:
    post:
      operationId: CreateGlossaryTerm
      summary: Create Glossary Term
      description: 'Creates a business glossary term. A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts. Prerequisites: Domain must exist. Glossary must exist. The term name must be unique within the glossary. Ensure term does not conflict with existing terms in hierarchy.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGlossaryTermOutput'
        '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/CreateGlossaryTermInput'
      tags:
      - Glossary Terms
  /v2/domains/{domainIdentifier}/glossary-terms/{identifier}:
    get:
      operationId: GetGlossaryTerm
      summary: Get Glossary Term
      description: 'Gets a business glossary term in Amazon DataZone. Prerequisites: Glossary term with identifier must exist in the domain. User must have permission on the glossary term. Domain must be accessible and active.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGlossaryTermOutput'
        '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/GetGlossaryTermInput'
      tags:
      - Glossary Terms
    patch:
      operationId: UpdateGlossaryTerm
      summary: Update Glossary Term
      description: 'Updates a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist in the specified domain. New name must not conflict with existing terms in the same glossary. User must have permissions on the term. The term must not be in DELETED status.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGlossaryTermOutput'
        '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/UpdateGlossaryTermInput'
      tags:
      - Glossary Terms
    delete:
      operationId: DeleteGlossaryTerm
      summary: Delete Glossary Term
      description: 'Deletes a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist and be active. The term must not be linked to other assets or child terms. Caller must have delete permissions in the domain/glossary. Ensure all associations (such as to assets or parent terms) are removed before deletion.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteGlossaryTermOutput'
        '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/DeleteGlossaryTermInput'
      tags:
      - Glossary Terms
components:
  schemas:
    UpdateGlossaryTermInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.
        glossaryIdentifier:
          type: string
          description: The identifier of the business glossary in which a term is to be updated.
        identifier:
          type: string
          description: The identifier of the business glossary term that is to be updated.
        name:
          type: string
          description: The name to be updated as part of the UpdateGlossaryTerm action.
        shortDescription:
          type: string
          description: The short description to be updated as part of the UpdateGlossaryTerm action.
        longDescription:
          type: string
          description: The long description to be updated as part of the UpdateGlossaryTerm action.
        termRelations:
          $ref: '#/components/schemas/TermRelations'
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status to be updated as part of the UpdateGlossaryTerm action.
      required:
      - domainIdentifier
      - identifier
    DeleteGlossaryTermInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which the business glossary term is deleted.
        identifier:
          type: string
          description: The ID of the business glossary term that is deleted.
      required:
      - domainIdentifier
      - identifier
    GetGlossaryTermInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which this business glossary term exists.
        identifier:
          type: string
          description: The ID of the business glossary term.
      required:
      - domainIdentifier
      - identifier
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateGlossaryTermInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the Amazon DataZone domain in which this business glossary term is created.
        glossaryIdentifier:
          type: string
          description: The ID of the business glossary in which this term is created.
        name:
          type: string
          description: The name of this business glossary term.
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status of this business glossary term.
        shortDescription:
          type: string
          description: The short description of this business glossary term.
        longDescription:
          type: string
          description: The long description of this business glossary term.
        termRelations:
          $ref: '#/components/schemas/TermRelations'
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
      required:
      - domainIdentifier
      - glossaryIdentifier
      - name
    GetGlossaryTermOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain in which this business glossary term exists.
        glossaryId:
          type: string
          description: The ID of the business glossary to which this term belongs.
        id:
          type: string
          description: The ID of the business glossary term.
        name:
          type: string
          description: The name of the business glossary term.
        shortDescription:
          type: string
          description: The short decription of the business glossary term.
        longDescription:
          type: string
          description: The long description of the business glossary term.
        termRelations:
          $ref: '#/components/schemas/TermRelations'
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status of the business glossary term.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the business glossary term was created.
        createdBy:
          type: string
          description: The Amazon DataZone user who created the business glossary.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp of when the business glossary term was updated.
        updatedBy:
          type: string
          description: The Amazon DataZone user who updated the business glossary term.
        usageRestrictions:
          type: array
          items:
            type: string
            enum:
            - ASSET_GOVERNED_TERMS
          description: The usage restriction of a term within a restricted glossary.
      required:
      - domainId
      - glossaryId
      - id
      - name
      - status
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateGlossaryTermOutput:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the business glossary term that is to be updated.
        domainId:
          type: string
          description: The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.
        glossaryId:
          type: string
          description: The identifier of the business glossary in which a term is to be updated.
        name:
          type: string
          description: The name to be updated as part of the UpdateGlossaryTerm action.
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status to be updated as part of the UpdateGlossaryTerm action.
        shortDescription:
          type: string
          description: The short description to be updated as part of the UpdateGlossaryTerm action.
        longDescription:
          type: string
          description: The long description to be updated as part of the UpdateGlossaryTerm action.
        termRelations:
          $ref: '#/components/schemas/TermRelations'
        usageRestrictions:
          type: array
          items:
            type: string
            enum:
            - ASSET_GOVERNED_TERMS
          description: The usage restriction of a term within a restricted glossary.
      required:
      - id
      - domainId
      - glossaryId
      - name
      - status
    TermRelations:
      type: object
      properties:
        isA:
          type: array
          items:
            type: string
          description: The isA property of the term relations.
        classifies:
          type: array
          items:
            type: string
          description: The classifies of the term relations.
    DeleteGlossaryTermOutput:
      type: object
      properties: {}
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    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
    CreateGlossaryTermOutput:
      type: object
      properties:
        id:
          type: string
          description: The ID of this business glossary term.
        domainId:
          type: string
          description: The ID of the Amazon DataZone domain in which this business glossary term is created.
        glossaryId:
          type: string
          description: The ID of the business glossary in which this term is created.
        name:
          type: string
          description: The name of this business glossary term.
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status of this business glossary term.
        shortDescription:
          type: string
          description: The short description of this business glossary term.
        longDescription:
          type: string
          description: The long description of this business glossary term.
        termRelations:
          $ref: '#/components/schemas/TermRelations'
        usageRestrictions:
          type: array
          items:
            type: string
            enum:
            - ASSET_GOVERNED_TERMS
          description: The usage restriction of the restricted glossary.
      required:
      - id
      - domainId
      - glossaryId
      - name
      - status
  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)