Module Awso_omics.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule SchemaItemKeyString : sig ... end
Sourcemodule SchemaValueType : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule FormatToHeaderKey : sig ... end
Sourcemodule FormatToHeaderValueString : sig ... end
Sourcemodule SchemaItem : sig ... end
Sourcemodule AwsAccountId : sig ... end
Sourcemodule RunName : sig ... end
Sourcemodule RunOutputUri : sig ... end
Sourcemodule RunParameters : sig ... end
Sourcemodule RunSettingId : sig ... end
Sourcemodule TagMap : sig ... end
Sourcemodule S3Uri : sig ... end
Sourcemodule CommentChar : sig ... end
Sourcemodule Encoding : sig ... end
Sourcemodule EscapeChar : sig ... end
Sourcemodule EscapeQuotes : sig ... end
Sourcemodule Header : sig ... end
Sourcemodule LineSep : sig ... end
Sourcemodule Quote : sig ... end
Sourcemodule QuoteAll : sig ... end
Sourcemodule Separator : sig ... end
Sourcemodule WorkflowMetadataKey : sig ... end
Sourcemodule WorkflowMetadataValue : sig ... end
Sourcemodule ReferenceArn : sig ... end
Sourcemodule EncryptionType : sig ... end
Sourcemodule SseConfigKeyArnString : sig ... end
Sourcemodule ETagAlgorithm : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule GeneratedFrom : sig ... end
Sourcemodule Long : sig ... end
Sourcemodule Uri_ : sig ... end
Sourcemodule EcrRepositoryPrefix : sig ... end
Sourcemodule UpstreamRepositoryPrefix : sig ... end
Sourcemodule SecurityGroupId : sig ... end
Sourcemodule SubnetId : sig ... end
Sourcemodule AnnotationType : sig ... end
Sourcemodule FormatToHeader : sig ... end
Sourcemodule TsvStoreOptionsSchemaList : sig ... end
Sourcemodule InlineSetting : sig ... end

A per-run configuration that overrides or merges with fields from DefaultRunSetting for a specific run.

Sourcemodule ReferenceDescription : sig ... end
Sourcemodule ReferenceName : sig ... end
Sourcemodule FileType : sig ... end
Sourcemodule ReadSetDescription : sig ... end
Sourcemodule ReadSetName : sig ... end
Sourcemodule SampleId : sig ... end
Sourcemodule SourceFiles : sig ... end

Source files for a sequence.

Sourcemodule SubjectId : sig ... end
Sourcemodule ReadSetId : sig ... end
Sourcemodule ReadOptions : sig ... end

Read options for an annotation import job.

Sourcemodule Boolean : sig ... end
Sourcemodule WorkflowArn : sig ... end
Sourcemodule WorkflowDigest : sig ... end
Sourcemodule WorkflowId : sig ... end
Sourcemodule WorkflowMetadata : sig ... end
Sourcemodule WorkflowName : sig ... end
Sourcemodule WorkflowStatus : sig ... end
Sourcemodule WorkflowTimestamp : sig ... end
Sourcemodule WorkflowType : sig ... end
Sourcemodule WorkflowVersionArn : sig ... end
Sourcemodule WorkflowVersionName : sig ... end
Sourcemodule Arn : sig ... end
Sourcemodule CreationTime : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule ReferenceItem : sig ... end

A genome reference.

Sourcemodule ResourceId : sig ... end
Sourcemodule SseConfig : sig ... end

Server-side encryption (SSE) settings for a store.

Sourcemodule StatusMessage : sig ... end
Sourcemodule StoreStatus : sig ... end
Sourcemodule UpdateTime : sig ... end
Sourcemodule AnnotationFieldMap : sig ... end
Sourcemodule CompletionTime : sig ... end
Sourcemodule JobStatus : sig ... end
Sourcemodule RunLeftNormalization : sig ... end
Sourcemodule ShareName : sig ... end
Sourcemodule ShareStatus : sig ... end
Sourcemodule ShareResourceType : sig ... end
Sourcemodule ETagAlgorithmFamily : sig ... end
Sourcemodule FallbackLocation : sig ... end
Sourcemodule SequenceStoreArn : sig ... end
Sourcemodule SequenceStoreDescription : sig ... end
Sourcemodule SequenceStoreId : sig ... end
Sourcemodule SequenceStoreName : sig ... end
Sourcemodule SequenceStoreStatus : sig ... end
Sourcemodule BatchId : sig ... end
Sourcemodule RunArn : sig ... end
Sourcemodule RunId : sig ... end
Sourcemodule RunStatus : sig ... end
Sourcemodule RunTimestamp : sig ... end
Sourcemodule StorageType : sig ... end
Sourcemodule RunUuid : sig ... end
Sourcemodule SubmissionFailureMessage : sig ... end
Sourcemodule SubmissionFailureReason : sig ... end
Sourcemodule SubmissionStatus : sig ... end
Sourcemodule S3UriForBucketOrObject : sig ... end

Uri to a S3 object or bucket

Sourcemodule TaskId : sig ... end
Sourcemodule TaskInstanceType : sig ... end
Sourcemodule TaskListItemCpusInteger : sig ... end
Sourcemodule TaskListItemGpusInteger : sig ... end
Sourcemodule TaskListItemMemoryInteger : sig ... end
Sourcemodule TaskName : sig ... end
Sourcemodule TaskStatus : sig ... end
Sourcemodule TaskTimestamp : sig ... end
Sourcemodule RunGroupArn : sig ... end
Sourcemodule RunGroupId : sig ... end
Sourcemodule RunGroupName : sig ... end
Sourcemodule RunGroupTimestamp : sig ... end
Sourcemodule CacheBehavior : sig ... end
Sourcemodule RunCacheArn : sig ... end
Sourcemodule RunCacheId : sig ... end
Sourcemodule RunCacheStatus : sig ... end
Sourcemodule RunCacheTimestamp : sig ... end
Sourcemodule UserCustomName : sig ... end
Sourcemodule Md5 : sig ... end
Sourcemodule ReferenceId : sig ... end
Sourcemodule ReferenceStatus : sig ... end
Sourcemodule ReferenceStoreId : sig ... end
Sourcemodule ReferenceStoreArn : sig ... end
Sourcemodule ReferenceStoreDescription : sig ... end
Sourcemodule ReferenceStoreName : sig ... end
Sourcemodule ImportJobId : sig ... end
Sourcemodule ReferenceImportJobStatus : sig ... end
Sourcemodule RoleArn : sig ... end
Sourcemodule CreationType : sig ... end
Sourcemodule ETag : sig ... end

