AWS HealthLake

AWS HealthLake Healthlake Data Transformation Job API

The Healthlake Data Transformation Job API from AWS HealthLake — 3 operation(s) for healthlake data transformation job.

GitHub OpenAPI

Operations 3

POST /#DescribeDataTransformationJob Describe Data Transformation Job #
POST /#ListDataTransformationJobs List Data Transformation Jobs #
POST /#StartDataTransformationJob Start Data Transformation Job #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/aws-healthlake/openapi/aws-healthlake-data-transformation-job-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/aws-healthlake:aws-healthlake-data-transformation-job-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

aws-healthlake-data-transformation-job-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon HealthLake Data Transformation Job API
  version: '2017-07-01'
  description: Generated from AWS's published Smithy model for Amazon HealthLake. 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://healthlake.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Data Transformation Job
paths:
  /#DescribeDataTransformationJob:
    post:
      operationId: DescribeDataTransformationJob
      summary: Describe Data Transformation Job
      description: Describes a data transformation job, including its current status, configuration, and progress information.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeDataTransformationJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - HealthLake.DescribeDataTransformationJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeDataTransformationJobRequest'
      tags:
      - Data Transformation Job
  /#ListDataTransformationJobs:
    post:
      operationId: ListDataTransformationJobs
      summary: List Data Transformation Jobs
      description: Lists data transformation jobs for your Amazon Web Services account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the NextToken parameter to retrieve additional results.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListDataTransformationJobsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - HealthLake.ListDataTransformationJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListDataTransformationJobsRequest'
      tags:
      - Data Transformation Job
  /#StartDataTransformationJob:
    post:
      operationId: StartDataTransformationJob
      summary: Start Data Transformation Job
      description: Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or HealthLake.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/StartDataTransformationJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - HealthLake.StartDataTransformationJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/StartDataTransformationJobRequest'
      tags:
      - Data Transformation Job
