Amazon DataZone Datazone Lineage API

openapi: 3.2.0
info:
  title: Amazon DataZone Lineage API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for Amazon DataZone. 5 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: Lineage
paths:
  /v2/domains/{domainIdentifier}/lineage/events/{identifier}:
    delete:
      operationId: DeleteLineageEvent
      summary: Delete Lineage Event
      description: Deletes the specified lineage event.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteLineageEventOutput'
        '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/DeleteLineageEventInput'
      tags:
      - Lineage
    get:
      operationId: GetLineageEvent
      summary: Get Lineage Event
      description: Describes the lineage event.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLineageEventOutput'
        '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/GetLineageEventInput'
      tags:
      - Lineage
  /v2/domains/{domainIdentifier}/lineage/nodes/{identifier}:
    get:
      operationId: GetLineageNode
      summary: Get Lineage Node
      description: Gets the data lineage node.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLineageNodeOutput'
        '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/GetLineageNodeInput'
      tags:
      - Lineage
  /v2/domains/{domainIdentifier}/lineage/events:
    get:
      operationId: ListLineageEvents
      summary: List Lineage Events
      description: Lists lineage events.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLineageEventsOutput'
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/ListLineageEventsInput'
      tags:
      - Lineage
    post:
      operationId: PostLineageEvent
      summary: Post Lineage Event
      description: Posts a data lineage event.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostLineageEventOutput'
        '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/PostLineageEventInput'
      tags:
      - Lineage