The entity tag (ETag) is a hash of the object representing its semantic content.

Sourcemodule ReadSetArn : sig ... end
Sourcemodule ReadSetStatus : sig ... end
Sourcemodule ReadSetStatusMessage : sig ... end
Sourcemodule SequenceInformation : sig ... end

Details about a sequence.

Sourcemodule ReadSetPartSource : sig ... end
Sourcemodule ReadSetImportJobStatus : sig ... end
Sourcemodule ExportJobId : sig ... end
Sourcemodule ReadSetExportJobStatus : sig ... end
Sourcemodule S3Destination : sig ... end
Sourcemodule ActivationJobId : sig ... end
Sourcemodule UploadId : sig ... end
Sourcemodule ConfigurationArn : sig ... end
Sourcemodule ConfigurationDescription : sig ... end
Sourcemodule ConfigurationName : sig ... end
Sourcemodule ConfigurationStatus : sig ... end
Sourcemodule ConfigurationTimestamp : sig ... end
Sourcemodule BatchName : sig ... end
Sourcemodule BatchStatus : sig ... end
Sourcemodule BatchTimestamp : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule StoreFormat : sig ... end
Sourcemodule StoreName : sig ... end
Sourcemodule VersionName : sig ... end
Sourcemodule VersionStatus : sig ... end
Sourcemodule ImageMapping : sig ... end

Specifies image mappings that workflow tasks can use. For example, you can replace all the task references of a public image to use an equivalent image in your private ECR repository. You can use image mappings with upstream registries that don't support pull through cache. You need to manually synchronize the upstream registry with your private repository.

Sourcemodule RegistryMapping : sig ... end

If you are using the ECR pull through cache feature, the registry mapping maps between the ECR repository and the upstream registry where container images are pulled and synchronized.

Sourcemodule SourceReferenceType : sig ... end
Sourcemodule SourceReferenceValue : sig ... end
Sourcemodule JobStatusMsg : sig ... end
Sourcemodule ReadSetS3Access : sig ... end

The S3 URI for each read set file.

Sourcemodule JobStatusMessage : sig ... end
Sourcemodule SecurityGroupIds : sig ... end
Sourcemodule SubnetIds : sig ... end
Sourcemodule VpcId : sig ... end
Sourcemodule VpcConfigSubnetIdsList : sig ... end
Sourcemodule AccessLogLocation : sig ... end
Sourcemodule S3AccessPointArn : sig ... end
Sourcemodule TsvStoreOptions : sig ... end

File settings for a TSV store.

Sourcemodule VariantImportItemSource : sig ... end

A imported variant item's source.

Sourcemodule ConfigurationUuid : sig ... end
Sourcemodule InlineSettings : sig ... end
Sourcemodule S3UriSettings : sig ... end
Sourcemodule NetworkingMode : sig ... end
Sourcemodule NumericIdInArn : sig ... end
Sourcemodule RunLogLevel : sig ... end
Sourcemodule RunRetentionMode : sig ... end
Sourcemodule RunRoleArn : sig ... end
Sourcemodule WorkflowOwnerId : sig ... end

A source for a reference import job.

A source for a read set import job.

Sourcemodule ExportReadSet : sig ... end

A read set.

A source for a read set activation job.

A source for an annotation import job.

Sourcemodule TsvOptions : sig ... end

Formatting options for a TSV file.

Sourcemodule VcfOptions : sig ... end

Formatting options for a VCF file.

Sourcemodule WorkflowListItem : sig ... end

A workflow.

Sourcemodule WorkflowVersionListItem : sig ... end

A list of workflow version items.

Sourcemodule VariantStoreItem : sig ... end

A variant store.

Sourcemodule ResourceIdentifier : sig ... end
Sourcemodule VariantImportJobItem : sig ... end

A variant import job.

Sourcemodule ShareDetails : sig ... end

The details of a resource share.

Sourcemodule ArnList : sig ... end
Sourcemodule StatusList : sig ... end
Sourcemodule TypeList : sig ... end
Sourcemodule SequenceStoreDetail : sig ... end

Details about a sequence store.

Sourcemodule RunListItem : sig ... end

A workflow run.

Sourcemodule RunBatchListItem : sig ... end

A single run entry returned by ListRunsInBatch.

Sourcemodule TaskListItem : sig ... end

A workflow run task.

Sourcemodule RunGroupListItem : sig ... end

A run group.

Sourcemodule RunCacheListItem : sig ... end

List entry for one run cache.

Sourcemodule ReferenceListItem : sig ... end

A genome reference.

Sourcemodule ReferenceStoreDetail : sig ... end

Details about a reference store.

Sourcemodule ImportReferenceJobItem : sig ... end

An import reference job.

Sourcemodule ReadSetListItem : sig ... end

A read set.

Sourcemodule ReferenceArnFilter : sig ... end
Sourcemodule ReadSetUploadPartListItem : sig ... end

The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API.

Sourcemodule ImportReadSetJobItem : sig ... end

An import read set job.

Sourcemodule ExportReadSetJobDetail : sig ... end

Details about a read set export job.

Sourcemodule ActivateReadSetJobItem : sig ... end

A read set activation job.

Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.

Sourcemodule ConfigurationListItem : sig ... end

