Version 4.43 or later needs to be installed to add the server automatically
Use cases
About
Generate, run, debug lifescience workflows.
| Attribute | Details |
|---|---|
| Docker Image | mcp/aws-healthomics-mcp-server |
| Author | awslabs |
| Repository | https://github.com/awslabs/mcp |
| Attribute | Details |
|---|---|
| Dockerfile | https://github.com/awslabs/mcp/blob/636aca8e109b5559006044f035bb89c16e9e5410/src/aws-healthomics-mcp-server/Dockerfile |
| Commit | 636aca8e109b5559006044f035bb89c16e9e5410 |
| Docker Image built by | Docker Inc. |
| Docker Scout Health Score | |
| Verify Signature | COSIGN_REPOSITORY=mcp/signatures cosign verify mcp/aws-healthomics-mcp-server --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub |
| Licence | Apache License 2.0 |
| Tools provided by this Server | Short Description |
|---|---|
ActivateAHOReadSets | Activate archived read sets in a HealthOmics sequence store. |
AnalyzeAHORunPerformance | Analyze AWS HealthOmics workflow run performance and provide optimization recommendations. |
CancelAHORunBatch | Cancel all runs in a HealthOmics batch. |
CheckContainerAvailability | Check if a container image is available in ECR and accessible by HealthOmics. |
CloneContainerToECR | Clone a container image to a private ECR repository for HealthOmics use. |
CreateAHOConfiguration | Create a new HealthOmics configuration. |
CreateAHORunCache | Create a new HealthOmics run cache. |
CreateAHORunGroup | Create a new HealthOmics run group. |
CreateAHOSequenceStore | Create a new HealthOmics sequence store. |
CreateAHOWorkflow | Create a new HealthOmics workflow. |
CreateAHOWorkflowVersion | Create a new version of an existing workflow. |
CreateCodeConnection | Create a new CodeConnection. |
CreateContainerRegistryMap | Create a container registry map for HealthOmics workflows. |
CreatePullThroughCacheForHealthOmics | Create a pull-through cache rule configured for HealthOmics. |
DeleteAHOBatch | Delete a HealthOmics batch metadata (does not delete runs). |
DeleteAHOConfiguration | Delete a HealthOmics configuration. |
DeleteAHORunBatch | Delete all runs in a HealthOmics batch. |
DiagnoseAHORunFailure | Provides comprehensive diagnostic information for a failed workflow run. |
GenerateAHORunTimeline | Generate a Gantt-style timeline visualization for an AWS HealthOmics workflow run. |
GetAHOBatch | Get details of a specific HealthOmics batch. |
GetAHOConfiguration | Get details of a specific HealthOmics configuration. |
GetAHOReadSetExportJob | Get details about a read set export job. |
GetAHOReadSetImportJob | Get details about a read set import job. |
GetAHOReadSetMetadata | Get metadata for a specific read set in a HealthOmics sequence store. |
GetAHOReferenceImportJob | Get details about a reference import job. |
GetAHOReferenceMetadata | Get metadata for a specific reference in a HealthOmics reference store. |
GetAHOReferenceStore | Get details about a specific HealthOmics reference store. |
GetAHORun | Get details about a specific run. |
GetAHORunCache | Get details of a specific HealthOmics run cache. |
GetAHORunEngineLogs | Retrieve engine logs containing STDOUT and STDERR from the workflow engine process. |
GetAHORunGroup | Get details of a specific HealthOmics run group. |
GetAHORunLogs | Retrieve high-level run logs that show workflow execution events. |
GetAHORunManifestLogs | Retrieve run manifest logs produced when a workflow completes or fails. |
GetAHORunTask | Get details about a specific task. |
GetAHOSequenceStore | Get details about a specific HealthOmics sequence store. |
GetAHOSupportedRegions | Get the list of AWS regions where HealthOmics is available. |
GetAHOTaskLogs | Retrieve logs for a specific workflow task containing STDOUT and STDERR. |
GetAHOWorkflow | Get details about a specific workflow. |
GetCodeConnection | Get details about a specific CodeConnection. |
GetSupportedFileTypes | Get information about supported genomics file types. |
GrantHealthOmicsRepositoryAccess | Grant HealthOmics access to an ECR repository. |
LintAHOWorkflowBundle | Lint multi-file WDL or CWL workflow bundles and return validation findings. |
LintAHOWorkflowDefinition | Lint WDL or CWL workflow definitions and return validation findings. |
ListAHOBatches | List HealthOmics batches. |
ListAHOConfigurations | List HealthOmics configurations. |
ListAHOReadSetExportJobs | List read set export jobs for a sequence store. |
ListAHOReadSetImportJobs | List read set import jobs for a sequence store. |
ListAHOReadSets | List read sets in a HealthOmics sequence store with optional filtering. |
ListAHOReferenceImportJobs | List reference import jobs for a reference store. |
ListAHOReferenceStores | List HealthOmics reference stores. |
ListAHOReferences | List references in a HealthOmics reference store with optional filtering. |
ListAHORunCaches | List HealthOmics run caches. |
ListAHORunGroups | List HealthOmics run groups. |
ListAHORunTasks | List tasks for a specific run. |
ListAHORuns | List workflow runs. |
ListAHORunsInBatch | List runs within a HealthOmics batch. |
ListAHOSequenceStores | List HealthOmics sequence stores. |
ListAHOWorkflowVersions | List versions of a workflow. |
ListAHOWorkflows | List available HealthOmics workflows. |
ListCodeConnections | List available CodeConnections. |
ListECRRepositories | List ECR repositories with HealthOmics accessibility status. |
ListPullThroughCacheRules | List pull-through cache rules with HealthOmics usability status. |
PackageAHOWorkflow | Package workflow definition files into a base64-encoded ZIP. |
SearchGenomicsFiles | Search for genomics files across S3 buckets, HealthOmics sequence stores, and reference stores. |
StartAHOReadSetExportJob | Start a read set export job to export read sets from a sequence store to S3. |
StartAHOReadSetImportJob | Start a read set import job to import genomic files from S3 into a sequence store. |
StartAHOReferenceImportJob | Start a reference import job to import reference files from S3 into a reference store. |
StartAHORun | Start a workflow run. |
StartAHORunBatch | Start a new HealthOmics run batch. |
UpdateAHORunCache | Update an existing HealthOmics run cache. |
UpdateAHORunGroup | Update an existing HealthOmics run group. |
UpdateAHOSequenceStore | Update a HealthOmics sequence store. |
ValidateHealthOmicsECRConfig | Validate ECR configuration for HealthOmics workflows. |
ActivateAHOReadSetsActivate archived read sets in a HealthOmics sequence store.
Starts an activation job to move read sets from archive storage back to active storage.
| Parameters | Type | Description |
|---|---|---|
read_set_ids | string | List of read set IDs to activate as a JSON list or array, e.g. ["id1", "id2"] |
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
AnalyzeAHORunPerformanceAnalyze AWS HealthOmics workflow run performance and provide optimization recommendations.
This tool analyzes HealthOmics workflow runs to help users optimize:
Use this tool when users ask about:
The tool summarizes run manifest logs containing task-level metrics and provides a structured report with recommendations for optimization.
| Parameters | Type | Description |
|---|---|---|
run_ids | string | List of run IDs to analyze for resource optimization. Can be provided as a JSON array string like ["run1", "run2"] or as a comma-separated string like "run1,run2" |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
detailed | booleanoptional | Include very detailed task metrics in the report. Typically this is only required for granular analysis and can consume a large number of tokens in the agents context window. Default is False. |
headroom | numberoptional | Headroom percentage for instance recommendations (0.0 to 1.0). Default is 0.20 (20%). This adds a buffer to recommended instance sizes to prevent over-optimization. Set this value to 0 for aggressive optimization |
CancelAHORunBatchCancel all runs in a HealthOmics batch.
| Parameters | Type | Description |
|---|---|---|
batch_id | string | ID of the batch to cancel |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
CheckContainerAvailabilityCheck if a container image is available in ECR and accessible by HealthOmics.
Queries ECR to determine if a specific container image exists in a repository and whether HealthOmics has the required permissions to pull the image. For pull-through cache repositories, indicates that the image may be pulled on first access even if not currently cached.
When initiate_pull_through is True and the image is not found in a pull-through cache repository that is accessible to HealthOmics, this function will attempt to initiate the pull-through using ECR's batch_get_image API call. This triggers ECR to pull the image from the upstream registry and cache it locally.
| Parameters | Type | Description |
|---|---|---|
repository_name | string | ECR repository name (e.g., "my-repo" or "docker-hub/library/ubuntu") |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
image_digest | stringoptional | Image digest (sha256:...) - if provided, takes precedence over tag |
image_tag | stringoptional | Image tag to check (default: "latest") |
initiate_pull_through | booleanoptional | If True and the image is not found in a pull-through cache repository that is accessible to HealthOmics, attempt to initiate the pull-through using batch_get_image API call |
CloneContainerToECRClone a container image to a private ECR repository for HealthOmics use.
This tool copies a container image from an upstream registry (Docker Hub, Quay.io, ECR Public) to your private ECR repository with appropriate HealthOmics access permissions. It uses ECR pull-through cache to perform the copy.
The tool will:
Image reference formats supported:
source_image|string|Source container image reference (e.g., "ubuntu:latest", "myorg/myimage:v1", "quay.io/org/image:tag")
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
target_image_tag|stringoptional|Target image tag. If not provided, uses source tag or "latest".
target_repository_name|stringoptional|Target ECR repository name. Only used if no pull-through cache exists. If not provided, derives from source image.CreateAHOConfigurationCreate a new HealthOmics configuration.
| Parameters | Type | Description |
|---|---|---|
name | string | Configuration name (max 50 chars) |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
description | stringoptional | Configuration description |
run_configurations | stringoptional | Run configuration settings (e.g. securityGroupIds and subnetIds) |
tags | stringoptional | Resource tags |
CreateAHORunCacheCreate a new HealthOmics run cache.
| Parameters | Type | Description |
|---|---|---|
cache_behavior | string | Cache behavior (CACHE_ALWAYS or CACHE_ON_FAILURE) |
cache_s3_location | string | S3 URI for cache storage (e.g., s3://bucket/prefix) |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
cache_bucket_owner_id | stringoptional | AWS account ID of the S3 bucket owner for cross-account access |
description | stringoptional | Description for the run cache |
name | stringoptional | Name for the run cache |
tags | stringoptional | Tags to apply to the run cache |
CreateAHORunGroupCreate a new HealthOmics run group.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_cpus | stringoptional | Maximum CPUs for the run group (1-100000) |
max_duration | stringoptional | Maximum duration in minutes (1-100000) |
max_gpus | stringoptional | Maximum GPUs for the run group (1-100000) |
max_runs | stringoptional | Maximum concurrent runs (1-100000) |
name | stringoptional | Name for the run group (1-128 characters) |
tags | stringoptional | Tags to apply to the run group |
CreateAHOSequenceStoreCreate a new HealthOmics sequence store.
| Parameters | Type | Description |
|---|---|---|
name | string | Name for the new sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
description | stringoptional | Optional description for the sequence store |
fallback_location | stringoptional | S3 URI for the fallback location of the sequence store |
sse_kms_key_arn | stringoptional | KMS key ARN for server-side encryption of the sequence store |
tags | stringoptional | Tags to apply to the sequence store as a JSON string or object, e.g. {"key": "value"} |
CreateAHOWorkflowCreate a new HealthOmics workflow.
| Parameters | Type | Description |
|---|---|---|
name | string | Name of the workflow |
accelerators | stringoptional | Computational accelerator type (GPU). Currently unused by the HealthOmics service. Reserved for future support. |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
container_registry_map | stringoptional | Optional container registry map with registryMappings (upstreamRegistryUrl, ecrRepositoryPrefix, upstreamRepositoryPrefix, ecrAccountId) and imageMappings (sourceImage, destinationImage) arrays |
container_registry_map_uri | stringoptional | Optional S3 URI pointing to a JSON file containing container registry mappings. Cannot be used together with container_registry_map |
definition_repository | stringoptional | Git repository configuration with connection_arn, full_repository_id, source_reference (type and value), and optional exclude_file_patterns. Cannot be used together with definition_source or definition_uri |
definition_source | stringoptional | Workflow definition content: a local ZIP file path, S3 URI (s3://bucket/key.zip), or base64-encoded ZIP content. Cannot be used together with definition_uri or definition_repository. |
definition_uri | stringoptional | S3 URI of the workflow definition ZIP file. Cannot be used together with definition_source or definition_repository |
definition_zip_base64 | stringoptional | [Deprecated: use definition_source] Base64-encoded workflow definition ZIP file. |
description | stringoptional | Optional description of the workflow |
engine | stringoptional | Workflow engine type (WDL, NEXTFLOW, CWL, WDL_LENIENT). WDL_LENIENT allows for some WDL directives that don't strictly meet the WDL spec and can be useful when migrating legacy workflows designed to run on Cromwell |
parameter_template | stringoptional | Optional parameter template for the workflow |
parameter_template_path | stringoptional | Path to parameter template JSON file within the repository (only valid with definition_repository) |
path_to_main | stringoptional | Path to the main file in the workflow definition ZIP file. Not required if there is a top level main.wdl, main.cwl or main.nf files in the workflow package. Not required if there is only a single top level workflow file. |
readme | stringoptional | README documentation: markdown content, local .md file path, or S3 URI (s3://bucket/key) |
readme_path | stringoptional | Path to README markdown file within the repository (only valid with definition_repository) |
storage_capacity | stringoptional | Default static storage capacity in GiB for workflow runs (required when storage_type is STATIC) |
storage_type | stringoptional | Storage type for workflow runs (STATIC or DYNAMIC) |
tags | stringoptional | Tags to apply to the workflow as a dict or JSON string, e.g. {"key": "value"} |
workflow_bucket_owner_id | stringoptional | Expected AWS account ID of the S3 bucket owner for definition URI validation |
CreateAHOWorkflowVersionCreate a new version of an existing workflow.
| Parameters | Type | Description |
|---|---|---|
version_name | string | Name for the new version |
workflow_id | string | ID of the workflow |
accelerators | stringoptional | Computational accelerator type (GPU). Currently unused by the HealthOmics service. Reserved for future support. |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
container_registry_map | stringoptional | Optional container registry map with registryMappings (upstreamRegistryUrl, ecrRepositoryPrefix, upstreamRepositoryPrefix, ecrAccountId) and imageMappings (sourceImage, destinationImage) arrays |
container_registry_map_uri | stringoptional | Optional S3 URI pointing to a JSON file containing container registry mappings. Cannot be used together with container_registry_map |
definition_repository | stringoptional | Git repository configuration with connection_arn, full_repository_id, source_reference (type and value), and optional exclude_file_patterns. Cannot be used together with definition_source or definition_uri |
definition_source | stringoptional | Workflow definition content: a local ZIP file path, S3 URI (s3://bucket/key.zip), or base64-encoded ZIP content. Cannot be used together with definition_uri or definition_repository. |
definition_uri | stringoptional | S3 URI of the workflow definition ZIP file. Cannot be used together with definition_source or definition_repository |
definition_zip_base64 | stringoptional | [Deprecated: use definition_source] Base64-encoded workflow definition ZIP file. |
description | stringoptional | Optional description of the workflow version |
engine | stringoptional | Workflow engine type (WDL, NEXTFLOW, CWL, WDL_LENIENT). WDL_LENIENT allows for some WDL directives that don't strictly meet the WDL spec and can be useful when migrating legacy workflows designed to run on Cromwell |
parameter_template | stringoptional | Optional parameter template for the workflow |
parameter_template_path | stringoptional | Path to parameter template JSON file within the repository (only valid with definition_repository) |
path_to_main | stringoptional | Path to the main file in the workflow definition ZIP file. Not required if there is a top level main.wdl, main.cwl or main.nf files in the workflow package. Not required if there is only a single top level workflow file. |
readme | stringoptional | README documentation: markdown content, local .md file path, or S3 URI (s3://bucket/key) |
readme_path | stringoptional | Path to README markdown file within the repository (only valid with definition_repository) |
storage_capacity | stringoptional | Storage capacity in GB (required for STATIC) |
storage_type | stringoptional | Storage type (STATIC or DYNAMIC) |
tags | stringoptional | Tags to apply to the workflow version as a dict or JSON string, e.g. {"key": "value"} |
workflow_bucket_owner_id | stringoptional | Expected AWS account ID of the S3 bucket owner for definition URI validation |
CreateCodeConnectionCreate a new CodeConnection.
This function creates a new AWS CodeConnection for connecting to a third-party Git provider. The connection will be created in PENDING status and requires OAuth authorization in the AWS Console to become AVAILABLE.
| Parameters | Type | Description |
|---|---|---|
connection_name | string | Name for the new connection |
provider_type | string | Git provider type: Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, GitLabSelfManaged |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
tags | stringoptional | Optional tags to apply to the connection |
CreateContainerRegistryMapCreate a container registry map for HealthOmics workflows.
Creates a container registry map file that can be used when creating HealthOmics workflows. Registry mappings allow workflows to use container images from upstream registries (Docker Hub, Quay.io, ECR Public) without modifying the workflow definition. The mappings redirect container pulls to your private ECR pull-through caches.
By default, this tool discovers all HealthOmics-usable pull-through cache rules in your ECR registry and creates mappings for them. You can also provide additional registry mappings or specific image mappings for container overrides.
| Parameters | Type | Description |
|---|---|---|
additional_registry_mappings | stringoptional | Additional registry mappings to include beyond discovered pull-through caches. Each mapping has 'upstreamRegistryUrl' and 'ecrRepositoryPrefix'. |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
ecr_account_id | stringoptional | AWS account ID for ECR repositories. If not provided, uses the current AWS account. |
ecr_region | stringoptional | AWS region for ECR repositories. If not provided, uses the current configured region. |
image_mappings | stringoptional | List of specific image mappings for container overrides. Each mapping has 'sourceImage' and 'destinationImage'. These take precedence over registry mappings. |
include_pull_through_caches | booleanoptional | If true, automatically discovers HealthOmics-usable ECR pull-through cache rules and creates registry mappings for them. |
output_format | stringoptional | Output format: 'json' for raw JSON string, 'dict' for Python dictionary |
CreatePullThroughCacheForHealthOmicsCreate a pull-through cache rule configured for HealthOmics.
Creates an ECR pull-through cache rule for the specified upstream registry and configures the necessary permissions for HealthOmics to use it. This includes:
upstream_registry|string|Upstream registry type: docker-hub, quay, or ecr-public
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
credential_arn|stringoptional|Secrets Manager ARN for registry credentials (required for docker-hub)
ecr_repository_prefix|stringoptional|ECR repository prefix (defaults to registry type name)DeleteAHOBatchDelete a HealthOmics batch metadata (does not delete runs).
| Parameters | Type | Description |
|---|---|---|
batch_id | string | ID of the batch to delete |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
DeleteAHOConfigurationDelete a HealthOmics configuration.
| Parameters | Type | Description |
|---|---|---|
name | string | Configuration name |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
DeleteAHORunBatchDelete all runs in a HealthOmics batch.
| Parameters | Type | Description |
|---|---|---|
batch_id | string | ID of the batch whose runs to delete |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
DiagnoseAHORunFailureProvides comprehensive diagnostic information for a failed workflow run.
This function collects multiple sources of diagnostic information including:
run_id|string|ID of the failed run
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
detailed|booleanoptional|If False, excludes manifest logs and limits engine/task logs to last 50 lines from 15 minutes before stop time to 5 minutes after. If True, includes all logs. False is suitable for most scenariosGenerateAHORunTimelineGenerate a Gantt-style timeline visualization for an AWS HealthOmics workflow run.
This tool creates an SVG Gantt chart showing task execution phases (pending and running) with status-based coloring. The chart helps visualize task parallelism and identify bottlenecks in workflow execution.
Use this tool when users ask about:
The chart displays:
run_id|string|The run ID to generate timeline for.
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
expected_bucket_owner|stringoptional|AWS account ID that must own the target S3 bucket. Defaults to the current caller identity account ID. Set to None to skip bucket owner verification. Only used when output_path is an S3 URI.
output_format|stringoptional|Output format for the timeline. Valid values: svg (raw SVG string, default), base64 (base64-encoded SVG, useful when transport safety is needed to avoid XML/SVG markup mangling in JSON or other text protocols; note the output must be base64-decoded before it can be rendered as SVG). Use svg when writing to a local or s3 path. Defaults to svg.
output_path|stringoptional|Optional file path or S3 URI (s3://bucket/key) where the SVG output will be written. When provided, the response contains only summary metadata instead of the full SVG content. Recommended for complex workflows to avoid context window overflow.
region|stringoptional|AWS region for pricing lookups. Defaults to us-east-1.
theme|stringoptional|Color theme for the timeline visualization. Valid values: light, dark. Use dark for better legibility on dark backgrounds. Defaults to light.
time_unit|stringoptional|Time unit for the timeline axis. Valid values: sec, min, hr, day. Defaults to hr.GetAHOBatchGet details of a specific HealthOmics batch.
| Parameters | Type | Description |
|---|---|---|
batch_id | string | ID of the batch to retrieve |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHOConfigurationGet details of a specific HealthOmics configuration.
| Parameters | Type | Description |
|---|---|---|
name | string | Configuration name |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHOReadSetExportJobGet details about a read set export job.
| Parameters | Type | Description |
|---|---|---|
export_job_id | string | The ID of the export job |
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHOReadSetImportJobGet details about a read set import job.
| Parameters | Type | Description |
|---|---|---|
import_job_id | string | The ID of the import job |
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHOReadSetMetadataGet metadata for a specific read set in a HealthOmics sequence store.
| Parameters | Type | Description |
|---|---|---|
read_set_id | string | The ID of the read set |
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHOReferenceImportJobGet details about a reference import job.
AWS HealthOmics allows only one reference store per account per region. If reference_store_id is not provided, it will be automatically resolved.
| Parameters | Type | Description |
|---|---|---|
import_job_id | string | The ID of the import job |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
reference_store_id | stringoptional | The ID of the reference store. If not provided, auto-resolves the single store in the account/region. |
GetAHOReferenceMetadataGet metadata for a specific reference in a HealthOmics reference store.
AWS HealthOmics allows only one reference store per account per region. If reference_store_id is not provided, it will be automatically resolved.
| Parameters | Type | Description |
|---|---|---|
reference_id | string | The ID of the reference |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
reference_store_id | stringoptional | The ID of the reference store. If not provided, auto-resolves the single store in the account/region. |
GetAHOReferenceStoreGet details about a specific HealthOmics reference store.
AWS HealthOmics allows only one reference store per account per region. If reference_store_id is not provided, it will be automatically resolved.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
reference_store_id | stringoptional | The ID of the reference store. If not provided, auto-resolves the single store in the account/region. |
GetAHORunGet details about a specific run.
| Parameters | Type | Description |
|---|---|---|
run_id | string | ID of the run to retrieve |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHORunCacheGet details of a specific HealthOmics run cache.
| Parameters | Type | Description |
|---|---|---|
cache_id | string | ID of the run cache to retrieve |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHORunEngineLogsRetrieve engine logs containing STDOUT and STDERR from the workflow engine process.
These logs contain all output from the workflow engine process including:
run_id|string|ID of the run
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
end_time|stringoptional|Optional end time for log retrieval (ISO format)
limit|integeroptional|Maximum number of log events to return
next_token|stringoptional|Token for pagination from a previous response
start_from_head|booleanoptional|Whether to start from the beginning (True) or end (False) of the log stream
start_time|stringoptional|Optional start time for log retrieval (ISO format)GetAHORunGroupGet details of a specific HealthOmics run group.
| Parameters | Type | Description |
|---|---|---|
run_group_id | string | ID of the run group to retrieve |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHORunLogsRetrieve high-level run logs that show workflow execution events.
These logs contain a high-level summary of events during a run including:
run_id|string|ID of the run
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
end_time|stringoptional|Optional end time for log retrieval (ISO format)
limit|integeroptional|Maximum number of log events to return
next_token|stringoptional|Token for pagination from a previous response
start_from_head|booleanoptional|Whether to start from the beginning (True) or end (False) of the log stream
start_time|stringoptional|Optional start time for log retrieval (ISO format)GetAHORunManifestLogsRetrieve run manifest logs produced when a workflow completes or fails.
These logs contain a summary of the overall workflow including:
run_id|string|ID of the run
run_uuid|string|Optional UUID of the run
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
end_time|stringoptional|Optional end time for log retrieval (ISO format)
limit|integeroptional|Maximum number of log events to return
next_token|stringoptional|Token for pagination from a previous response
start_from_head|booleanoptional|Whether to start from the beginning (True) or end (False) of the log stream
start_time|stringoptional|Optional start time for log retrieval (ISO format)GetAHORunTaskGet details about a specific task.
| Parameters | Type | Description |
|---|---|---|
run_id | string | ID of the run |
task_id | string | ID of the task |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHOSequenceStoreGet details about a specific HealthOmics sequence store.
| Parameters | Type | Description |
|---|---|---|
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetAHOSupportedRegionsGet the list of AWS regions where HealthOmics is available.
GetAHOTaskLogsRetrieve logs for a specific workflow task containing STDOUT and STDERR.
These logs contain the output from a specific task process including:
run_id|string|ID of the run
task_id|string|ID of the specific task
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
end_time|stringoptional|Optional end time for log retrieval (ISO format)
limit|integeroptional|Maximum number of log events to return
next_token|stringoptional|Token for pagination from a previous response
start_from_head|booleanoptional|Whether to start from the beginning (True) or end (False) of the log stream
start_time|stringoptional|Optional start time for log retrieval (ISO format)GetAHOWorkflowGet details about a specific workflow.
| Parameters | Type | Description |
|---|---|---|
workflow_id | string | ID of the workflow to retrieve |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
export | stringoptional | List of export types (DEFINITION, README) specifying what presigned URLs to include. Takes precedence over export_definition when provided |
export_definition | booleanoptional | Whether to include a presigned URL for downloading the workflow definition ZIP file |
workflow_owner_id | stringoptional | AWS account ID of the workflow owner, used for accessing shared workflows |
workflow_type | stringoptional | Workflow type filter (PRIVATE or READY2RUN). Use READY2RUN to access AWS-provided workflows |
GetCodeConnectionGet details about a specific CodeConnection.
This function retrieves detailed information about a specific AWS CodeConnection, including its current status and guidance on next steps. Use this to check if a connection is ready for use with HealthOmics workflows or if OAuth authorization is still required.
| Parameters | Type | Description |
|---|---|---|
connection_arn | string | ARN of the connection to retrieve |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
GetSupportedFileTypesGet information about supported genomics file types.
GrantHealthOmicsRepositoryAccessGrant HealthOmics access to an ECR repository.
Updates the repository policy to allow the HealthOmics service principal (omics.amazonaws.com) to pull images. This adds the required permissions:
If the repository already has a policy, the HealthOmics permissions are added while preserving existing statements. If no policy exists, a new policy is created.
| Parameters | Type | Description |
|---|---|---|
repository_name | string | ECR repository name to grant HealthOmics access to |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
LintAHOWorkflowBundleLint multi-file WDL or CWL workflow bundles and return validation findings.
This tool validates multi-file workflow bundles using appropriate linting tools:
The tool creates a temporary directory structure that preserves the relative file paths, allowing proper resolution of imports and dependencies between workflow files.
The tool checks for:
main_workflow_file|string|Path to the main workflow file within the bundle
workflow_files|string|Dictionary mapping file paths to their content, a local directory path, a ZIP file path, or an S3 URI (s3://bucket/prefix/ or s3://bucket/file.zip).
workflow_format|string|The workflow format: 'wdl' or 'cwl'LintAHOWorkflowDefinitionLint WDL or CWL workflow definitions and return validation findings.
This tool validates workflow definitions using appropriate linting tools:
The tool checks for:
workflow_content|string|The workflow definition content to lint. Accepts inline content, a local file path, or an S3 URI (s3://bucket/key).
workflow_format|string|The workflow format: 'wdl' or 'cwl'
filename|stringoptional|Optional filename for contextListAHOBatchesList HealthOmics batches.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
name | stringoptional | Filter by batch name |
next_token | stringoptional | Token for pagination from a previous response |
run_group_id | stringoptional | Filter by run group ID |
status | stringoptional | Filter by batch status |
ListAHOConfigurationsList HealthOmics configurations.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
ListAHOReadSetExportJobsList read set export jobs for a sequence store.
| Parameters | Type | Description |
|---|---|---|
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
ListAHOReadSetImportJobsList read set import jobs for a sequence store.
| Parameters | Type | Description |
|---|---|---|
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
ListAHOReadSetsList read sets in a HealthOmics sequence store with optional filtering.
| Parameters | Type | Description |
|---|---|---|
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
created_after | stringoptional | Filter for read sets created after this ISO 8601 datetime |
created_before | stringoptional | Filter for read sets created before this ISO 8601 datetime |
file_type | stringoptional | Filter by file type (FASTQ, BAM, CRAM, or UBAM) |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
reference_arn | stringoptional | Filter by reference ARN |
sample_id | stringoptional | Filter by sample ID |
status | stringoptional | Filter by read set status (e.g., ACTIVE, ARCHIVED) |
subject_id | stringoptional | Filter by subject ID |
ListAHOReferenceImportJobsList reference import jobs for a reference store.
AWS HealthOmics allows only one reference store per account per region. If reference_store_id is not provided, it will be automatically resolved.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
reference_store_id | stringoptional | The ID of the reference store. If not provided, auto-resolves the single store in the account/region. |
ListAHOReferenceStoresList HealthOmics reference stores.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
name_filter | stringoptional | Filter stores by name |
next_token | stringoptional | Token for pagination from a previous response |
ListAHOReferencesList references in a HealthOmics reference store with optional filtering.
AWS HealthOmics allows only one reference store per account per region. If reference_store_id is not provided, it will be automatically resolved.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
name_filter | stringoptional | Filter references by name |
next_token | stringoptional | Token for pagination from a previous response |
reference_store_id | stringoptional | The ID of the reference store. If not provided, auto-resolves the single store in the account/region. |
status_filter | stringoptional | Filter references by status (e.g., ACTIVE, DELETING) |
ListAHORunCachesList HealthOmics run caches.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
cache_behavior | stringoptional | Filter by cache behavior |
max_results | integeroptional | Maximum number of results to return |
name | stringoptional | Filter by run cache name |
next_token | stringoptional | Token for pagination from a previous response |
status | stringoptional | Filter by run cache status |
ListAHORunGroupsList HealthOmics run groups.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
name | stringoptional | Filter by run group name |
next_token | stringoptional | Token for pagination from a previous response |
ListAHORunTasksList tasks for a specific run.
| Parameters | Type | Description |
|---|---|---|
run_id | string | ID of the run |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
status | stringoptional | Filter by task status |
ListAHORunsList workflow runs.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
created_after | stringoptional | Filter for runs created after this timestamp (ISO format) |
created_before | stringoptional | Filter for runs created before this timestamp (ISO format) |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
run_group_id | stringoptional | Optional run group ID to filter runs |
status | stringoptional | Filter by run status |
ListAHORunsInBatchList runs within a HealthOmics batch.
| Parameters | Type | Description |
|---|---|---|
batch_id | string | ID of the batch |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
run_id | stringoptional | Filter by run ID |
run_setting_id | stringoptional | Filter by run setting ID |
submission_status | stringoptional | Filter by submission status |
ListAHOSequenceStoresList HealthOmics sequence stores.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
name_filter | stringoptional | Filter stores by name |
next_token | stringoptional | Token for pagination from a previous response |
ListAHOWorkflowVersionsList versions of a workflow.
| Parameters | Type | Description |
|---|---|---|
workflow_id | string | ID of the workflow |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
ListAHOWorkflowsList available HealthOmics workflows.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
ListCodeConnectionsList available CodeConnections.
This function retrieves existing CodeConnections that can be used with HealthOmics workflows. Connections can be filtered by provider type and results are paginated.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Token for pagination from a previous response |
provider_type_filter | stringoptional | Filter by provider type: Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, GitLabSelfManaged |
ListECRRepositoriesList ECR repositories with HealthOmics accessibility status.
Lists all ECR repositories in the current region and checks each repository's policy to determine if HealthOmics has the required permissions to pull images.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
filter_healthomics_accessible | booleanoptional | Only return repositories accessible by HealthOmics |
max_results | integeroptional | Maximum number of results to return |
next_token | stringoptional | Pagination token from a previous response |
ListPullThroughCacheRulesList pull-through cache rules with HealthOmics usability status.
Lists all ECR pull-through cache rules in the current region and evaluates each rule's usability by HealthOmics. A pull-through cache is usable by HealthOmics if:
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
max_results|integeroptional|Maximum number of results to return
next_token|stringoptional|Pagination token from a previous responsePackageAHOWorkflowPackage workflow definition files into a base64-encoded ZIP.
| Parameters | Type | Description |
|---|---|---|
main_file_content | string | Content of the main workflow file. Accepts inline content, a local file path, or an S3 URI (s3://bucket/key). |
additional_files | stringoptional | Dictionary of additional files (filename: content). Values accept inline content, local file paths, or S3 URIs. |
expected_bucket_owner | stringoptional | AWS account ID that must own the target S3 bucket. Defaults to the current caller identity account ID. Set to None to skip bucket owner verification. Only used when output_path is an S3 URI. |
main_file_name | stringoptional | Name of the main workflow file |
output_path | stringoptional | Optional file path or S3 URI (s3://bucket/key) where the ZIP output will be written. When provided, the response contains only summary metadata instead of the full base64-encoded ZIP content. |
SearchGenomicsFilesSearch for genomics files across S3 buckets, HealthOmics sequence stores, and reference stores.
This tool provides intelligent search capabilities with pattern matching, file association detection, and ranked results based on relevance scoring. It can find genomics files across multiple storage locations and automatically group related files together.
| Parameters | Type | Description |
|---|---|---|
adhoc_s3_buckets | stringoptional | Optional list of additional S3 bucket paths to search (e.g., ["s3://bucket-name/prefix/"]). These buckets will be searched in addition to any configured buckets, allowing you to search buckets that are not part of the standard configuration. Maximum 50 bucket paths. |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
continuation_token | stringoptional | Continuation token from previous search response for paginated results |
enable_storage_pagination | booleanoptional | Enable efficient storage-level pagination for large datasets (recommended for >1000 results) |
file_type | stringoptional | Optional file type filter. Valid types: fastq, fasta, fna, bam, cram, sam, vcf, gvcf, bcf, bed, gff, bai, crai, fai, dict, tbi, csi, bwa_amb, bwa_ann, bwa_bwt, bwa_pac, bwa_sa |
include_associated_files | booleanoptional | Whether to include associated files (e.g., BAM index files, FASTQ pairs) in the results |
max_results | integeroptional | Maximum number of results to return (1-10000) |
offset | integeroptional | Number of results to skip for pagination (0-based offset), ignored if enable_storage_pagination is true |
pagination_buffer_size | integeroptional | Buffer size for storage-level pagination (100-50000). Larger values improve ranking accuracy but use more memory. |
search_terms | arrayoptional | List of search terms to match against file paths, tags and metadata. If empty, returns all files of the specified file type. |
StartAHOReadSetExportJobStart a read set export job to export read sets from a sequence store to S3.
| Parameters | Type | Description |
|---|---|---|
destination_s3_uri | string | S3 URI for the export destination |
read_set_ids | string | List of read set IDs to export as a JSON list or array, e.g. ["id1", "id2"] |
role_arn | string | IAM role ARN for the export job |
sequence_store_id | string | The ID of the sequence store |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
StartAHOReadSetImportJobStart a read set import job to import genomic files from S3 into a sequence store.
| Parameters | Type | Description |
|---|---|---|
role_arn | string | IAM role ARN for the import job |
sequence_store_id | string | The ID of the sequence store |
sources | string | JSON list of import sources. Each source requires: sourceFileType (FASTQ |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
tags | stringoptional | Tags to apply to the import job as a JSON string or object, e.g. {"key": "value"} |
StartAHOReferenceImportJobStart a reference import job to import reference files from S3 into a reference store.
AWS HealthOmics allows only one reference store per account per region. If reference_store_id is not provided, it will be automatically resolved.
Each source in the sources list is validated against the ReferenceImportSource model and must include:
Example sources JSON: [{"sourceFile": "s3://bucket/GRCh38.fasta", "name": "GRCh38", "description": "Human reference genome build 38", "tags": {"build": "38", "species": "human"}}]
| Parameters | Type | Description |
|---|---|---|
role_arn | string | IAM role ARN for the import job |
sources | string | JSON list of import sources. Each source requires: sourceFile (S3 URI to a FASTA reference file), name. Optional fields: description, tags. Example: [{"sourceFile": "s3://bucket/GRCh38.fasta", "name": "GRCh38", "description": "Human reference genome build 38", "tags": {"build": "38", "species": "human"}}] |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
reference_store_id | stringoptional | The ID of the reference store. If not provided, auto-resolves the single store in the account/region. |
StartAHORunStart a workflow run.
| Parameters | Type | Description |
|---|---|---|
name | string | Name for the run |
output_uri | string | S3 URI for the run outputs |
parameters | string | Parameters for the workflow. Parameter names must match one of the keys in the workflow's parameter template. |
All non-optional parameters must be present, if they are not provided the workflow run will not start. No other parameter names are allowed.
The descriptions of the parameters in the parameter template may provide clues to the type of the parameter. It may be
necessary to inspect the workflow definition to determine the appropriate parameter type.
role_arn|string|ARN of the IAM role to use for the run
workflow_id|string|ID of the workflow to run
aws_profile|stringoptional|AWS profile name for this operation. Overrides the default credential chain.
aws_region|stringoptional|AWS region for this operation. Overrides the server default.
cache_behavior|stringoptional|Optional cache behavior (CACHE_ALWAYS or CACHE_ON_FAILURE)
cache_id|stringoptional|Optional ID of a run cache to use
configuration_name|stringoptional|Configuration name (required when networking_mode is VPC)
networking_mode|stringoptional|Networking mode: RESTRICTED (default) or VPC
run_group_id|stringoptional|Optional ID of a run group to associate with this run
scratch_storage_mode|stringoptional|Scratch storage mode for the run. Allowed values: LOCAL (mount local EBS ephemeral scratch storage at /tmp for CPU tasks) or SHARED (use shared scratch storage). Defaults to LOCAL when omitted (the MCP server default; note the HealthOmics API default is SHARED).
storage_capacity|stringoptional|Storage capacity in GB (required for STATIC). Storage is allocated in 1200 GiB chunks
storage_type|stringoptional|Storage type (STATIC or DYNAMIC). DYNAMIC is preferred except for runs with very large inputs (TiBs).
workflow_version_name|stringoptional|Optional version name to run
StartAHORunBatchStart a new HealthOmics run batch.
| Parameters | Type | Description |
|---|---|---|
batch_run_settings | object | Batch run settings with either inlineSettings (list of up to 100 run configs) or s3UriSettings (S3 URI for configs) |
output_uri | string | S3 URI for output files |
role_arn | string | IAM role ARN for the batch runs |
workflow_id | string | ID of the workflow to run |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
batch_name | stringoptional | Name for the batch |
cache_behavior | stringoptional | Cache behavior: CACHE_ALWAYS or CACHE_ON_FAILURE |
cache_id | stringoptional | Run cache ID |
parameters | stringoptional | Default parameters for all runs in the batch |
request_id | stringoptional | Idempotency token |
retention_mode | stringoptional | Retention mode: RETAIN or REMOVE |
run_group_id | stringoptional | Run group ID |
scratch_storage_mode | stringoptional | Scratch storage mode applied to all runs in the batch. Allowed values: LOCAL (mount local EBS ephemeral scratch storage at /tmp for CPU tasks) or SHARED (use shared scratch storage). Defaults to LOCAL when omitted (the MCP server default; note the HealthOmics API default is SHARED). |
storage_capacity | stringoptional | Storage capacity in GB (required for STATIC storage) |
storage_type | stringoptional | Storage type: STATIC or DYNAMIC |
tags | stringoptional | Tags for the batch |
workflow_type | stringoptional | Workflow type: WDL, NEXTFLOW, or CWL |
workflow_version_name | stringoptional | Version name of the workflow |
UpdateAHORunCacheUpdate an existing HealthOmics run cache.
| Parameters | Type | Description |
|---|---|---|
cache_id | string | ID of the run cache to update |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
cache_behavior | stringoptional | New cache behavior |
description | stringoptional | New description for the run cache |
name | stringoptional | New name for the run cache |
UpdateAHORunGroupUpdate an existing HealthOmics run group.
| Parameters | Type | Description |
|---|---|---|
run_group_id | string | ID of the run group to update |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
max_cpus | stringoptional | New maximum CPUs |
max_duration | stringoptional | New maximum duration in minutes |
max_gpus | stringoptional | New maximum GPUs |
max_runs | stringoptional | New maximum concurrent runs |
name | stringoptional | New name for the run group |
UpdateAHOSequenceStoreUpdate a HealthOmics sequence store.
Internally fetches the current ETag before performing the update to handle optimistic concurrency control.
| Parameters | Type | Description |
|---|---|---|
sequence_store_id | string | The ID of the sequence store to update |
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
description | stringoptional | New description for the sequence store |
fallback_location | stringoptional | New S3 URI for the fallback location |
name | stringoptional | New name for the sequence store |
ValidateHealthOmicsECRConfigValidate ECR configuration for HealthOmics workflows.
Performs a comprehensive validation of the ECR configuration to ensure HealthOmics workflows can access container images through pull-through caches. This includes checking:
For each issue found, provides specific remediation steps.
| Parameters | Type | Description |
|---|---|---|
aws_profile | stringoptional | AWS profile name for this operation. Overrides the default credential chain. |
aws_region | stringoptional | AWS region for this operation. Overrides the server default. |
{
"mcpServers": {
"aws-healthomics": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"AWS_REGION",
"-e",
"AWS_PROFILE",
"mcp/aws-healthomics-mcp-server"
],
"env": {
"AWS_REGION": "us-east-1",
"AWS_PROFILE": "default"
}
}
}
}