AWS HealthLake Export API
Asynchronous bulk export operations for exporting FHIR resources to Amazon S3
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/aws-healthlake:aws-healthlake-export-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Aws Healthlake Export API
version: '2017-07-01'
description: 'Operations tagged Export across 2 of this provider''s published API definitions: openapi.json, aws-healthlake-export-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://healthlake.{region}.amazonaws.com
description: AWS HealthLake regional endpoint
variables:
region:
default: us-east-1
description: AWS region identifier
enum:
- us-east-1
- us-east-2
- us-west-2
- ap-southeast-2
- eu-west-1
tags:
- name: Export
description: Asynchronous bulk export operations for exporting FHIR resources to Amazon S3
paths:
/#X-Amz-Target=HealthLake.DescribeFHIRExportJob:
post:
operationId: describeFHIRExportJob
summary: DescribeFHIRExportJob
description: Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
tags:
- Export
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- HealthLake.DescribeFHIRExportJob
description: 'The AWS service action target: HealthLake.DescribeFHIRExportJob'
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeFHIRExportJobResponse'
'400':
description: Client error (validation, throttling, conflict, access denied)
content:
application/x-amz-json-1.0:
schema:
type: object
properties:
__type:
type: string
description: Exception type
Message:
type: string
description: Error message
'500':
description: Internal server error
content:
application/x-amz-json-1.0:
schema:
type: object
properties:
__type:
type: string
description: Exception type
Message:
type: string
description: Error message
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeFHIRExportJobRequest'
security:
- aws_v4: []
servers:
- url: https://healthlake.{region}.amazonaws.com
description: AWS HealthLake regional endpoint
variables:
region:
default: us-east-1
description: AWS region identifier
enum:
- us-east-1
- us-east-2
- us-west-2
- ap-southeast-2
- eu-west-1
/#X-Amz-Target=HealthLake.ListFHIRExportJobs:
post:
operationId: listFHIRExportJobs
summary: ListFHIRExportJobs
description: Lists all FHIR export jobs associated with an account and their statuses.
tags:
- Export
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- HealthLake.ListFHIRExportJobs
description: 'The AWS service action target: HealthLake.ListFHIRExportJobs'
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListFHIRExportJobsResponse'
'400':
description: Client error (validation, throttling, conflict, access denied)
content:
application/x-amz-json-1.0:
schema:
type: object
properties:
__type:
type: string
description: Exception type
Message:
type: string
description: Error message
'500':
description: Internal server error
content:
application/x-amz-json-1.0:
schema:
type: object
properties:
__type:
type: string
description: Exception type
Message:
type: string
description: Error message
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListFHIRExportJobsRequest'
security:
- aws_v4: []
servers:
- url: https://healthlake.{region}.amazonaws.com
description: AWS HealthLake regional endpoint
variables:
region:
default: us-east-1
description: AWS region identifier
enum:
- us-east-1
- us-east-2
- us-west-2
- ap-southeast-2
- eu-west-1
/#X-Amz-Target=HealthLake.StartFHIRExportJob:
post:
operationId: startFHIRExportJob
summary: StartFHIRExportJob
description: Begins a FHIR export job.
tags:
- Export
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- HealthLake.StartFHIRExportJob
description: 'The AWS service action target: HealthLake.StartFHIRExportJob'
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/StartFHIRExportJobResponse'
'400':
description: Client error (validation, throttling, conflict, access denied)
content:
application/x-amz-json-1.0:
schema:
type: object
properties:
__type:
type: string
description: Exception type
Message:
type: string
description: Error message
'500':
description: Internal server error
content:
application/x-amz-json-1.0:
schema:
type: object
properties:
__type:
type: string
description: Exception type
Message:
type: string
description: Error message
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/StartFHIRExportJobRequest'
security:
- aws_v4: []
servers:
- url: https://healthlake.{region}.amazonaws.com
description: AWS HealthLake regional endpoint
variables:
region:
default: us-east-1
description: AWS region identifier
enum:
- us-east-1
- us-east-2
- us-west-2
- ap-southeast-2
- eu-west-1
/#DescribeFHIRExportJob:
post:
operationId: DescribeFHIRExportJob
summary: Describe FHIRExport Job
description: Get FHIR export job properties.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeFHIRExportJobResponse_2'
'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.DescribeFHIRExportJob
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeFHIRExportJobRequest_2'
tags:
- Export
security:
- sigv4: []
servers:
- url: https://healthlake.{region}.amazonaws.com
variables:
region:
default: us-east-1
/#ListFHIRExportJobs:
post:
operationId: ListFHIRExportJobs
summary: List FHIRExport Jobs
description: Lists all FHIR export jobs associated with an account and their statuses.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListFHIRExportJobsResponse_2'
'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.ListFHIRExportJobs
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListFHIRExportJobsRequest_2'
tags:
- Export
security:
- sigv4: []
servers:
- url: https://healthlake.{region}.amazonaws.com
variables:
region:
default: us-east-1
/#StartFHIRExportJob:
post:
operationId: StartFHIRExportJob
summary: Start FHIRExport Job
description: Start a FHIR export job.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/StartFHIRExportJobResponse_2'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'424':
description: FailedDependencyException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/FailedDependencyException'
'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.StartFHIRExportJob
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/StartFHIRExportJobRequest_2'
tags:
- Export
security:
- sigv4: []
servers:
- url: https://healthlake.{region}.amazonaws.com
variables:
region:
default: us-east-1
components:
schemas:
ListFHIRExportJobsResponse:
type: object
properties:
ExportJobPropertiesList:
type: array
items:
type: object
properties:
JobId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
JobName:
type: string
minLength: 1
maxLength: 64
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
JobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED_WITH_ERRORS
- COMPLETED
- FAILED
- CANCEL_SUBMITTED
- CANCEL_IN_PROGRESS
- CANCEL_COMPLETED
- CANCEL_FAILED
SubmitTime:
type: string
format: date-time
EndTime:
type: string
format: date-time
DatastoreId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
OutputDataConfig:
type: object
properties:
S3Configuration:
type: object
properties:
S3Uri:
type: string
maxLength: 1024
pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
KmsKeyId:
type: string
minLength: 1
maxLength: 400
pattern: (arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\d:)?(\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))
required:
- S3Uri
- KmsKeyId
DataAccessRoleArn:
type: string
minLength: 20
maxLength: 2048
pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
Message:
type: string
minLength: 1
maxLength: 2048
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
required:
- JobId
- JobStatus
- SubmitTime
- DatastoreId
- OutputDataConfig
NextToken:
type: string
maxLength: 8192
pattern: \p{ASCII}{0,8192}
required:
- ExportJobPropertiesList
DescribeFHIRExportJobResponse:
type: object
properties:
ExportJobProperties:
type: object
properties:
JobId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
JobName:
type: string
minLength: 1
maxLength: 64
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
JobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED_WITH_ERRORS
- COMPLETED
- FAILED
- CANCEL_SUBMITTED
- CANCEL_IN_PROGRESS
- CANCEL_COMPLETED
- CANCEL_FAILED
SubmitTime:
type: string
format: date-time
EndTime:
type: string
format: date-time
DatastoreId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
OutputDataConfig:
type: object
properties:
S3Configuration:
type: object
properties:
S3Uri:
type: string
maxLength: 1024
pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
KmsKeyId:
type: string
minLength: 1
maxLength: 400
pattern: (arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\d:)?(\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))
required:
- S3Uri
- KmsKeyId
DataAccessRoleArn:
type: string
minLength: 20
maxLength: 2048
pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
Message:
type: string
minLength: 1
maxLength: 2048
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
required:
- JobId
- JobStatus
- SubmitTime
- DatastoreId
- OutputDataConfig
required:
- ExportJobProperties
ListFHIRExportJobsRequest:
type: object
properties:
DatastoreId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
NextToken:
type: string
maxLength: 8192
pattern: \p{ASCII}{0,8192}
MaxResults:
type: integer
format: int32
minimum: 1
maximum: 500
JobName:
type: string
minLength: 1
maxLength: 64
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
JobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED_WITH_ERRORS
- COMPLETED
- FAILED
- CANCEL_SUBMITTED
- CANCEL_IN_PROGRESS
- CANCEL_COMPLETED
- CANCEL_FAILED
SubmittedBefore:
type: string
format: date-time
SubmittedAfter:
type: string
format: date-time
required:
- DatastoreId
StartFHIRExportJobResponse:
type: object
properties:
JobId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
JobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED_WITH_ERRORS
- COMPLETED
- FAILED
- CANCEL_SUBMITTED
- CANCEL_IN_PROGRESS
- CANCEL_COMPLETED
- CANCEL_FAILED
DatastoreId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
required:
- JobId
- JobStatus
DescribeFHIRExportJobRequest:
type: object
properties:
DatastoreId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
JobId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
required:
- DatastoreId
- JobId
StartFHIRExportJobRequest:
type: object
properties:
JobName:
type: string
minLength: 1
maxLength: 64
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
OutputDataConfig:
type: object
properties:
S3Configuration:
type: object
properties:
S3Uri:
type: string
maxLength: 1024
pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
KmsKeyId:
type: string
minLength: 1
maxLength: 400
pattern: (arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\d:)?(\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))
required:
- S3Uri
- KmsKeyId
DatastoreId:
type: string
minLength: 1
maxLength: 32
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
DataAccessRoleArn:
type: string
minLength: 20
maxLength: 2048
pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
ClientToken:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9-]+$
required:
- OutputDataConfig
- DatastoreId
- DataAccessRoleArn
- ClientToken
AccessDeniedException:
type: object
properties:
Message:
type: string
ListFHIRExportJobsResponse_2:
type: object
properties:
ExportJobPropertiesList:
type: array
items:
$ref: '#/components/schemas/ExportJobProperties'
description: The properties of listed FHIR export jobs.
NextToken:
type: string
description: The pagination token used to identify the next page of results to return.
required:
- ExportJobPropertiesList
DescribeFHIRExportJobResponse_2:
type: object
properties:
ExportJobProperties:
$ref: '#/components/schemas/ExportJobProperties'
required:
- ExportJobProperties
ListFHIRExportJobsRequest_2:
type: object
properties:
DatastoreId:
type: string
description: Limits the response to the export job with the specified data store ID.
NextToken:
type: string
description: A pagination token used to identify the next page of results to return.
MaxResults:
type: integer
description: Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
JobName:
type: string
description: Limits the response to the export job with the specified job name.
JobStatus:
type: string
enum:
- SUBMITTED
- QUEUED
- IN_PROGRESS
- COMPLETED_WITH_ERRORS
- COMPLETED
- FAILED
- CANCEL_SUBMITTED
- CANCEL_IN_PROGRESS
- CANCEL_COMPLETED
- CANCEL_FAILED
description: Limits the response to export jobs with the specified job status.
SubmittedBefore:
type: string
format: date-time
description: Limits the response to FHIR export jobs submitted before a user- specified date.
SubmittedAfter:
type: string
format: date-time
description: Limits the response to FHIR export jobs submitted after a user-specified date.
required:
- DatastoreId
OutputDataConfig:
type: object
properties:
S3Configuration:
$ref: '#/components/schemas/S3Configuration'
description: Exactly one member is set.
StartFHIRExportJobResponse_2:
type: object
properties:
JobId:
type: string
description: The export job identifier.
JobStatus:
type: string
enum:
- SUBMITTED
- QUEUED
- IN_PROGRESS
- COMPLETED_WITH_ERRORS
- COMPLETED
- FAILED
- CANCEL_SUBMITTED
- CANCEL_IN_PROGRESS
- CANCEL_COMPLETED
- CANCEL_FAILED
description: The export job status.
DatastoreId:
type: string
description: The data store identifier from which files are being exported.
required:
- JobId
- JobStatus
InternalServerException:
type: object
properties:
Message:
type: string
ValidationException:
type: object
properties:
Message:
type: string
S3Configuration:
type: object
properties:
S3Uri:
type: string
description: The S3Uri is the user-specified Amazon S3 location of the FHIR data to be imported into HealthLake.
KmsKeyId:
type: string
description: The Key Management Service (KMS) key ID used to access the Amazon S3 bucket.
required:
- S3Uri
- KmsKeyId
FailedDependencyException:
type: object
properties:
Message:
type: string
description: A message describing the error.
ThrottlingException:
type: object
properties:
Message:
type: string
DescribeFHIRExportJobRequest_2:
type: object
properties:
DatastoreId:
type: string
description: The data store identifier from which FHIR data is being exported from.
JobId:
type: string
description: The export job identifier.
required:
- DatastoreId
- JobId
StartFHIRExportJobRequest_2:
type: object
properties:
JobName:
type: string
description: The export job name.
OutputDataConfig:
$ref: '#/components/schemas/OutputDataConfig'
DatastoreId:
type: string
description: The data store identifier from which files are being exported.
DataAccessRoleArn:
type: string
description: The Amazon Resource Name (ARN) used during initiation of the export job.
ClientToken:
type: string
description: An optional user provided token used for ensuring API idempotency.
required:
- OutputDataConfig
- DatastoreId
- DataAccessRoleArn
ResourceNotFoundException:
type: object
properties:
Message:
type: string
ExportJobProperties:
type: object
properties:
JobId:
type: string
description: The export job identifier.
JobName:
type: string
description: The export job name.
JobStatus:
type: string
enum:
- SUBMITTED
- QUEUED
- IN_PROGRESS
- COMPLETED_WITH_ERRORS
- COMPLETED
- FAILED
- CANCEL_SUBMITTED
- CANCEL_IN_PROGRESS
- CANCEL_COMPLETED
- CANCEL_FAILED
description: The export job status.
SubmitTime:
type: string
format: date-time
description: The time the export job was initiated.
EndTime:
type: string
format: date-time
description: The time the export job completed.
DatastoreId:
type: string
description: The data store identifier from which files are being exported.
OutputDataConfig:
$ref: '#/components/schemas/OutputDataConfig'
DataAccessRoleArn:
type: string
description: The Amazon Resource Name (ARN) used during the initiation of the export job.
Message:
type: string
description: An explanation of any errors that might have occurred during the export job.
required:
- JobId
- JobStatus
- SubmitTime
- DatastoreId
- OutputDataConfig
securitySchemes:
aws_v4:
type: apiKey
in: header
name: Authorization
description: 'AWS Signature Version 4. Sign requests with your AWS access key and secret key. See: https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html'
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
externalDocs:
description: Amazon HealthLake API Reference
url: https://docs.aws.amazon.com/healthlake/latest/APIReference/Welcome.html
x-refined-from:
- openapi.json
- aws-healthlake-export-api-openapi.yml