Configuration list item with summary information.

Sourcemodule BatchListItem : sig ... end

A summary of a batch returned by ListBatch.

Sourcemodule AnnotationStoreItem : sig ... end

An annotation store.

Annotation store versions.

Sourcemodule AnnotationImportJobItem : sig ... end

An annotation import job.

Sourcemodule ImageMappingsList : sig ... end
Sourcemodule RegistryMappingsList : sig ... end
Sourcemodule ConnectionArn : sig ... end
Sourcemodule FullRepositoryId : sig ... end
Sourcemodule SourceReference : sig ... end

Contains information about the source reference in a code repository, such as a branch, tag, or commit.

Sourcemodule WorkflowParameter : sig ... end

A workflow parameter.

Sourcemodule WorkflowParameterName : sig ... end
Sourcemodule WorkflowExport : sig ... end
Sourcemodule VariantImportItemDetail : sig ... end

Details about an imported variant item.

Sourcemodule TaskImageDigest : sig ... end
Sourcemodule EngineLogStream : sig ... end
Sourcemodule RunLogStream : sig ... end
Sourcemodule RunResourceDigest : sig ... end
Sourcemodule RunResourceDigestKey : sig ... end
Sourcemodule RunExport : sig ... end
Sourcemodule FileInformation : sig ... end

Details about a file.

Sourcemodule ImportReferenceSourceItem : sig ... end

An genome reference source.

Sourcemodule ImportReadSetSourceItem : sig ... end

A source for an import read set job.

Sourcemodule ExportReadSetDetail : sig ... end

Details about a read set.

Sourcemodule ActivateReadSetSourceItem : sig ... end

A source for a read set activation job.

Sourcemodule VpcConfigResponse : sig ... end

VPC configuration for workflow runs with computed VPC ID.

Sourcemodule TsvVersionOptions : sig ... end

The options for a TSV file.

Details about an imported annotation item.

Sourcemodule VersionDeleteError : sig ... end

The error preventing deletion of the annotation store version.

Sourcemodule ExcludeFilePatternList : sig ... end
Sourcemodule VpcConfig : sig ... end

VPC configuration for workflow runs.

Part of the response to the CompleteReadSetUpload API, including metadata.

Sourcemodule ReadSetBatchError : sig ... end

An error from a batch read set operation.

Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule InternalServerException : sig ... end

An unexpected error occurred. Try the request again.

The operation is not supported by Amazon Omics, or the API does not exist.

Sourcemodule RequestTimeoutException : sig ... end

The request timed out.

Sourcemodule ResourceNotFoundException : sig ... end

The target resource was not found in the current Region.

The request exceeds a service quota.

Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

The input fails to satisfy the constraints specified by an AWS service.

Sourcemodule ReadSetPartStreamingBlob : sig ... end
Sourcemodule ReadmeMarkdown : sig ... end
Sourcemodule WorkflowDescription : sig ... end
Sourcemodule ConflictException : sig ... end

The request cannot be applied to the target resource in its current state.

Sourcemodule PropagatedSetLevelTags : sig ... end
Sourcemodule SequenceStoreS3Access : sig ... end

The S3 access metadata of the sequence store.

Sourcemodule ClientToken : sig ... end
Sourcemodule S3AccessConfig : sig ... end

S3 access configuration parameters.

Sourcemodule UserCustomDescription : sig ... end
Sourcemodule StoreOptions : sig ... end

Settings for a store.

Sourcemodule TagArn : sig ... end
Sourcemodule TagKeyList : sig ... end
Sourcemodule TagResourceRequestTagsMap : sig ... end
Sourcemodule VariantImportItemSources : sig ... end
Sourcemodule ConfigurationDetails : sig ... end

Minimal details for a configuration resource.

Sourcemodule RunRequestId : sig ... end
Sourcemodule BatchArn : sig ... end
Sourcemodule BatchUuid : sig ... end
Sourcemodule BatchRequestId : sig ... end
Sourcemodule BatchRunSettings : sig ... end

A union type representing per-run configurations for the batch. Specify exactly one of the following members.

Sourcemodule DefaultRunSetting : sig ... end

Shared configuration applied to all runs in a batch. Fields specified in a per-run InlineSetting entry override the corresponding fields in this object for that run. The parameters and runTags fields are merged rather than replaced — run-specific values take precedence when keys overlap.

Sourcemodule FormatOptions : sig ... end

Formatting options for a file.

Sourcemodule StoreId : sig ... end
Sourcemodule StoreType : sig ... end
Sourcemodule S3AccessPolicy : sig ... end
Sourcemodule WorkflowList : sig ... end
Sourcemodule WorkflowListToken : sig ... end
Sourcemodule WorkflowVersionList : sig ... end
Sourcemodule WorkflowVersionListToken : sig ... end
Sourcemodule VariantStoreItems : sig ... end
Sourcemodule ListVariantStoresFilter : sig ... end

A filter for variant stores.

Sourcemodule VariantImportJobItems : sig ... end

A filter for variant import jobs.

Sourcemodule ShareDetailsList : sig ... end
Sourcemodule Filter : sig ... end

Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status.

Sourcemodule ResourceOwner : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule SequenceStoreDetailList : sig ... end
Sourcemodule SequenceStoreFilter : sig ... end

A filter for a sequence store.

Sourcemodule RunList : sig ... end
Sourcemodule RunListToken : sig ... end
Sourcemodule ListToken : sig ... end
Sourcemodule RunBatchList : sig ... end
Sourcemodule TaskList : sig ... end
Sourcemodule TaskListToken : sig ... end
Sourcemodule RunGroupList : sig ... end
Sourcemodule RunGroupListToken : sig ... end
Sourcemodule RunCacheList : sig ... end
Sourcemodule ReferenceList : sig ... end
Sourcemodule ReferenceFilter : sig ... end

A filter for references.

Sourcemodule ReferenceStoreDetailList : sig ... end
Sourcemodule ReferenceStoreFilter : sig ... end