components:
  schemas:
    TransformationOutputDataConfig:
      type: object
      properties:
        S3Configuration:
          $ref: '#/components/schemas/DataTransformationS3Configuration'
      required:
      - S3Configuration
    DescribeDataTransformationJobRequest:
      type: object
      properties:
        JobId:
          type: string
          description: The unique identifier of the data transformation job to describe.
      required:
      - JobId
    ListDataTransformationJobsResponse:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/TransformationJobSummary'
          description: The list of data transformation job summaries.
        NextToken:
          type: string
          description: The pagination token to use in the next request. If this value is null, there are no more results.
      required:
      - Items
    ValidationException:
      type: object
      properties:
        Message:
          type: string
    TransformationJobProperties:
      type: object
      properties:
        JobId:
          type: string
          description: The unique identifier of the data transformation job.
        JobStatus:
          type: string
          enum:
          - SUBMITTED
          - QUEUED
          - IN_PROGRESS
          - COMPLETED
          - COMPLETED_WITH_ERRORS
          - FAILED
          description: The current status of the data transformation job.
        InputDataConfig:
          $ref: '#/components/schemas/TransformationInputDataConfig'
        OutputDataConfig:
          $ref: '#/components/schemas/TransformationOutputDataConfig'
        DataAccessRoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants HealthLake access to the specified Amazon S3 locations. HealthLake assumes this role to read input files and write output files.
        SubmitTime:
          type: string
          format: date-time
          description: The timestamp when the job was submitted.
        JobName:
          type: string
          description: The name of the data transformation job.
        ProfileId:
          type: string
          description: The unique identifier of the data transformation profile used for this job.
        ProfileName:
          type: string
          description: The name of the data transformation profile used for this job.
        ProfileVersion:
          type: integer
          description: The version number of the data transformation profile used for this job.
        EndTime:
          type: string
          format: date-time
          description: The timestamp when the job completed or failed.
        DriftDetectionEnabled:
          type: boolean
          description: Specifies whether drift detection is enabled for this job. When enabled, HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.
        ProvenanceEnabled:
          type: boolean
          description: Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources.
        Message:
          type: string
          description: An informational message about the job, such as an error description if the job failed.
        JobProgressReport:
          $ref: '#/components/schemas/TransformationJobProgressReport'
      required:
      - JobId
      - JobStatus
      - InputDataConfig
      - OutputDataConfig
      - DataAccessRoleArn
      - SubmitTime
    TransformationJobProgressReport:
      type: object
      properties:
        TotalFilesScanned:
          type: integer
          description: The total number of source files scanned by the job.
        TotalFilesConverted:
          type: integer
          description: The total number of source files successfully converted.
        TotalFilesFailed:
          type: integer
          description: The total number of source files that failed conversion.
        TotalResourcesGenerated:
          type: integer
          description: The total number of FHIR R4 resources generated across all converted files.
      required:
      - TotalFilesScanned
      - TotalFilesConverted
      - TotalFilesFailed
      - TotalResourcesGenerated
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    TransformationInputDataConfig:
      type: object
      properties:
        S3Uri:
          type: string
          description: The Amazon S3 URI of the input data to transform.
        SourceFormat:
          type: string
          enum:
          - CCDA
          - CSV
          description: The format of the source data files (C-CDA or CSV).
      required:
      - S3Uri
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    DataTransformationS3Configuration:
      type: object
      properties:
        S3Uri:
          type: string
          description: The Amazon S3 URI where HealthLake writes the converted output files.
        KmsKeyId:
          type: string
          description: The Amazon Web Services Key Management Service (Amazon Web Services KMS) key identifier used to encrypt the transformation job output written to Amazon S3.
      required:
      - S3Uri
      - KmsKeyId
    StartDataTransformationJobRequest:
      type: object
      properties:
        InputDataConfig:
          $ref: '#/components/schemas/TransformationInputDataConfig'
        OutputDataConfig:
          $ref: '#/components/schemas/TransformationOutputDataConfig'
        DataAccessRoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that HealthLake assumes to read from and write to the specified Amazon S3 locations.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
        JobName:
          type: string
          description: A descriptive name for the data transformation job.
        ProfileId:
          type: string
          description: The unique identifier of the data transformation profile to use for conversion.
        DriftDetectionEnabled:
          type: boolean
          description: Specifies whether drift detection is enabled for this job. When enabled, HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.
        ProvenanceEnabled:
          type: boolean
          description: Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.
      required:
      - InputDataConfig
      - OutputDataConfig
      - DataAccessRoleArn
      - ClientToken
      - ProfileId
    TransformationJobSummary:
      type: object
      properties:
        JobId:
          type: string
          description: The unique identifier of the job.
        JobStatus:
          type: string
          enum:
          - SUBMITTED
          - QUEUED
          - IN_PROGRESS
          - COMPLETED
          - COMPLETED_WITH_ERRORS
          - FAILED
          description: The current status of the job.
        SubmitTime:
          type: string
          format: date-time
          description: The timestamp when the job was submitted.
        JobName:
          type: string
          description: The name of the job.
        EndTime:
          type: string
          format: date-time
          description: The timestamp when the job completed.
        SourceFormat:
          type: string
          enum:
          - CCDA
          - CSV
          description: The source data format for this job.
      required:
      - JobId
      - JobStatus
      - SubmitTime
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    StartDataTransformationJobResponse:
      type: object
      properties:
        JobId:
          type: string
          description: The unique identifier assigned to the data transformation job.
        JobStatus:
          type: string
          enum:
          - SUBMITTED
          - QUEUED
          - IN_PROGRESS
          - COMPLETED
          - COMPLETED_WITH_ERRORS
          - FAILED
          description: The initial status of the data transformation job.
      required:
      - JobId
      - JobStatus
    ListDataTransformationJobsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.
        NextToken:
          type: string
          description: The pagination token from a previous response. Pass this value to retrieve the next page of results.
        JobStatus:
          type: string
          enum:
          - SUBMITTED
          - QUEUED
          - IN_PROGRESS
          - COMPLETED
          - COMPLETED_WITH_ERRORS
          - FAILED
          description: Filters the results to include only jobs with the specified status.
        JobName:
          type: string
          description: Filters the results to include only jobs with the specified name.
        SubmittedAfter:
          type: string
          format: date-time
          description: Filters the results to include only jobs submitted at or after this timestamp.
        SubmittedBefore:
          type: string
          format: date-time
          description: Filters the results to include only jobs submitted at or before this timestamp.
    DescribeDataTransformationJobResponse:
      type: object
      properties:
        TransformationJobProperties:
          $ref: '#/components/schemas/TransformationJobProperties'
      required:
      - TransformationJobProperties
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
  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: healthlake
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/healthlake/service/2017-07-01/healthlake-2017-07-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)