components:
  schemas:
    ListLineageEventsInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain where you want to list lineage events.
        maxResults:
          type: integer
          description: The maximum number of lineage events to return in a single call to ListLineageEvents. When the number of lineage events 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 ListLineageEvents to list the next set of lineage events.
        timestampAfter:
          type: string
          description: The after timestamp of a lineage event.
        timestampBefore:
          type: string
          description: The before timestamp of a lineage event.
        processingStatus:
          type: string
          enum:
          - REQUESTED
          - PROCESSING
          - SUCCESS
          - FAILED
          description: The processing status of a lineage event.
        sortOrder:
          type: string
          enum:
          - ASCENDING
          - DESCENDING
          description: The sort order of the lineage events.
        nextToken:
          type: string
          description: When the number of lineage events 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 lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.
      required:
      - domainIdentifier
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetLineageNodeOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the domain where you're getting the data lineage node.
        name:
          type: string
          description: The name of the data lineage node.
        description:
          type: string
          description: The description of the data lineage node.
        createdAt:
          type: string
          format: date-time
          description: The timestamp at which the data lineage node was created.
        createdBy:
          type: string
          description: The user who created the data lineage node.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp at which the data lineage node was updated.
        updatedBy:
          type: string
          description: The user who updated the data lineage node.
        id:
          type: string
          description: The ID of the data lineage node.
        typeName:
          type: string
          description: The name of the type of the specified data lineage node.
        typeRevision:
          type: string
          description: The revision type of the specified data lineage node.
        sourceIdentifier:
          type: string
          description: The source identifier of the data lineage node.
        eventTimestamp:
          type: string
          description: The timestamp of the event described in the data lineage node.
        formsOutput:
          type: array
          items:
            $ref: '#/components/schemas/FormOutput'
          description: The metadata of the specified data lineage node.
        upstreamNodes:
          type: array
          items:
            $ref: '#/components/schemas/LineageNodeReference'
          description: The upstream nodes of the specified data lineage node.
        downstreamNodes:
          type: array
          items:
            $ref: '#/components/schemas/LineageNodeReference'
          description: The downsteam nodes of the specified data lineage node.
      required:
      - domainId
      - id
      - typeName
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetLineageEventInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain.
        identifier:
          type: string
          description: The ID of the lineage event.
      required:
      - domainIdentifier
      - identifier
    GetLineageEventOutput:
      type: object
      properties:
        domainId:
          type: string
          description: The ID of the domain.
        id:
          type: string
          description: The ID of the lineage event.
        event:
          type: string
          format: byte
          description: The lineage event details.
        createdBy:
          type: string
          description: The user who created the lineage event.
        processingStatus:
          type: string
          enum:
          - REQUESTED
          - PROCESSING
          - SUCCESS
          - FAILED
          description: The progressing status of the lineage event.
        eventTime:
          type: string
          description: The time of the lineage event.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the lineage event was created.
    LineageNodeReference:
      type: object
      properties:
        id:
          type: string
          description: The ID of the data lineage node.
        eventTimestamp:
          type: string
          description: The event timestamp of the data lineage node.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteLineageEventInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain.
        identifier:
          type: string
          description: The ID of the lineage event.
      required:
      - domainIdentifier
      - identifier
    EventSummary:
      type: object
      properties:
        openLineageRunEventSummary:
          $ref: '#/components/schemas/OpenLineageRunEventSummary'
      description: Exactly one member is set.
    NameIdentifier:
      type: object
      properties:
        name:
          type: string
          description: The name in the name identifier.
        namespace:
          type: string
          description: The namespace in the name identifier.
    PostLineageEventInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain where you want to post a data lineage event.
        event:
          type: string
          format: byte
          description: The data lineage event that you want to post. Only open-lineage run event are supported as events.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
      required:
      - domainIdentifier
      - event
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListLineageEventsOutput:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/LineageEventSummary'
          description: The results of the ListLineageEvents action.
        nextToken:
          type: string
          description: When the number of lineage events 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 lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.
    DeleteLineageEventOutput:
      type: object
      properties:
        id:
          type: string
          description: The ID of the lineage event.
        domainId:
          type: string
          description: The ID of the domain.
        processingStatus:
          type: string
          enum:
          - REQUESTED
          - PROCESSING
          - SUCCESS
          - FAILED
          description: The progressing status of the lineage event.
    GetLineageNodeInput:
      type: object
      properties:
        domainIdentifier:
          type: string
          description: The ID of the domain in which you want to get the data lineage node.
        identifier:
          type: string
          description: The ID of the data lineage node that you want to get. Both, a lineage node identifier generated by Amazon DataZone and a sourceIdentifier of the lineage node are supported. If sourceIdentifier is greater than 1800 characters, you can use lineage node identifier generated by Amazon DataZone to get the node details.
        eventTimestamp:
          type: string
          description: The event time stamp for which you want to get the data lineage node.
      required:
      - domainIdentifier
      - identifier
    LineageEventSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the data lineage event.
        domainId:
          type: string
          description: The domain ID of the lineage event.
        processingStatus:
          type: string
          enum:
          - REQUESTED
          - PROCESSING
          - SUCCESS
          - FAILED
          description: The processing status of the data lineage event.
        eventTime:
          type: string
          description: The time of the data lineage event.
        eventSummary:
          $ref: '#/components/schemas/EventSummary'
        createdBy:
          type: string
          description: The user who created the data lineage event.
        createdAt:
          type: string
          format: date-time
          description: The timestamp at which data lineage event was created.
    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
    PostLineageEventOutput:
      type: object
      properties:
        id:
          type: string
          description: The ID of the lineage event.
        domainId:
          type: string
          description: The ID of the domain.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    OpenLineageRunEventSummary:
      type: object
      properties:
        eventType:
          type: string
          enum:
          - START
          - RUNNING
          - COMPLETE
          - ABORT
          - FAIL
          - OTHER
          description: The event type of the open lineage run event summary.
        runId:
          type: string
          description: The runID of the open lineage run event summary.
        job:
          $ref: '#/components/schemas/NameIdentifier'
        inputs:
          type: array
          items:
            $ref: '#/components/schemas/NameIdentifier'
          description: The inputs of the open lineage run event summary.
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/NameIdentifier'
          description: The outputs of the open lineage run event summary.
  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)