A filter for reference stores.

Sourcemodule ImportReferenceJobList : sig ... end
Sourcemodule ImportReferenceFilter : sig ... end

A filter for import references.

Sourcemodule ReadSetList : sig ... end
Sourcemodule ReadSetFilter : sig ... end

A filter for read sets.

Sourcemodule ReadSetUploadPartList : sig ... end

Filter settings that select for read set upload parts of interest.

Sourcemodule ImportReadSetJobList : sig ... end
Sourcemodule ImportReadSetFilter : sig ... end

A filter for import read set jobs.

Sourcemodule ExportReadSetFilter : sig ... end

An read set export job filter.

Sourcemodule ActivateReadSetJobList : sig ... end
Sourcemodule ActivateReadSetFilter : sig ... end

A read set activation job filter.

Sourcemodule ConfigurationList : sig ... end
Sourcemodule ConfigurationListToken : sig ... end
Sourcemodule BatchList : sig ... end
Sourcemodule AnnotationStoreItems : sig ... end

A filter for annotation stores.

Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.

Sourcemodule AnnotationImportJobItems : sig ... end

A filter for annotation import jobs.

Sourcemodule Accelerators : sig ... end
Sourcemodule ContainerRegistryMap : sig ... end

Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.

Contains detailed information about the source code repository that hosts the workflow definition files.

Sourcemodule ReadmePath : sig ... end
Sourcemodule ReadmeS3PresignedUrl : sig ... end
Sourcemodule WorkflowBucketOwnerId : sig ... end
Sourcemodule WorkflowDefinition : sig ... end
Sourcemodule WorkflowEngine : sig ... end
Sourcemodule WorkflowMain : sig ... end
Sourcemodule WorkflowParameterTemplate : sig ... end
Sourcemodule WorkflowStatusMessage : sig ... end
Sourcemodule WorkflowUuid : sig ... end
Sourcemodule WorkflowExportList : sig ... end
Sourcemodule VariantImportItemDetails : sig ... end
Sourcemodule ImageDetails : sig ... end

Information about the container image used for a task.

Sourcemodule TaskFailureReason : sig ... end
Sourcemodule TaskLogStream : sig ... end
Sourcemodule TaskStatusMessage : sig ... end
Sourcemodule EngineVersion : sig ... end
Sourcemodule RunFailureReason : sig ... end
Sourcemodule RunLogLocation : sig ... end

The URI for the run log.

Sourcemodule RunResourceDigests : sig ... end
Sourcemodule RunStartedBy : sig ... end
Sourcemodule RunStatusMessage : sig ... end
Sourcemodule RunExportList : sig ... end

The ranges specified in the request are not valid.

Sourcemodule ReferenceStreamingBlob : sig ... end
Sourcemodule Range : sig ... end
Sourcemodule ReferenceFile : sig ... end
Sourcemodule CreationJobId : sig ... end
Sourcemodule ReferenceCreationType : sig ... end
Sourcemodule ReferenceFiles : sig ... end

A set of genome reference files.

Sourcemodule ImportReferenceSourceList : sig ... end
Sourcemodule ReadSetStreamingBlob : sig ... end
Sourcemodule ReadSetFile : sig ... end
Sourcemodule ReadSetFiles : sig ... end

Files in a read set.

Sourcemodule ImportReadSetSourceList : sig ... end
Sourcemodule ExportReadSetDetailList : sig ... end
Sourcemodule ActivateReadSetSourceList : sig ... end
Sourcemodule RunConfigurationsResponse : sig ... end

Run-specific configuration settings with computed values.

Sourcemodule RunSummary : sig ... end

A summary of the runs in a batch.

Sourcemodule SubmissionSummary : sig ... end

A summary of the submissions in a batch.

Sourcemodule VersionOptions : sig ... end

The options for an annotation store version.

Sourcemodule PrimitiveBoolean : sig ... end
Sourcemodule VersionDeleteErrorList : sig ... end
Sourcemodule VersionList : sig ... end
Sourcemodule Blob : sig ... end
Sourcemodule DefinitionRepository : sig ... end

Contains information about a source code repository that hosts the workflow definition files.

Sourcemodule ParameterTemplatePath : sig ... end
Sourcemodule S3UriForObject : sig ... end
Sourcemodule WorkflowRequestId : sig ... end
Sourcemodule RunGroupRequestId : sig ... end
Sourcemodule RunCacheRequestId : sig ... end
Sourcemodule ConfigurationRequestId : sig ... end
Sourcemodule RunConfigurations : sig ... end

Run-specific configuration settings.

Sourcemodule ReadSetBatchErrorList : sig ... end
Sourcemodule ReadSetIdList : sig ... end
Sourcemodule UploadReadSetPartResponse : sig ... end

Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload. For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

Sourcemodule UploadReadSetPartRequest : sig ... end

Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload. For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Sourcemodule UpdateWorkflowRequest : sig ... end

Updates information about a workflow. You can update the following workflow information: Name Description Default storage type Default storage capacity (with workflow ID) This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the GetWorkflow API operation. For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Updates a variant store.

Sourcemodule UpdateVariantStoreRequest : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Updates a variant store.

Update one or more parameters for the sequence store.

Update one or more parameters for the sequence store.

Sourcemodule UpdateRunGroupRequest : sig ... end

Updates the settings of a run group and returns a response with no body if the operation is successful. You can update the following settings with UpdateRunGroup: Maximum number of CPUs Run time (measured in minutes) Number of GPUs Number of concurrent runs Group name To confirm that the settings have been successfully updated, use the ListRunGroups or GetRunGroup API operations to verify that the desired changes have been made.

Sourcemodule UpdateRunCacheRequest : sig ... end

Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with CACHE_ON_FAILURE or CACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use the GetRunCache API operation. For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.

Updates the description of an annotation store version.

Updates the description of an annotation store version.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Updates an annotation store.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Updates an annotation store.

Sourcemodule UntagResourceResponse : sig ... end

Removes tags from a resource.

Sourcemodule UntagResourceRequest : sig ... end

Removes tags from a resource.

Sourcemodule TagResourceResponse : sig ... end

Tags a resource.

Sourcemodule TagResourceRequest : sig ... end

Tags a resource.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Starts a variant import job.

Sourcemodule StartVariantImportRequest : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Starts a variant import job.

Sourcemodule StartRunResponse : sig ... end

Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation. To start a new run, the following inputs are required: A service role ARN (roleArn). The run's workflow ID (workflowId, not the uuid or runId). An Amazon S3 location (outputUri) where the run outputs will be saved. All required workflow parameters (parameter), which can include optional parameters from the parameter template. The run cannot include any parameters that are not defined in the parameter template. To see all possible parameters, use the GetRun API operation. For runs with a STATIC (default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that use DYNAMIC storage. StartRun can also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required: A service role ARN (roleArn). The ID of the run to duplicate (runId). An Amazon S3 location where the run outputs will be saved (outputUri). To learn more about the optional parameters for StartRun, see Starting a run in the Amazon Web Services HealthOmics User Guide. Use the retentionMode input to control how long the metadata for each run is stored in CloudWatch. There are two retention modes: Specify REMOVE to automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use the REMOVE mode to initiate major run requests so that your runs do not fail when you reach the limit. The retentionMode is set to the RETAIN mode by default, which allows you to manually remove runs after reaching the maximum service retention limit. Under this setting, you cannot create additional runs until you remove the excess runs. To learn more about the retention modes, see Run retention mode in the Amazon Web Services HealthOmics User Guide. You can use Amazon Q CLI to analyze run logs and make performance optimization recommendations. To get started, see the Amazon Web Services HealthOmics MCP server on GitHub.

Sourcemodule StartRunRequest : sig ... end

Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation. To start a new run, the following inputs are required: A service role ARN (roleArn). The run's workflow ID (workflowId, not the uuid or runId). An Amazon S3 location (outputUri) where the run outputs will be saved. All required workflow parameters (parameter), which can include optional parameters from the parameter template. The run cannot include any parameters that are not defined in the parameter template. To see all possible parameters, use the GetRun API operation. For runs with a STATIC (default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that use DYNAMIC storage. StartRun can also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required: A service role ARN (roleArn). The ID of the run to duplicate (runId). An Amazon S3 location where the run outputs will be saved (outputUri). To learn more about the optional parameters for StartRun, see Starting a run in the Amazon Web Services HealthOmics User Guide. Use the retentionMode input to control how long the metadata for each run is stored in CloudWatch. There are two retention modes: Specify REMOVE to automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use the REMOVE mode to initiate major run requests so that your runs do not fail when you reach the limit. The retentionMode is set to the RETAIN mode by default, which allows you to manually remove runs after reaching the maximum service retention limit. Under this setting, you cannot create additional runs until you remove the excess runs. To learn more about the retention modes, see Run retention mode in the Amazon Web Services HealthOmics User Guide. You can use Amazon Q CLI to analyze run logs and make performance optimization recommendations. To get started, see the Amazon Web Services HealthOmics MCP server on GitHub.

Sourcemodule StartRunBatchResponse : sig ... end

Starts a batch of workflow runs. You can group up to 100,000 runs into a single batch that share a common configuration defined in defaultRunSetting. Per-run overrides can be provided either inline via inlineSettings (up to 100 runs) or via a JSON file stored in Amazon S3 via s3UriSettings (up to 100,000 runs). StartRunBatch validates common fields synchronously and returns immediately with a batch ID and status CREATING. The batch transitions to PENDING once initial setup completes. Runs are then submitted gradually and asynchronously at a rate governed by your StartRun throughput quota.

Sourcemodule StartRunBatchRequest : sig ... end

Starts a batch of workflow runs. You can group up to 100,000 runs into a single batch that share a common configuration defined in defaultRunSetting. Per-run overrides can be provided either inline via inlineSettings (up to 100 runs) or via a JSON file stored in Amazon S3 via s3UriSettings (up to 100,000 runs). StartRunBatch validates common fields synchronously and returns immediately with a batch ID and status CREATING. The batch transitions to PENDING once initial setup completes. Runs are then submitted gradually and asynchronously at a rate governed by your StartRun throughput quota.

Imports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import reference genomes one at a time into each reference store. Monitor the status of your reference import job by using the GetReferenceImportJob API operation.

Imports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import reference genomes one at a time into each reference store. Monitor the status of your reference import job by using the GetReferenceImportJob API operation.

Imports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set import job by calling the GetReadSetImportJob API operation.

Imports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set import job by calling the GetReadSetImportJob API operation.

Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the GetReadSetExportJob API operation. To monitor the status of the export job, use the ListReadSetExportJobs API operation.

Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the GetReadSetExportJob API operation. To monitor the status of the export job, use the ListReadSetExportJobs API operation.

Activates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the GetReadSetActivationJob operation. To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.

Activates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the GetReadSetActivationJob operation. To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Starts an annotation import job.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Starts an annotation import job.

Sourcemodule PutS3AccessPolicyResponse : sig ... end

Adds an access policy to the specified store.

Sourcemodule PutS3AccessPolicyRequest : sig ... end

Adds an access policy to the specified store.

Sourcemodule ListWorkflowsResponse : sig ... end

Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a list of private workflows or specify READY2RUN for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.

Sourcemodule ListWorkflowsRequest : sig ... end

Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a list of private workflows or specify READY2RUN for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Sourcemodule ListVariantStoresResponse : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of variant stores.

Sourcemodule ListVariantStoresRequest : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of variant stores.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of variant import jobs.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of variant import jobs.

Retrieves a list of tags for a resource.

Retrieves a list of tags for a resource.

Sourcemodule ListSharesResponse : sig ... end

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

Sourcemodule ListSharesRequest : sig ... end

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

Retrieves a list of sequence stores and returns each sequence store's metadata. For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

Sourcemodule ListSequenceStoresRequest : sig ... end

Retrieves a list of sequence stores and returns each sequence store's metadata. For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

Sourcemodule ListRunsResponse : sig ... end

Retrieves a list of runs and returns each run's metadata and status. Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

Sourcemodule ListRunsRequest : sig ... end

Retrieves a list of runs and returns each run's metadata and status. Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

Sourcemodule ListRunsInBatchResponse : sig ... end

Returns a paginated list of individual workflow runs within a specific batch. Use this operation to map each runSettingId to its HealthOmics-generated runId, and to check the submission status of each run. Only one filter per call is supported.

Sourcemodule ListRunsInBatchRequest : sig ... end

Returns a paginated list of individual workflow runs within a specific batch. Use this operation to map each runSettingId to its HealthOmics-generated runId, and to check the submission status of each run. Only one filter per call is supported.

Sourcemodule ListRunTasksResponse : sig ... end

Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.

Sourcemodule ListRunTasksRequest : sig ... end

Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.

Sourcemodule ListRunGroupsResponse : sig ... end

Retrieves a list of all run groups and returns the metadata for each run group.

Sourcemodule ListRunGroupsRequest : sig ... end

Retrieves a list of all run groups and returns the metadata for each run group.

Sourcemodule ListRunCachesResponse : sig ... end

Retrieves a list of your run caches and the metadata for each cache.

Sourcemodule ListRunCachesRequest : sig ... end

Retrieves a list of your run caches and the metadata for each cache.

Sourcemodule ListReferencesResponse : sig ... end

Retrieves the metadata of one or more reference genomes in a reference store. For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

Sourcemodule ListReferencesRequest : sig ... end

Retrieves the metadata of one or more reference genomes in a reference store. For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

Retrieves a list of reference stores linked to your account and returns their metadata in JSON format. For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

Retrieves a list of reference stores linked to your account and returns their metadata in JSON format. For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

Retrieves the metadata of one or more reference import jobs for a reference store.

Retrieves the metadata of one or more reference import jobs for a reference store.

Sourcemodule ListReadSetsResponse : sig ... end

Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.

Sourcemodule ListReadSetsRequest : sig ... end

Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.

Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.

Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.

Retrieves a list of read set import jobs and returns the data in JSON format.

Retrieves a list of read set import jobs and returns the data in JSON format.

Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the StartReadSetExportJob API operation.

Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the StartReadSetExportJob API operation.

Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the GetReadSetActivationJob API operation.

Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the GetReadSetActivationJob API operation.

Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the CreateMultipartReadSetUploads API operation. This operation returns a response with no body when the upload is complete.

Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the CreateMultipartReadSetUploads API operation. This operation returns a response with no body when the upload is complete.

List all configurations for the account.

Sourcemodule ListConfigurationsRequest : sig ... end

List all configurations for the account.

Sourcemodule ListBatchResponse : sig ... end

Returns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is supported.

Sourcemodule ListBatchRequest : sig ... end

Returns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is supported.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of annotation stores.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of annotation stores.

Lists the versions of an annotation store.

Lists the versions of an annotation store.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of annotation import jobs.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of annotation import jobs.

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetWorkflowVersionRequest : sig ... end

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetWorkflowResponse : sig ... end

Gets all information about a workflow using its ID. If a workflow is shared with you, you cannot export the workflow. For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetWorkflowRequest : sig ... end

Gets all information about a workflow using its ID. If a workflow is shared with you, you cannot export the workflow. For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetVariantStoreResponse : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about a variant store.

Sourcemodule GetVariantStoreRequest : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about a variant store.

Sourcemodule GetVariantImportResponse : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about a variant import job.

Sourcemodule GetVariantImportRequest : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about a variant import job.

Sourcemodule GetShareResponse : sig ... end

Retrieves the metadata for the specified resource share.

Sourcemodule GetShareRequest : sig ... end

Retrieves the metadata for the specified resource share.

Sourcemodule GetSequenceStoreResponse : sig ... end

Retrieves metadata for a sequence store using its ID and returns it in JSON format.

Sourcemodule GetSequenceStoreRequest : sig ... end

Retrieves metadata for a sequence store using its ID and returns it in JSON format.

Sourcemodule GetS3AccessPolicyResponse : sig ... end

Retrieves details about an access policy on a given store.

Sourcemodule GetS3AccessPolicyRequest : sig ... end

Retrieves details about an access policy on a given store.

Sourcemodule GetRunTaskResponse : sig ... end

Gets detailed information about a run task using its ID.

Sourcemodule GetRunTaskRequest : sig ... end

Gets detailed information about a run task using its ID.

Sourcemodule GetRunResponse : sig ... end

Gets detailed information about a specific run using its ID. Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If GetRun does not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetRunRequest : sig ... end

Gets detailed information about a specific run using its ID. Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If GetRun does not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetRunGroupResponse : sig ... end

Gets information about a run group and returns its metadata.

Sourcemodule GetRunGroupRequest : sig ... end

Gets information about a run group and returns its metadata.

Sourcemodule GetRunCacheResponse : sig ... end

Retrieves detailed information about the specified run cache using its ID. For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetRunCacheRequest : sig ... end

Retrieves detailed information about the specified run cache using its ID. For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetReferenceStoreResponse : sig ... end

Gets information about a reference store.

Sourcemodule GetReferenceStoreRequest : sig ... end

Gets information about a reference store.

Sourcemodule GetReferenceResponse : sig ... end

Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded. For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

Sourcemodule GetReferenceRequest : sig ... end

Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded. For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

Monitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob operation.

Monitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob operation.

Sourcemodule GetReadSetResponse : sig ... end

Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.

Sourcemodule GetReadSetRequest : sig ... end

Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.

Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

Sourcemodule GetReadSetMetadataRequest : sig ... end

Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

Gets detailed and status information about a read set import job and returns the data in JSON format.

Gets detailed and status information about a read set import job and returns the data in JSON format.

Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.

Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.

Returns detailed information about the status of a read set activation job in JSON format.

Returns detailed information about the status of a read set activation job in JSON format.

Sourcemodule GetConfigurationResponse : sig ... end

Retrieve configuration details for specified name.

Sourcemodule GetConfigurationRequest : sig ... end

Retrieve configuration details for specified name.

Sourcemodule GetBatchResponse : sig ... end

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

Sourcemodule GetBatchRequest : sig ... end

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

Retrieves the metadata for an annotation store version.

Retrieves the metadata for an annotation store version.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about an annotation store.

Sourcemodule GetAnnotationStoreRequest : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about an annotation store.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about an annotation import job.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about an annotation import job.

Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Sourcemodule DeleteWorkflowRequest : sig ... end

Deletes a workflow by specifying its ID. This operation returns a response with no body if the deletion is successful. To verify that the workflow is deleted: Use ListWorkflows to confirm the workflow no longer appears in the list. Use GetWorkflow to verify the workflow cannot be found.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Deletes a variant store.

Sourcemodule DeleteVariantStoreRequest : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Deletes a variant store.

Sourcemodule DeleteShareResponse : sig ... end

Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

Sourcemodule DeleteShareRequest : sig ... end

Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

Deletes a sequence store and returns a response with no body if the operation is successful. You can only delete a sequence store when it does not contain any read sets. Use the BatchDeleteReadSet API operation to ensure that all read sets in the sequence store are deleted. When a sequence store is deleted, all tags associated with the store are also deleted. For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

Deletes a sequence store and returns a response with no body if the operation is successful. You can only delete a sequence store when it does not contain any read sets. Use the BatchDeleteReadSet API operation to ensure that all read sets in the sequence store are deleted. When a sequence store is deleted, all tags associated with the store are also deleted. For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

Deletes an access policy for the specified store.

Deletes an access policy for the specified store.

Sourcemodule DeleteRunRequest : sig ... end

Deletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a COMPLETED, FAILED, or CANCELLED stage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch. To verify that the workflow is deleted: Use ListRuns to confirm the workflow no longer appears in the list. Use GetRun to verify the workflow cannot be found.

Sourcemodule DeleteRunGroupRequest : sig ... end

Deletes a run group and returns a response with no body if the operation is successful. To verify that the run group is deleted: Use ListRunGroups to confirm the workflow no longer appears in the list. Use GetRunGroup to verify the workflow cannot be found.

Sourcemodule DeleteRunCacheRequest : sig ... end

Deletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations. For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.

Sourcemodule DeleteRunBatchResponse : sig ... end

Deletes the individual workflow runs within a batch. This operation is separate from DeleteBatch, which removes the batch metadata. Delete is only allowed on batches in PROCESSED or CANCELLED state. Delete operations are non-atomic and may be partially successful. Use GetBatch to review successfulDeleteSubmissionCount and failedDeleteSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.

Sourcemodule DeleteRunBatchRequest : sig ... end

Deletes the individual workflow runs within a batch. This operation is separate from DeleteBatch, which removes the batch metadata. Delete is only allowed on batches in PROCESSED or CANCELLED state. Delete operations are non-atomic and may be partially successful. Use GetBatch to review successfulDeleteSubmissionCount and failedDeleteSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.

Deletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use DeleteReference. For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

Deletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use DeleteReference. For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

Sourcemodule DeleteReferenceResponse : sig ... end

Deletes a reference genome and returns a response with no body if the operation is successful. The read set associated with the reference genome must first be deleted before deleting the reference genome. After the reference genome is deleted, you can delete the reference store using the DeleteReferenceStore API operation. For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

Sourcemodule DeleteReferenceRequest : sig ... end

Deletes a reference genome and returns a response with no body if the operation is successful. The read set associated with the reference genome must first be deleted before deleting the reference genome. After the reference genome is deleted, you can delete the reference store using the DeleteReferenceStore API operation. For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

Delete an existing configuration.

Sourcemodule DeleteBatchRequest : sig ... end

Deletes a run batch resource and its associated metadata. This operation does not delete the individual workflow runs. To delete the runs, call DeleteRunBatch before calling DeleteBatch. DeleteBatch requires the batch to be in a terminal state: PROCESSED, FAILED, CANCELLED, or RUNS_DELETED. After DeleteBatch completes, the batch metadata is no longer accessible. You cannot call GetBatch, ListRunsInBatch, DeleteRunBatch, or CancelRunBatch on a deleted batch.

Deletes one or multiple versions of an annotation store.

Deletes one or multiple versions of an annotation store.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Deletes an annotation store.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Deletes an annotation store.

Creates a new workflow version for the workflow that you specify with the workflowId parameter. When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version. Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Creates a new workflow version for the workflow that you specify with the workflowId parameter. When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version. Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Sourcemodule CreateWorkflowResponse : sig ... end

Creates a private workflow. Before you create a private workflow, you must create and configure these required resources: Workflow definition file: A workflow definition file written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format. For more information, see Workflow definition files in Amazon Web Services HealthOmics. You can use Amazon Q CLI to build and validate your workflow definition files in WDL, Nextflow, and CWL. For more information, see Example prompts for Amazon Q CLI and the Amazon Web Services HealthOmics Agentic generative AI tutorial on GitHub. (Optional) Parameter template file: A parameter template file written in JSON. Create the file to define the run parameters, or Amazon Web Services HealthOmics generates the parameter template for you. For more information, see Parameter template files for HealthOmics workflows. ECR container images: Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository. (Optional) Sentieon licenses: Request a Sentieon license to use the Sentieon software in private workflows. For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Sourcemodule CreateWorkflowRequest : sig ... end

Creates a private workflow. Before you create a private workflow, you must create and configure these required resources: Workflow definition file: A workflow definition file written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format. For more information, see Workflow definition files in Amazon Web Services HealthOmics. You can use Amazon Q CLI to build and validate your workflow definition files in WDL, Nextflow, and CWL. For more information, see Example prompts for Amazon Q CLI and the Amazon Web Services HealthOmics Agentic generative AI tutorial on GitHub. (Optional) Parameter template file: A parameter template file written in JSON. Create the file to define the run parameters, or Amazon Web Services HealthOmics generates the parameter template for you. For more information, see Parameter template files for HealthOmics workflows. ECR container images: Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository. (Optional) Sentieon licenses: Request a Sentieon license to use the Sentieon software in private workflows. For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Creates a variant store.

Sourcemodule CreateVariantStoreRequest : sig ... end

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Creates a variant store.

Sourcemodule CreateShareResponse : sig ... end

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner). The following resources support cross-account sharing: HealthOmics variant stores HealthOmics annotation stores Private workflows

Sourcemodule CreateShareRequest : sig ... end

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner). The following resources support cross-account sharing: HealthOmics variant stores HealthOmics annotation stores Private workflows

Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required. You can create multiple sequence stores per region per account. The following are optional parameters you can specify for your sequence store: Use s3AccessConfig to configure your sequence store with S3 access logs (recommended). Use sseConfig to define your own KMS key for encryption. Use eTagAlgorithmFamily to define which algorithm to use for the HealthOmics eTag on objects. Use fallbackLocation to define a backup location for storing files that have failed a direct upload. Use propagatedSetLevelTags to configure tags that propagate to all objects in your store. For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required. You can create multiple sequence stores per region per account. The following are optional parameters you can specify for your sequence store: Use s3AccessConfig to configure your sequence store with S3 access logs (recommended). Use sseConfig to define your own KMS key for encryption. Use eTagAlgorithmFamily to define which algorithm to use for the HealthOmics eTag on objects. Use fallbackLocation to define a backup location for storing files that have failed a direct upload. Use propagatedSetLevelTags to configure tags that propagate to all objects in your store. For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

Sourcemodule CreateRunGroupResponse : sig ... end

Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.

Sourcemodule CreateRunGroupRequest : sig ... end

Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.

Sourcemodule CreateRunCacheResponse : sig ... end

Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file. For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.

Sourcemodule CreateRunCacheRequest : sig ... end

Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file. For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.

Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation. For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation. For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

Initiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the split operation. Each part cannot be larger than 100 MB. If the operation is successful, it provides an uploadId which is required by the UploadReadSetPart API operation to upload parts into a sequence store. To continue uploading a multipart read set into your sequence store, you must use the UploadReadSetPart API operation to upload each part individually following the steps below: Specify the uploadId obtained from the previous call to CreateMultipartReadSetUpload. Upload parts for that uploadId. When you have finished uploading parts, use the CompleteMultipartReadSetUpload API to complete the multipart read set upload and to retrieve the final read set IDs in the response. To learn more about creating parts and the split operation, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

Initiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the split operation. Each part cannot be larger than 100 MB. If the operation is successful, it provides an uploadId which is required by the UploadReadSetPart API operation to upload parts into a sequence store. To continue uploading a multipart read set into your sequence store, you must use the UploadReadSetPart API operation to upload each part individually following the steps below: Specify the uploadId obtained from the previous call to CreateMultipartReadSetUpload. Upload parts for that uploadId. When you have finished uploading parts, use the CompleteMultipartReadSetUpload API to complete the multipart read set upload and to retrieve the final read set IDs in the response. To learn more about creating parts and the split operation, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

Create a new configuration.

Create a new configuration.

Creates a new version of an annotation store.

Creates a new version of an annotation store.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Creates an annotation store.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Creates an annotation store.

Completes a multipart read set upload into a sequence store after you have initiated the upload process with CreateMultipartReadSetUpload and uploaded all read set parts using UploadReadSetPart. You must specify the parts you uploaded using the parts parameter. If the operation is successful, it returns the read set ID(s) of the uploaded read set(s). For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

Completes a multipart read set upload into a sequence store after you have initiated the upload process with CreateMultipartReadSetUpload and uploaded all read set parts using UploadReadSetPart. You must specify the parts you uploaded using the parts parameter. If the operation is successful, it returns the read set ID(s) of the uploaded read set(s). For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Cancels a variant import job.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Cancels a variant import job.

Sourcemodule CancelRunRequest : sig ... end

Cancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the ListRuns API operation to check that it is no longer listed.

Sourcemodule CancelRunBatchResponse : sig ... end

Cancels all runs within a specified batch. This operation prevents not-yet-submitted runs from starting and submits CancelRun requests for runs that have already started. Cancel is only allowed on batches in PENDING, SUBMITTING, or INPROGRESS state. Cancel operations are non-atomic and may be partially successful. Use GetBatch to review successfulCancelSubmissionCount and failedCancelSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.

Sourcemodule CancelRunBatchRequest : sig ... end

Cancels all runs within a specified batch. This operation prevents not-yet-submitted runs from starting and submits CancelRun requests for runs that have already started. Cancel is only allowed on batches in PENDING, SUBMITTING, or INPROGRESS state. Cancel operations are non-atomic and may be partially successful. Use GetBatch to review successfulCancelSubmissionCount and failedCancelSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Cancels an annotation import job.

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Cancels an annotation import job.

Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each BatchDeleteReadSet API call.

Sourcemodule BatchDeleteReadSetRequest : sig ... end

Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each BatchDeleteReadSet API call.

Sourcemodule AcceptShareResponse : sig ... end

Accept a resource share request.

Sourcemodule AcceptShareRequest : sig ... end

Accept a resource share request.

Stops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful. To confirm that a multipart read set upload has been stopped, use the ListMultipartReadSetUploads API operation to view all active multipart read set uploads.

Stops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful. To confirm that a multipart read set upload has been stopped, use the ListMultipartReadSetUploads API operation to view all active multipart read set uploads.