Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate insights from genomics and other biological data. It simplifies and accelerates the process of storing and analyzing genomic information for Amazon Web Services.
For an introduction to the service, see What is Amazon Web Services HealthOmics? in the Amazon Web Services HealthOmics User Guide.
", "operations": { "AbortMultipartReadSetUpload": "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.
Accept a resource share request.
", "BatchDeleteReadSet": "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.
Cancels an annotation import job.
", "CancelRun": "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.
Cancels a variant import job.
", "CompleteMultipartReadSetUpload": "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.
", "CreateAnnotationStore": "Creates an annotation store.
", "CreateAnnotationStoreVersion": "Creates a new version of an annotation store.
", "CreateMultipartReadSetUpload": "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.
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.
", "CreateRunCache": "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.
", "CreateRunGroup": "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.
", "CreateSequenceStore": "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.
", "CreateShare": "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 variant store.
", "CreateWorkflow": "Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:
Workflow definition files: Define your workflow in one or more workflow definition files, 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.
(Optional) Parameter template: You can create a parameter template file that defines the run parameters, or Amazon Web Services HealthOmics can generate the parameter template for you.
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 if using the Sentieon software in a private workflow.
For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
", "CreateWorkflowVersion": "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.
", "DeleteAnnotationStore": "Deletes an annotation store.
", "DeleteAnnotationStoreVersions": "Deletes one or multiple versions of an annotation store.
", "DeleteReference": "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.
", "DeleteReferenceStore": "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.
", "DeleteRun": "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.
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.
", "DeleteRunGroup": "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.
Deletes an access policy for the specified store.
", "DeleteSequenceStore": "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.
", "DeleteShare": "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.
", "DeleteVariantStore": "Deletes a variant store.
", "DeleteWorkflow": "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.
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.
", "GetAnnotationImportJob": "Gets information about an annotation import job.
", "GetAnnotationStore": "Gets information about an annotation store.
", "GetAnnotationStoreVersion": "Retrieves the metadata for an annotation store version.
", "GetReadSet": "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.
", "GetReadSetActivationJob": "Returns detailed information about the status of a read set activation job in JSON format.
", "GetReadSetExportJob": "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.
", "GetReadSetImportJob": "Gets detailed and status information about a read set import job and returns the data in JSON format.
", "GetReadSetMetadata": "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.
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.
", "GetReferenceImportJob": "Monitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob 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.
Gets information about a reference store.
", "GetRun": "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.
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.
", "GetRunGroup": "Gets information about a run group and returns its metadata.
", "GetRunTask": "Gets detailed information about a run task using its ID.
", "GetS3AccessPolicy": "Retrieves details about an access policy on a given store.
", "GetSequenceStore": "Retrieves metadata for a sequence store using its ID and returns it in JSON format.
", "GetShare": "Retrieves the metadata for the specified resource share.
", "GetVariantImportJob": "Gets information about a variant import job.
", "GetVariantStore": "Gets information about a variant store.
", "GetWorkflow": "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.
", "GetWorkflowVersion": "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.
", "ListAnnotationImportJobs": "Retrieves a list of annotation import jobs.
", "ListAnnotationStoreVersions": "Lists the versions of an annotation store.
", "ListAnnotationStores": "Retrieves a list of annotation stores.
", "ListMultipartReadSetUploads": "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.
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 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 import jobs and returns the data in JSON format.
", "ListReadSetUploadParts": "Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.
", "ListReadSets": "Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.
", "ListReferenceImportJobs": "Retrieves the metadata of one or more reference import jobs for a reference store.
", "ListReferenceStores": "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.
", "ListReferences": "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.
", "ListRunCaches": "Retrieves a list of your run caches and the metadata for each cache.
", "ListRunGroups": "Retrieves a list of all run groups and returns the metadata for each run group.
", "ListRunTasks": "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.
", "ListRuns": "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.
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.
", "ListShares": "Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.
", "ListTagsForResource": "Retrieves a list of tags for a resource.
", "ListVariantImportJobs": "Retrieves a list of variant import jobs.
", "ListVariantStores": "Retrieves a list of variant stores.
", "ListWorkflowVersions": "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.
", "ListWorkflows": "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.
Adds an access policy to the specified store.
", "StartAnnotationImportJob": "Starts an annotation import job.
", "StartReadSetActivationJob": "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.
", "StartReadSetExportJob": "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.
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 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.
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.
", "StartVariantImportJob": "Starts a variant import job.
", "TagResource": "Tags a resource.
", "UntagResource": "Removes tags from a resource.
", "UpdateAnnotationStore": "Updates an annotation store.
", "UpdateAnnotationStoreVersion": "Updates the description of an annotation store version.
", "UpdateRunCache": "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.
", "UpdateRunGroup": "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.
Update one or more parameters for the sequence store.
", "UpdateVariantStore": "Updates a variant store.
", "UpdateWorkflow": "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.
", "UpdateWorkflowVersion": "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.
", "UploadReadSetPart": "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.
" }, "shapes": { "AbortMultipartReadSetUploadRequest": { "base": null, "refs": { } }, "AbortMultipartReadSetUploadResponse": { "base": null, "refs": { } }, "Accelerators": { "base": null, "refs": { "CreateWorkflowRequest$accelerators": "The computational accelerator specified to run the workflow.
", "CreateWorkflowVersionRequest$accelerators": "The computational accelerator for this workflow version.
", "GetRunResponse$accelerators": "The computational accelerator used to run the workflow.
", "GetWorkflowResponse$accelerators": "The computational accelerator specified to run the workflow.
", "GetWorkflowVersionResponse$accelerators": "The accelerator for this workflow version.
" } }, "AcceptShareRequest": { "base": null, "refs": { } }, "AcceptShareResponse": { "base": null, "refs": { } }, "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { } }, "AccessLogLocation": { "base": null, "refs": { "S3AccessConfig$accessLogLocation": "Location of the access logs.
", "SequenceStoreS3Access$accessLogLocation": "Location of the access logs.
" } }, "ActivateReadSetFilter": { "base": "A read set activation job filter.
", "refs": { "ListReadSetActivationJobsRequest$filter": "A filter to apply to the list.
" } }, "ActivateReadSetJobItem": { "base": "A read set activation job.
", "refs": { "ActivateReadSetJobList$member": null } }, "ActivateReadSetJobList": { "base": null, "refs": { "ListReadSetActivationJobsResponse$activationJobs": "A list of jobs.
" } }, "ActivateReadSetSourceItem": { "base": "A source for a read set activation job.
", "refs": { "ActivateReadSetSourceList$member": null } }, "ActivateReadSetSourceList": { "base": null, "refs": { "GetReadSetActivationJobResponse$sources": "The job's source files.
" } }, "ActivationJobId": { "base": null, "refs": { "ActivateReadSetJobItem$id": "The job's ID.
", "GetReadSetActivationJobRequest$id": "The job's ID.
", "GetReadSetActivationJobResponse$id": "The job's ID.
", "StartReadSetActivationJobResponse$id": "The job's ID.
" } }, "AnnotationFieldMap": { "base": null, "refs": { "AnnotationImportJobItem$annotationFields": "The annotation schema generated by the parsed annotation data.
", "GetAnnotationImportResponse$annotationFields": "The annotation schema generated by the parsed annotation data.
", "GetVariantImportResponse$annotationFields": "The annotation schema generated by the parsed annotation data.
", "StartAnnotationImportRequest$annotationFields": "The annotation schema generated by the parsed annotation data.
", "StartVariantImportRequest$annotationFields": "The annotation schema generated by the parsed annotation data.
", "VariantImportJobItem$annotationFields": "The annotation schema generated by the parsed annotation data.
" } }, "AnnotationFieldMapKeyString": { "base": null, "refs": { "AnnotationFieldMap$key": null } }, "AnnotationFieldMapValueString": { "base": null, "refs": { "AnnotationFieldMap$value": null } }, "AnnotationImportItemDetail": { "base": "Details about an imported annotation item.
", "refs": { "AnnotationImportItemDetails$member": null } }, "AnnotationImportItemDetails": { "base": null, "refs": { "GetAnnotationImportResponse$items": "The job's imported items.
" } }, "AnnotationImportItemSource": { "base": "A source for an annotation import job.
", "refs": { "AnnotationImportItemSources$member": null } }, "AnnotationImportItemSources": { "base": null, "refs": { "StartAnnotationImportRequest$items": "Items to import.
" } }, "AnnotationImportJobItem": { "base": "An annotation import job.
", "refs": { "AnnotationImportJobItems$member": null } }, "AnnotationImportJobItems": { "base": null, "refs": { "ListAnnotationImportJobsResponse$annotationImportJobs": "A list of jobs.
" } }, "AnnotationStoreItem": { "base": "An annotation store.
", "refs": { "AnnotationStoreItems$member": null } }, "AnnotationStoreItems": { "base": null, "refs": { "ListAnnotationStoresResponse$annotationStores": "A list of stores.
" } }, "AnnotationStoreVersionItem": { "base": "Annotation store versions.
", "refs": { "AnnotationStoreVersionItems$member": null } }, "AnnotationStoreVersionItems": { "base": null, "refs": { "ListAnnotationStoreVersionsResponse$annotationStoreVersions": "Lists all versions of an annotation store.
" } }, "AnnotationType": { "base": null, "refs": { "TsvStoreOptions$annotationType": "The store's annotation type.
", "TsvVersionOptions$annotationType": "The store version's annotation type.
" } }, "Arn": { "base": null, "refs": { "AnnotationImportJobItem$roleArn": "The job's service role ARN.
", "AnnotationStoreItem$storeArn": "The store's ARN.
", "AnnotationStoreVersionItem$versionArn": "The Arn for an annotation store version.
", "GetAnnotationImportResponse$roleArn": "The job's service role ARN.
", "GetAnnotationStoreResponse$storeArn": "The store's ARN.
", "GetAnnotationStoreVersionResponse$versionArn": "The Arn for the annotation store.
", "GetVariantImportResponse$roleArn": "The job's service role ARN.
", "GetVariantStoreResponse$storeArn": "The store's ARN.
", "StartAnnotationImportRequest$roleArn": "A service role for the job.
", "StartVariantImportRequest$roleArn": "A service role for the job.
", "VariantImportJobItem$roleArn": "The job's service role ARN.
", "VariantStoreItem$storeArn": "The store's ARN.
" } }, "ArnList": { "base": null, "refs": { "Filter$resourceArns": "Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.
" } }, "AwsAccountId": { "base": null, "refs": { "CreateRunCacheRequest$cacheBucketOwnerId": "The Amazon Web Services account ID of the expected owner of the S3 bucket for the run cache. If not provided, your account ID is set as the owner of the bucket.
", "GetRunCacheResponse$cacheBucketOwnerId": "The identifier of the bucket owner.
", "RegistryMapping$ecrAccountId": "Account ID of the account that owns the upstream container image.
" } }, "BatchDeleteReadSetRequest": { "base": null, "refs": { } }, "BatchDeleteReadSetResponse": { "base": null, "refs": { } }, "Blob": { "base": null, "refs": { "CreateWorkflowRequest$definitionZip": "A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the Amazon Web Services HealthOmics User Guide.
", "CreateWorkflowVersionRequest$definitionZip": "A ZIP archive containing the main workflow definition file and dependencies that it imports for this workflow version. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the Amazon Web Services HealthOmics User Guide.
" } }, "Boolean": { "base": null, "refs": { "GetRunTaskResponse$cacheHit": "Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.
", "TaskListItem$cacheHit": "Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.
", "VcfOptions$ignoreQualField": "The file's ignore qual field setting.
", "VcfOptions$ignoreFilterField": "The file's ignore filter field setting.
", "WorkflowParameter$optional": "Whether the parameter is optional.
" } }, "CacheBehavior": { "base": null, "refs": { "CreateRunCacheRequest$cacheBehavior": "Default cache behavior for runs that use this cache. Supported values are:
CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.
CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.
If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.
For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.
", "GetRunCacheResponse$cacheBehavior": "The default cache behavior for runs using this cache.
", "GetRunResponse$cacheBehavior": "The run cache behavior for the run.
", "RunCacheListItem$cacheBehavior": "Default cache behavior for the run cache.
", "StartRunRequest$cacheBehavior": "The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.
", "UpdateRunCacheRequest$cacheBehavior": "Update the default run cache behavior.
" } }, "CancelAnnotationImportRequest": { "base": null, "refs": { } }, "CancelAnnotationImportResponse": { "base": null, "refs": { } }, "CancelRunRequest": { "base": null, "refs": { } }, "CancelVariantImportRequest": { "base": null, "refs": { } }, "CancelVariantImportResponse": { "base": null, "refs": { } }, "ClientToken": { "base": null, "refs": { "CreateMultipartReadSetUploadRequest$clientToken": "An idempotency token that can be used to avoid triggering multiple multipart uploads.
", "CreateReferenceStoreRequest$clientToken": "To ensure that requests don't run multiple times, specify a unique token for each request.
", "CreateSequenceStoreRequest$clientToken": "An idempotency token used to dedupe retry requests so that duplicate runs are not created.
", "StartReadSetActivationJobRequest$clientToken": "To ensure that jobs don't run multiple times, specify a unique token for each job.
", "StartReadSetExportJobRequest$clientToken": "To ensure that jobs don't run multiple times, specify a unique token for each job.
", "StartReadSetImportJobRequest$clientToken": "To ensure that jobs don't run multiple times, specify a unique token for each job.
", "StartReferenceImportJobRequest$clientToken": "To ensure that jobs don't run multiple times, specify a unique token for each job.
", "UpdateSequenceStoreRequest$clientToken": "To ensure that requests don't run multiple times, specify a unique token for each request.
" } }, "CommentChar": { "base": null, "refs": { "ReadOptions$comment": "The file's comment character.
" } }, "CompleteMultipartReadSetUploadRequest": { "base": null, "refs": { } }, "CompleteMultipartReadSetUploadResponse": { "base": null, "refs": { } }, "CompleteReadSetUploadPartList": { "base": null, "refs": { "CompleteMultipartReadSetUploadRequest$parts": "The individual uploads or parts of a multipart upload.
" } }, "CompleteReadSetUploadPartListItem": { "base": "Part of the response to the CompleteReadSetUpload API, including metadata.
", "refs": { "CompleteReadSetUploadPartList$member": null } }, "CompleteReadSetUploadPartListItemChecksumString": { "base": null, "refs": { "CompleteReadSetUploadPartListItem$checksum": "A unique identifier used to confirm that parts are being added to the correct upload.
" } }, "CompleteReadSetUploadPartListItemPartNumberInteger": { "base": null, "refs": { "CompleteReadSetUploadPartListItem$partNumber": "A number identifying the part in a read set upload.
" } }, "CompletionTime": { "base": null, "refs": { "AnnotationImportJobItem$completionTime": "When the job completed.
", "GetAnnotationImportResponse$completionTime": "When the job completed.
", "GetVariantImportResponse$completionTime": "When the job completed.
", "VariantImportJobItem$completionTime": "When the job completed.
" } }, "ConflictException": { "base": "The request cannot be applied to the target resource in its current state.
", "refs": { } }, "ConnectionArn": { "base": null, "refs": { "DefinitionRepository$connectionArn": "The Amazon Resource Name (ARN) of the connection to the source code repository.
", "DefinitionRepositoryDetails$connectionArn": "The Amazon Resource Name (ARN) of the connection to the source code repository.
" } }, "ContainerRegistryMap": { "base": "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.
", "refs": { "CreateWorkflowRequest$containerRegistryMap": "(Optional) 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.
", "CreateWorkflowVersionRequest$containerRegistryMap": "(Optional) 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.
", "GetWorkflowResponse$containerRegistryMap": "The registry map that this workflow is using.
", "GetWorkflowVersionResponse$containerRegistryMap": "The registry map that this workflow version uses.
" } }, "CreateAnnotationStoreRequest": { "base": null, "refs": { } }, "CreateAnnotationStoreResponse": { "base": null, "refs": { } }, "CreateAnnotationStoreVersionRequest": { "base": null, "refs": { } }, "CreateAnnotationStoreVersionResponse": { "base": null, "refs": { } }, "CreateMultipartReadSetUploadRequest": { "base": null, "refs": { } }, "CreateMultipartReadSetUploadResponse": { "base": null, "refs": { } }, "CreateReferenceStoreRequest": { "base": null, "refs": { } }, "CreateReferenceStoreResponse": { "base": null, "refs": { } }, "CreateRunCacheRequest": { "base": null, "refs": { } }, "CreateRunCacheResponse": { "base": null, "refs": { } }, "CreateRunGroupRequest": { "base": null, "refs": { } }, "CreateRunGroupRequestMaxCpusInteger": { "base": null, "refs": { "CreateRunGroupRequest$maxCpus": "The maximum number of CPUs that can run concurrently across all active runs in the run group.
" } }, "CreateRunGroupRequestMaxDurationInteger": { "base": null, "refs": { "CreateRunGroupRequest$maxDuration": "The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.
" } }, "CreateRunGroupRequestMaxGpusInteger": { "base": null, "refs": { "CreateRunGroupRequest$maxGpus": "The maximum number of GPUs that can run concurrently across all active runs in the run group.
" } }, "CreateRunGroupRequestMaxRunsInteger": { "base": null, "refs": { "CreateRunGroupRequest$maxRuns": "The maximum number of runs that can be running at the same time.
" } }, "CreateRunGroupResponse": { "base": null, "refs": { } }, "CreateSequenceStoreRequest": { "base": null, "refs": { } }, "CreateSequenceStoreResponse": { "base": null, "refs": { } }, "CreateShareRequest": { "base": null, "refs": { } }, "CreateShareResponse": { "base": null, "refs": { } }, "CreateVariantStoreRequest": { "base": null, "refs": { } }, "CreateVariantStoreResponse": { "base": null, "refs": { } }, "CreateWorkflowRequest": { "base": null, "refs": { } }, "CreateWorkflowRequestStorageCapacityInteger": { "base": null, "refs": { "CreateWorkflowRequest$storageCapacity": "The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.
The default static storage capacity (in gibibytes) for runs that use this workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.
The read set's creation job ID.
", "GetReferenceMetadataResponse$creationJobId": "The reference's creation job ID.
" } }, "CreationTime": { "base": null, "refs": { "AnnotationImportJobItem$creationTime": "When the job was created.
", "AnnotationStoreItem$creationTime": "The store's creation time.
", "AnnotationStoreVersionItem$creationTime": "The time stamp for when an annotation store version was created.
", "CreateAnnotationStoreResponse$creationTime": "When the store was created.
", "CreateAnnotationStoreVersionResponse$creationTime": "The time stamp for the creation of an annotation store version.
", "CreateVariantStoreResponse$creationTime": "When the store was created.
", "GetAnnotationImportResponse$creationTime": "When the job was created.
", "GetAnnotationStoreResponse$creationTime": "When the store was created.
", "GetAnnotationStoreVersionResponse$creationTime": "The time stamp for when an annotation store version was created.
", "GetVariantImportResponse$creationTime": "When the job was created.
", "GetVariantStoreResponse$creationTime": "When the store was created.
", "ShareDetails$creationTime": "The timestamp of when the resource share was created.
", "UpdateAnnotationStoreResponse$creationTime": "When the store was created.
", "UpdateAnnotationStoreVersionResponse$creationTime": "The time stamp for when an annotation store version was created.
", "UpdateVariantStoreResponse$creationTime": "When the store was created.
", "VariantImportJobItem$creationTime": "When the job was created.
", "VariantStoreItem$creationTime": "When the store was created.
" } }, "CreationType": { "base": null, "refs": { "GetReadSetMetadataResponse$creationType": "The creation type of the read set.
", "ReadSetFilter$creationType": "The creation type of the read set.
", "ReadSetListItem$creationType": "The creation type of the read set.
" } }, "DefinitionRepository": { "base": "Contains information about a source code repository that hosts the workflow definition files.
", "refs": { "CreateWorkflowRequest$definitionRepository": "The repository information for the workflow definition. This allows you to source your workflow definition directly from a code repository.
", "CreateWorkflowVersionRequest$definitionRepository": "The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.
" } }, "DefinitionRepositoryDetails": { "base": "Contains detailed information about the source code repository that hosts the workflow definition files.
", "refs": { "GetWorkflowResponse$definitionRepositoryDetails": "Details about the source code repository that hosts the workflow definition files.
", "GetWorkflowVersionResponse$definitionRepositoryDetails": "Details about the source code repository that hosts the workflow version definition files.
" } }, "DeleteAnnotationStoreRequest": { "base": null, "refs": { } }, "DeleteAnnotationStoreResponse": { "base": null, "refs": { } }, "DeleteAnnotationStoreVersionsRequest": { "base": null, "refs": { } }, "DeleteAnnotationStoreVersionsResponse": { "base": null, "refs": { } }, "DeleteReferenceRequest": { "base": null, "refs": { } }, "DeleteReferenceResponse": { "base": null, "refs": { } }, "DeleteReferenceStoreRequest": { "base": null, "refs": { } }, "DeleteReferenceStoreResponse": { "base": null, "refs": { } }, "DeleteRunCacheRequest": { "base": null, "refs": { } }, "DeleteRunGroupRequest": { "base": null, "refs": { } }, "DeleteRunRequest": { "base": null, "refs": { } }, "DeleteS3AccessPolicyRequest": { "base": null, "refs": { } }, "DeleteS3AccessPolicyResponse": { "base": null, "refs": { } }, "DeleteSequenceStoreRequest": { "base": null, "refs": { } }, "DeleteSequenceStoreResponse": { "base": null, "refs": { } }, "DeleteShareRequest": { "base": null, "refs": { } }, "DeleteShareResponse": { "base": null, "refs": { } }, "DeleteVariantStoreRequest": { "base": null, "refs": { } }, "DeleteVariantStoreResponse": { "base": null, "refs": { } }, "DeleteWorkflowRequest": { "base": null, "refs": { } }, "DeleteWorkflowVersionRequest": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "AnnotationStoreItem$description": "The store's description.
", "AnnotationStoreVersionItem$description": "The description of an annotation store version.
", "CreateAnnotationStoreRequest$description": "A description for the store.
", "CreateAnnotationStoreVersionRequest$description": "The description of an annotation store version.
", "CreateVariantStoreRequest$description": "A description for the store.
", "GetAnnotationStoreResponse$description": "The store's description.
", "GetAnnotationStoreVersionResponse$description": "The description for an annotation store version.
", "GetVariantStoreResponse$description": "The store's description.
", "UpdateAnnotationStoreRequest$description": "A description for the store.
", "UpdateAnnotationStoreResponse$description": "The store's description.
", "UpdateAnnotationStoreVersionRequest$description": "The description of an annotation store.
", "UpdateAnnotationStoreVersionResponse$description": "The description of an annotation store version.
", "UpdateVariantStoreRequest$description": "A description for the store.
", "UpdateVariantStoreResponse$description": "The store's description.
", "VariantStoreItem$description": "The store's description.
" } }, "ETag": { "base": "The entity tag (ETag) is a hash of the object representing its semantic content.
", "refs": { "GetReadSetMetadataResponse$etag": "The entity tag (ETag) is a hash of the object meant to represent its semantic content.
", "ReadSetListItem$etag": "The entity tag (ETag) is a hash of the object representing its semantic content.
" } }, "ETagAlgorithm": { "base": null, "refs": { "ETag$algorithm": "The algorithm used to calculate the read set’s ETag(s).
" } }, "ETagAlgorithmFamily": { "base": null, "refs": { "CreateSequenceStoreRequest$eTagAlgorithmFamily": "The ETag algorithm family to use for ingested read sets. The default value is MD5up. For more information on ETags, see ETags and data provenance in the Amazon Web Services HealthOmics User Guide.
", "CreateSequenceStoreResponse$eTagAlgorithmFamily": "The algorithm family of the ETag.
", "GetSequenceStoreResponse$eTagAlgorithmFamily": "The algorithm family of the ETag.
", "SequenceStoreDetail$eTagAlgorithmFamily": "The algorithm family of the ETag.
", "UpdateSequenceStoreResponse$eTagAlgorithmFamily": "The ETag algorithm family to use on ingested read sets.
" } }, "EcrRepositoryPrefix": { "base": null, "refs": { "RegistryMapping$ecrRepositoryPrefix": "The repository prefix to use in the ECR private repository.
" } }, "Encoding": { "base": null, "refs": { "ReadOptions$encoding": "The file's encoding.
" } }, "EncryptionType": { "base": null, "refs": { "SseConfig$type": "The encryption type.
" } }, "EngineLogStream": { "base": null, "refs": { "RunLogLocation$engineLogStream": "The log stream ARN for the engine log.
" } }, "EngineVersion": { "base": null, "refs": { "GetRunResponse$engineVersion": "The actual Nextflow engine version that Amazon Web Services HealthOmics used for the run. The other workflow definition languages don't provide a value for this field.
" } }, "EscapeChar": { "base": null, "refs": { "ReadOptions$escape": "A character for escaping quotes in the file.
" } }, "EscapeQuotes": { "base": null, "refs": { "ReadOptions$escapeQuotes": "Whether quotes need to be escaped in the file.
" } }, "ExcludeFilePatternList": { "base": null, "refs": { "DefinitionRepository$excludeFilePatterns": "A list of file patterns to exclude when retrieving the workflow definition from the repository.
" } }, "ExportJobId": { "base": null, "refs": { "ExportReadSetJobDetail$id": "The job's ID.
", "GetReadSetExportJobRequest$id": "The job's ID.
", "GetReadSetExportJobResponse$id": "The job's ID.
", "StartReadSetExportJobResponse$id": "The job's ID.
" } }, "ExportReadSet": { "base": "A read set.
", "refs": { "StartReadSetExportJobRequestSourcesList$member": null } }, "ExportReadSetDetail": { "base": "Details about a read set.
", "refs": { "ExportReadSetDetailList$member": null } }, "ExportReadSetDetailList": { "base": null, "refs": { "GetReadSetExportJobResponse$readSets": "The job's read sets.
" } }, "ExportReadSetFilter": { "base": "An read set export job filter.
", "refs": { "ListReadSetExportJobsRequest$filter": "A filter to apply to the list.
" } }, "ExportReadSetJobDetail": { "base": "Details about a read set export job.
", "refs": { "ExportReadSetJobDetailList$member": null } }, "ExportReadSetJobDetailList": { "base": null, "refs": { "ListReadSetExportJobsResponse$exportJobs": "A list of jobs.
" } }, "FallbackLocation": { "base": null, "refs": { "CreateSequenceStoreRequest$fallbackLocation": "An S3 location that is used to store files that have failed a direct upload. You can add or change the fallbackLocation after creating a sequence store. This is not required if you are uploading files from a different S3 bucket.
An S3 location that is used to store files that have failed a direct upload.
", "GetSequenceStoreResponse$fallbackLocation": "An S3 location that is used to store files that have failed a direct upload.
", "SequenceStoreDetail$fallbackLocation": "An S3 location that is used to store files that have failed a direct upload.
", "UpdateSequenceStoreRequest$fallbackLocation": "The S3 URI of a bucket and folder to store Read Sets that fail to upload.
", "UpdateSequenceStoreResponse$fallbackLocation": "The S3 URI of a bucket and folder to store Read Sets that fail to upload.
" } }, "FileInformation": { "base": "Details about a file.
", "refs": { "ReadSetFiles$source1": "The location of the first file in Amazon S3.
", "ReadSetFiles$source2": "The location of the second file in Amazon S3.
", "ReadSetFiles$index": "The files' index.
", "ReferenceFiles$source": "The source file's location in Amazon S3.
", "ReferenceFiles$index": "The files' index.
" } }, "FileInformationContentLengthLong": { "base": null, "refs": { "FileInformation$contentLength": "The file's content length.
" } }, "FileInformationPartSizeLong": { "base": null, "refs": { "FileInformation$partSize": "The file's part size.
" } }, "FileInformationTotalPartsInteger": { "base": null, "refs": { "FileInformation$totalParts": "The file's total parts.
" } }, "FileType": { "base": null, "refs": { "CreateMultipartReadSetUploadRequest$sourceFileType": "The type of file being uploaded.
", "CreateMultipartReadSetUploadResponse$sourceFileType": "The file type of the read set source.
", "GetReadSetMetadataResponse$fileType": "The read set's file type.
", "ImportReadSetSourceItem$sourceFileType": "The source's file type.
", "MultipartReadSetUploadListItem$sourceFileType": "The type of file the read set originated from.
", "ReadSetListItem$fileType": "The read set's file type.
", "StartReadSetImportJobSourceItem$sourceFileType": "The source's file type.
" } }, "Filter": { "base": "Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status.
", "refs": { "ListSharesRequest$filter": "Attributes that you use to filter for a specific subset of resource shares.
" } }, "FormatOptions": { "base": "Formatting options for a file.
", "refs": { "GetAnnotationImportResponse$formatOptions": null, "StartAnnotationImportRequest$formatOptions": "Formatting options for the annotation file.
" } }, "FormatToHeader": { "base": null, "refs": { "TsvStoreOptions$formatToHeader": "The store's header key to column name mapping.
", "TsvVersionOptions$formatToHeader": "The annotation store version's header key to column name mapping.
" } }, "FormatToHeaderKey": { "base": null, "refs": { "FormatToHeader$key": null } }, "FormatToHeaderValueString": { "base": null, "refs": { "FormatToHeader$value": null } }, "FullRepositoryId": { "base": null, "refs": { "DefinitionRepository$fullRepositoryId": "The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
", "DefinitionRepositoryDetails$fullRepositoryId": "The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
" } }, "GeneratedFrom": { "base": null, "refs": { "CreateMultipartReadSetUploadRequest$generatedFrom": "Where the source originated.
", "CreateMultipartReadSetUploadResponse$generatedFrom": "The source of the read set.
", "ImportReadSetSourceItem$generatedFrom": "Where the source originated.
", "MultipartReadSetUploadListItem$generatedFrom": "The source of an uploaded part.
", "ReadSetFilter$generatedFrom": "Where the source originated.
", "SequenceInformation$generatedFrom": "Where the sequence originated.
", "StartReadSetImportJobSourceItem$generatedFrom": "Where the source originated.
" } }, "GetAnnotationImportRequest": { "base": null, "refs": { } }, "GetAnnotationImportResponse": { "base": null, "refs": { } }, "GetAnnotationStoreRequest": { "base": null, "refs": { } }, "GetAnnotationStoreResponse": { "base": null, "refs": { } }, "GetAnnotationStoreVersionRequest": { "base": null, "refs": { } }, "GetAnnotationStoreVersionResponse": { "base": null, "refs": { } }, "GetReadSetActivationJobRequest": { "base": null, "refs": { } }, "GetReadSetActivationJobResponse": { "base": null, "refs": { } }, "GetReadSetExportJobRequest": { "base": null, "refs": { } }, "GetReadSetExportJobResponse": { "base": null, "refs": { } }, "GetReadSetImportJobRequest": { "base": null, "refs": { } }, "GetReadSetImportJobResponse": { "base": null, "refs": { } }, "GetReadSetMetadataRequest": { "base": null, "refs": { } }, "GetReadSetMetadataResponse": { "base": null, "refs": { } }, "GetReadSetRequest": { "base": null, "refs": { } }, "GetReadSetRequestPartNumberInteger": { "base": null, "refs": { "GetReadSetRequest$partNumber": "The part number to retrieve.
" } }, "GetReadSetResponse": { "base": null, "refs": { } }, "GetReferenceImportJobRequest": { "base": null, "refs": { } }, "GetReferenceImportJobResponse": { "base": null, "refs": { } }, "GetReferenceMetadataRequest": { "base": null, "refs": { } }, "GetReferenceMetadataResponse": { "base": null, "refs": { } }, "GetReferenceRequest": { "base": null, "refs": { } }, "GetReferenceRequestPartNumberInteger": { "base": null, "refs": { "GetReferenceRequest$partNumber": "The part number to retrieve.
" } }, "GetReferenceResponse": { "base": null, "refs": { } }, "GetReferenceStoreRequest": { "base": null, "refs": { } }, "GetReferenceStoreResponse": { "base": null, "refs": { } }, "GetRunCacheRequest": { "base": null, "refs": { } }, "GetRunCacheResponse": { "base": null, "refs": { } }, "GetRunGroupRequest": { "base": null, "refs": { } }, "GetRunGroupResponse": { "base": null, "refs": { } }, "GetRunGroupResponseMaxCpusInteger": { "base": null, "refs": { "GetRunGroupResponse$maxCpus": "The group's maximum number of CPUs to use.
" } }, "GetRunGroupResponseMaxDurationInteger": { "base": null, "refs": { "GetRunGroupResponse$maxDuration": "The group's maximum run time in minutes.
" } }, "GetRunGroupResponseMaxGpusInteger": { "base": null, "refs": { "GetRunGroupResponse$maxGpus": "The maximum GPUs that can be used by a run group.
" } }, "GetRunGroupResponseMaxRunsInteger": { "base": null, "refs": { "GetRunGroupResponse$maxRuns": "The maximum number of concurrent runs for the group.
" } }, "GetRunRequest": { "base": null, "refs": { } }, "GetRunResponse": { "base": null, "refs": { } }, "GetRunResponsePriorityInteger": { "base": null, "refs": { "GetRunResponse$priority": "The run's priority.
" } }, "GetRunResponseStorageCapacityInteger": { "base": null, "refs": { "GetRunResponse$storageCapacity": "The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
" } }, "GetRunTaskRequest": { "base": null, "refs": { } }, "GetRunTaskResponse": { "base": null, "refs": { } }, "GetRunTaskResponseCpusInteger": { "base": null, "refs": { "GetRunTaskResponse$cpus": "The task's CPU usage.
" } }, "GetRunTaskResponseGpusInteger": { "base": null, "refs": { "GetRunTaskResponse$gpus": "The number of Graphics Processing Units (GPU) specified in the task.
" } }, "GetRunTaskResponseMemoryInteger": { "base": null, "refs": { "GetRunTaskResponse$memory": "The task's memory use in gigabytes.
" } }, "GetS3AccessPolicyRequest": { "base": null, "refs": { } }, "GetS3AccessPolicyResponse": { "base": null, "refs": { } }, "GetSequenceStoreRequest": { "base": null, "refs": { } }, "GetSequenceStoreResponse": { "base": null, "refs": { } }, "GetShareRequest": { "base": null, "refs": { } }, "GetShareResponse": { "base": null, "refs": { } }, "GetVariantImportRequest": { "base": null, "refs": { } }, "GetVariantImportResponse": { "base": null, "refs": { } }, "GetVariantStoreRequest": { "base": null, "refs": { } }, "GetVariantStoreResponse": { "base": null, "refs": { } }, "GetWorkflowRequest": { "base": null, "refs": { } }, "GetWorkflowResponse": { "base": null, "refs": { } }, "GetWorkflowResponseStorageCapacityInteger": { "base": null, "refs": { "GetWorkflowResponse$storageCapacity": "The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
" } }, "GetWorkflowVersionRequest": { "base": null, "refs": { } }, "GetWorkflowVersionResponse": { "base": null, "refs": { } }, "GetWorkflowVersionResponseStorageCapacityInteger": { "base": null, "refs": { "GetWorkflowVersionResponse$storageCapacity": "The default run storage capacity for static storage.
" } }, "Header": { "base": null, "refs": { "ReadOptions$header": "Whether the file has a header row.
" } }, "ImageDetails": { "base": "Information about the container image used for a task.
", "refs": { "GetRunTaskResponse$imageDetails": "Details about the container image that this task uses.
" } }, "ImageMapping": { "base": "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.
", "refs": { "ImageMappingsList$member": null } }, "ImageMappingsList": { "base": null, "refs": { "ContainerRegistryMap$imageMappings": "Image mappings specify path mappings between the ECR private repository and their corresponding external repositories.
" } }, "ImportJobId": { "base": null, "refs": { "GetReadSetImportJobRequest$id": "The job's ID.
", "GetReadSetImportJobResponse$id": "The job's ID.
", "GetReferenceImportJobRequest$id": "The job's ID.
", "GetReferenceImportJobResponse$id": "The job's ID.
", "ImportReadSetJobItem$id": "The job's ID.
", "ImportReferenceJobItem$id": "The job's ID.
", "StartReadSetImportJobResponse$id": "The job's ID.
", "StartReferenceImportJobResponse$id": "The job's ID.
" } }, "ImportReadSetFilter": { "base": "A filter for import read set jobs.
", "refs": { "ListReadSetImportJobsRequest$filter": "A filter to apply to the list.
" } }, "ImportReadSetJobItem": { "base": "An import read set job.
", "refs": { "ImportReadSetJobList$member": null } }, "ImportReadSetJobList": { "base": null, "refs": { "ListReadSetImportJobsResponse$importJobs": "A list of jobs.
" } }, "ImportReadSetSourceItem": { "base": "A source for an import read set job.
", "refs": { "ImportReadSetSourceList$member": null } }, "ImportReadSetSourceList": { "base": null, "refs": { "GetReadSetImportJobResponse$sources": "The job's source files.
" } }, "ImportReferenceFilter": { "base": "A filter for import references.
", "refs": { "ListReferenceImportJobsRequest$filter": "A filter to apply to the list.
" } }, "ImportReferenceJobItem": { "base": "An import reference job.
", "refs": { "ImportReferenceJobList$member": null } }, "ImportReferenceJobList": { "base": null, "refs": { "ListReferenceImportJobsResponse$importJobs": "A lis of jobs.
" } }, "ImportReferenceSourceItem": { "base": "An genome reference source.
", "refs": { "ImportReferenceSourceList$member": null } }, "ImportReferenceSourceList": { "base": null, "refs": { "GetReferenceImportJobResponse$sources": "The job's source files.
" } }, "Integer": { "base": null, "refs": { "GetAnnotationStoreResponse$numVersions": "An integer indicating how many versions of an annotation store exist.
", "ListSharesRequest$maxResults": "The maximum number of shares to return in one page of results.
" } }, "InternalServerException": { "base": "An unexpected error occurred. Try the request again.
", "refs": { } }, "JobStatus": { "base": null, "refs": { "AnnotationImportItemDetail$jobStatus": "The item's job status.
", "AnnotationImportJobItem$status": "The job's status.
", "GetAnnotationImportResponse$status": "The job's status.
", "GetVariantImportResponse$status": "The job's status.
", "ListAnnotationImportJobsFilter$status": "A status to filter on.
", "ListVariantImportJobsFilter$status": "A status to filter on.
", "VariantImportItemDetail$jobStatus": "The item's job status.
", "VariantImportJobItem$status": "The job's status.
" } }, "JobStatusMessage": { "base": null, "refs": { "ActivateReadSetSourceItem$statusMessage": "The source's status message.
", "ExportReadSetDetail$statusMessage": "The set's status message.
", "GetReadSetActivationJobResponse$statusMessage": "The job's status message.
", "GetReadSetExportJobResponse$statusMessage": "The job's status message.
", "GetReadSetImportJobResponse$statusMessage": "The job's status message.
", "GetReferenceImportJobResponse$statusMessage": "The job's status message.
", "ImportReadSetSourceItem$statusMessage": "The source's status message.
", "ImportReferenceSourceItem$statusMessage": "The source's status message.
" } }, "JobStatusMsg": { "base": null, "refs": { "GetAnnotationImportResponse$statusMessage": "The job's status message.
", "GetVariantImportResponse$statusMessage": "The job's status message.
", "VariantImportItemDetail$statusMessage": "A message that provides additional context about a job
" } }, "LineSep": { "base": null, "refs": { "ReadOptions$lineSep": "A line separator for the file.
" } }, "ListAnnotationImportJobsFilter": { "base": "A filter for annotation import jobs.
", "refs": { "ListAnnotationImportJobsRequest$filter": "A filter to apply to the list.
" } }, "ListAnnotationImportJobsRequest": { "base": null, "refs": { } }, "ListAnnotationImportJobsRequestIdsList": { "base": null, "refs": { "ListAnnotationImportJobsRequest$ids": "IDs of annotation import jobs to retrieve.
" } }, "ListAnnotationImportJobsRequestMaxResultsInteger": { "base": null, "refs": { "ListAnnotationImportJobsRequest$maxResults": "The maximum number of jobs to return in one page of results.
" } }, "ListAnnotationImportJobsRequestNextTokenString": { "base": null, "refs": { "ListAnnotationImportJobsRequest$nextToken": "Specifies the pagination token from a previous request to retrieve the next page of results.
" } }, "ListAnnotationImportJobsResponse": { "base": null, "refs": { } }, "ListAnnotationStoreVersionsFilter": { "base": "Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.
", "refs": { "ListAnnotationStoreVersionsRequest$filter": "A filter to apply to the list of annotation store versions.
" } }, "ListAnnotationStoreVersionsRequest": { "base": null, "refs": { } }, "ListAnnotationStoreVersionsRequestMaxResultsInteger": { "base": null, "refs": { "ListAnnotationStoreVersionsRequest$maxResults": "The maximum number of annotation store versions to return in one page of results.
" } }, "ListAnnotationStoreVersionsRequestNextTokenString": { "base": null, "refs": { "ListAnnotationStoreVersionsRequest$nextToken": "Specifies the pagination token from a previous request to retrieve the next page of results.
" } }, "ListAnnotationStoreVersionsResponse": { "base": null, "refs": { } }, "ListAnnotationStoresFilter": { "base": "A filter for annotation stores.
", "refs": { "ListAnnotationStoresRequest$filter": "A filter to apply to the list.
" } }, "ListAnnotationStoresRequest": { "base": null, "refs": { } }, "ListAnnotationStoresRequestIdsList": { "base": null, "refs": { "ListAnnotationStoresRequest$ids": "IDs of stores to list.
" } }, "ListAnnotationStoresRequestMaxResultsInteger": { "base": null, "refs": { "ListAnnotationStoresRequest$maxResults": "The maximum number of stores to return in one page of results.
" } }, "ListAnnotationStoresRequestNextTokenString": { "base": null, "refs": { "ListAnnotationStoresRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
" } }, "ListAnnotationStoresResponse": { "base": null, "refs": { } }, "ListMultipartReadSetUploadsRequest": { "base": null, "refs": { } }, "ListMultipartReadSetUploadsRequestMaxResultsInteger": { "base": null, "refs": { "ListMultipartReadSetUploadsRequest$maxResults": "The maximum number of multipart uploads returned in a page.
" } }, "ListMultipartReadSetUploadsResponse": { "base": null, "refs": { } }, "ListReadSetActivationJobsRequest": { "base": null, "refs": { } }, "ListReadSetActivationJobsRequestMaxResultsInteger": { "base": null, "refs": { "ListReadSetActivationJobsRequest$maxResults": "The maximum number of read set activation jobs to return in one page of results.
" } }, "ListReadSetActivationJobsResponse": { "base": null, "refs": { } }, "ListReadSetExportJobsRequest": { "base": null, "refs": { } }, "ListReadSetExportJobsRequestMaxResultsInteger": { "base": null, "refs": { "ListReadSetExportJobsRequest$maxResults": "The maximum number of jobs to return in one page of results.
" } }, "ListReadSetExportJobsResponse": { "base": null, "refs": { } }, "ListReadSetImportJobsRequest": { "base": null, "refs": { } }, "ListReadSetImportJobsRequestMaxResultsInteger": { "base": null, "refs": { "ListReadSetImportJobsRequest$maxResults": "The maximum number of jobs to return in one page of results.
" } }, "ListReadSetImportJobsResponse": { "base": null, "refs": { } }, "ListReadSetUploadPartsRequest": { "base": null, "refs": { } }, "ListReadSetUploadPartsRequestMaxResultsInteger": { "base": null, "refs": { "ListReadSetUploadPartsRequest$maxResults": "The maximum number of read set upload parts returned in a page.
" } }, "ListReadSetUploadPartsResponse": { "base": null, "refs": { } }, "ListReadSetsRequest": { "base": null, "refs": { } }, "ListReadSetsRequestMaxResultsInteger": { "base": null, "refs": { "ListReadSetsRequest$maxResults": "The maximum number of read sets to return in one page of results.
" } }, "ListReadSetsResponse": { "base": null, "refs": { } }, "ListReferenceImportJobsRequest": { "base": null, "refs": { } }, "ListReferenceImportJobsRequestMaxResultsInteger": { "base": null, "refs": { "ListReferenceImportJobsRequest$maxResults": "The maximum number of jobs to return in one page of results.
" } }, "ListReferenceImportJobsResponse": { "base": null, "refs": { } }, "ListReferenceStoresRequest": { "base": null, "refs": { } }, "ListReferenceStoresRequestMaxResultsInteger": { "base": null, "refs": { "ListReferenceStoresRequest$maxResults": "The maximum number of stores to return in one page of results.
" } }, "ListReferenceStoresResponse": { "base": null, "refs": { } }, "ListReferencesRequest": { "base": null, "refs": { } }, "ListReferencesRequestMaxResultsInteger": { "base": null, "refs": { "ListReferencesRequest$maxResults": "The maximum number of references to return in one page of results.
" } }, "ListReferencesResponse": { "base": null, "refs": { } }, "ListRunCachesRequest": { "base": null, "refs": { } }, "ListRunCachesRequestMaxResultsInteger": { "base": null, "refs": { "ListRunCachesRequest$maxResults": "The maximum number of results to return.
" } }, "ListRunCachesResponse": { "base": null, "refs": { } }, "ListRunGroupsRequest": { "base": null, "refs": { } }, "ListRunGroupsRequestMaxResultsInteger": { "base": null, "refs": { "ListRunGroupsRequest$maxResults": "The maximum number of run groups to return in one page of results.
" } }, "ListRunGroupsResponse": { "base": null, "refs": { } }, "ListRunTasksRequest": { "base": null, "refs": { } }, "ListRunTasksRequestMaxResultsInteger": { "base": null, "refs": { "ListRunTasksRequest$maxResults": "The maximum number of run tasks to return in one page of results.
" } }, "ListRunTasksResponse": { "base": null, "refs": { } }, "ListRunsRequest": { "base": null, "refs": { } }, "ListRunsRequestMaxResultsInteger": { "base": null, "refs": { "ListRunsRequest$maxResults": "The maximum number of runs to return in one page of results.
" } }, "ListRunsResponse": { "base": null, "refs": { } }, "ListSequenceStoresRequest": { "base": null, "refs": { } }, "ListSequenceStoresRequestMaxResultsInteger": { "base": null, "refs": { "ListSequenceStoresRequest$maxResults": "The maximum number of stores to return in one page of results.
" } }, "ListSequenceStoresResponse": { "base": null, "refs": { } }, "ListSharesRequest": { "base": null, "refs": { } }, "ListSharesResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListToken": { "base": null, "refs": { "ListRunCachesRequest$startingToken": "Optional pagination token returned from a prior call to the ListRunCaches API operation.
Pagination token to retrieve additional run caches. If the response does not have a nextTokenvalue, you have reached to the end of the list.
A filter for variant import jobs.
", "refs": { "ListVariantImportJobsRequest$filter": "A filter to apply to the list.
" } }, "ListVariantImportJobsRequest": { "base": null, "refs": { } }, "ListVariantImportJobsRequestIdsList": { "base": null, "refs": { "ListVariantImportJobsRequest$ids": "A list of job IDs.
" } }, "ListVariantImportJobsRequestMaxResultsInteger": { "base": null, "refs": { "ListVariantImportJobsRequest$maxResults": "The maximum number of import jobs to return in one page of results.
" } }, "ListVariantImportJobsRequestNextTokenString": { "base": null, "refs": { "ListVariantImportJobsRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
" } }, "ListVariantImportJobsResponse": { "base": null, "refs": { } }, "ListVariantStoresFilter": { "base": "A filter for variant stores.
", "refs": { "ListVariantStoresRequest$filter": "A filter to apply to the list.
" } }, "ListVariantStoresRequest": { "base": null, "refs": { } }, "ListVariantStoresRequestIdsList": { "base": null, "refs": { "ListVariantStoresRequest$ids": "A list of store IDs.
" } }, "ListVariantStoresRequestMaxResultsInteger": { "base": null, "refs": { "ListVariantStoresRequest$maxResults": "The maximum number of stores to return in one page of results.
" } }, "ListVariantStoresRequestNextTokenString": { "base": null, "refs": { "ListVariantStoresRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
" } }, "ListVariantStoresResponse": { "base": null, "refs": { } }, "ListWorkflowVersionsRequest": { "base": null, "refs": { } }, "ListWorkflowVersionsRequestMaxResultsInteger": { "base": null, "refs": { "ListWorkflowVersionsRequest$maxResults": "The maximum number of workflows to return in one page of results.
" } }, "ListWorkflowVersionsResponse": { "base": null, "refs": { } }, "ListWorkflowsRequest": { "base": null, "refs": { } }, "ListWorkflowsRequestMaxResultsInteger": { "base": null, "refs": { "ListWorkflowsRequest$maxResults": "The maximum number of workflows to return in one page of results.
" } }, "ListWorkflowsResponse": { "base": null, "refs": { } }, "Long": { "base": null, "refs": { "AnnotationStoreItem$storeSizeBytes": "The store's size in bytes.
", "AnnotationStoreVersionItem$versionSizeBytes": "The size of an annotation store version in Bytes.
", "GetAnnotationStoreResponse$storeSizeBytes": "The store's size in bytes.
", "GetAnnotationStoreVersionResponse$versionSizeBytes": "The size of the annotation store version in Bytes.
", "GetVariantStoreResponse$storeSizeBytes": "The store's size in bytes.
", "SequenceInformation$totalReadCount": "The sequence's total read count.
", "SequenceInformation$totalBaseCount": "The sequence's total base count.
", "VariantStoreItem$storeSizeBytes": "The store's size in bytes.
" } }, "Md5": { "base": null, "refs": { "GetReferenceMetadataResponse$md5": "The reference's MD5 checksum.
", "ReferenceFilter$md5": "An MD5 checksum to filter on.
", "ReferenceListItem$md5": "The reference's MD5 checksum.
" } }, "MultipartReadSetUploadList": { "base": null, "refs": { "ListMultipartReadSetUploadsResponse$uploads": "An array of multipart uploads.
" } }, "MultipartReadSetUploadListItem": { "base": "Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.
", "refs": { "MultipartReadSetUploadList$member": null } }, "NextToken": { "base": null, "refs": { "ListMultipartReadSetUploadsRequest$nextToken": "Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.
", "ListMultipartReadSetUploadsResponse$nextToken": "Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.
", "ListReadSetActivationJobsRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListReadSetActivationJobsResponse$nextToken": "A pagination token that's included if more results are available.
", "ListReadSetExportJobsRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListReadSetExportJobsResponse$nextToken": "A pagination token that's included if more results are available.
", "ListReadSetImportJobsRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListReadSetImportJobsResponse$nextToken": "A pagination token that's included if more results are available.
", "ListReadSetUploadPartsRequest$nextToken": "Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.
", "ListReadSetUploadPartsResponse$nextToken": "Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.
", "ListReadSetsRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListReadSetsResponse$nextToken": "A pagination token that's included if more results are available.
", "ListReferenceImportJobsRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListReferenceImportJobsResponse$nextToken": "A pagination token that's included if more results are available.
", "ListReferenceStoresRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListReferenceStoresResponse$nextToken": "A pagination token that's included if more results are available.
", "ListReferencesRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListReferencesResponse$nextToken": "A pagination token that's included if more results are available.
", "ListSequenceStoresRequest$nextToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListSequenceStoresResponse$nextToken": "A pagination token that's included if more results are available.
" } }, "NotSupportedOperationException": { "base": "The operation is not supported by Amazon Omics, or the API does not exist.
", "refs": { } }, "NumericIdInArn": { "base": null, "refs": { "GetRunResponse$cacheId": "The run cache associated with the run.
", "StartRunRequest$cacheId": "Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.
" } }, "ParameterTemplatePath": { "base": null, "refs": { "CreateWorkflowRequest$parameterTemplatePath": "The path to the workflow parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow. If not specified, the workflow will be created without a parameter template.
", "CreateWorkflowVersionRequest$parameterTemplatePath": "The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.
" } }, "PrimitiveBoolean": { "base": null, "refs": { "DeleteAnnotationStoreRequest$force": "Whether to force deletion.
", "DeleteAnnotationStoreVersionsRequest$force": "Forces the deletion of an annotation store version when imports are in-progress..
", "DeleteVariantStoreRequest$force": "Whether to force deletion.
" } }, "PropagatedSetLevelTags": { "base": null, "refs": { "CreateSequenceStoreRequest$propagatedSetLevelTags": "The tags keys to propagate to the S3 objects associated with read sets in the sequence store. These tags can be used as input to add metadata to your read sets.
", "CreateSequenceStoreResponse$propagatedSetLevelTags": "The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
", "GetSequenceStoreResponse$propagatedSetLevelTags": "The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
", "UpdateSequenceStoreRequest$propagatedSetLevelTags": "The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
", "UpdateSequenceStoreResponse$propagatedSetLevelTags": "The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
" } }, "PutS3AccessPolicyRequest": { "base": null, "refs": { } }, "PutS3AccessPolicyResponse": { "base": null, "refs": { } }, "Quote": { "base": null, "refs": { "ReadOptions$quote": "The file's quote character.
" } }, "QuoteAll": { "base": null, "refs": { "ReadOptions$quoteAll": "Whether all values need to be quoted, or just those that contain quotes.
" } }, "Range": { "base": null, "refs": { "GetReferenceRequest$range": "The range to retrieve.
" } }, "RangeNotSatisfiableException": { "base": "The ranges specified in the request are not valid.
", "refs": { } }, "ReadOptions": { "base": "Read options for an annotation import job.
", "refs": { "TsvOptions$readOptions": "The file's read options.
" } }, "ReadSetActivationJobItemStatus": { "base": null, "refs": { "ActivateReadSetSourceItem$status": "The source's status.
" } }, "ReadSetActivationJobStatus": { "base": null, "refs": { "ActivateReadSetFilter$status": "The filter's status.
", "ActivateReadSetJobItem$status": "The job's status.
", "GetReadSetActivationJobResponse$status": "The job's status.
", "StartReadSetActivationJobResponse$status": "The job's status.
" } }, "ReadSetArn": { "base": null, "refs": { "GetReadSetMetadataResponse$arn": "The read set's ARN.
", "ReadSetListItem$arn": "The read set's ARN.
" } }, "ReadSetBatchError": { "base": "An error from a batch read set operation.
", "refs": { "ReadSetBatchErrorList$member": null } }, "ReadSetBatchErrorList": { "base": null, "refs": { "BatchDeleteReadSetResponse$errors": "Errors returned by individual delete operations.
" } }, "ReadSetDescription": { "base": null, "refs": { "CreateMultipartReadSetUploadRequest$description": "The description of the read set.
", "CreateMultipartReadSetUploadResponse$description": "The description of the read set.
", "GetReadSetMetadataResponse$description": "The read set's description.
", "ImportReadSetSourceItem$description": "The source's description.
", "MultipartReadSetUploadListItem$description": "The description of a read set.
", "ReadSetListItem$description": "The read set's description.
", "StartReadSetImportJobSourceItem$description": "The source's description.
" } }, "ReadSetExportJobItemStatus": { "base": null, "refs": { "ExportReadSetDetail$status": "The set's status.
" } }, "ReadSetExportJobStatus": { "base": null, "refs": { "ExportReadSetFilter$status": "A status to filter on.
", "ExportReadSetJobDetail$status": "The job's status.
", "GetReadSetExportJobResponse$status": "The job's status.
", "StartReadSetExportJobResponse$status": "The job's status.
" } }, "ReadSetFile": { "base": null, "refs": { "GetReadSetRequest$file": "The file to retrieve.
" } }, "ReadSetFiles": { "base": "Files in a read set.
", "refs": { "GetReadSetMetadataResponse$files": "The read set's files.
" } }, "ReadSetFilter": { "base": "A filter for read sets.
", "refs": { "ListReadSetsRequest$filter": "A filter to apply to the list.
" } }, "ReadSetId": { "base": null, "refs": { "ActivateReadSetSourceItem$readSetId": "The source's read set ID.
", "CompleteMultipartReadSetUploadResponse$readSetId": "The read set ID created for an uploaded read set.
", "ExportReadSet$readSetId": "The set's ID.
", "ExportReadSetDetail$id": "The set's ID.
", "GetReadSetMetadataRequest$id": "The read set's ID.
", "GetReadSetMetadataResponse$id": "The read set's ID.
", "GetReadSetRequest$id": "The read set's ID.
", "ImportReadSetSourceItem$readSetId": "The source's read set ID.
", "ReadSetBatchError$id": "The error's ID.
", "ReadSetIdList$member": null, "ReadSetListItem$id": "The read set's ID.
", "StartReadSetActivationJobSourceItem$readSetId": "The source's read set ID.
" } }, "ReadSetIdList": { "base": null, "refs": { "BatchDeleteReadSetRequest$ids": "The read sets' IDs.
" } }, "ReadSetImportJobItemStatus": { "base": null, "refs": { "ImportReadSetSourceItem$status": "The source's status.
" } }, "ReadSetImportJobStatus": { "base": null, "refs": { "GetReadSetImportJobResponse$status": "The job's status.
", "ImportReadSetFilter$status": "A status to filter on.
", "ImportReadSetJobItem$status": "The job's status.
", "StartReadSetImportJobResponse$status": "The job's status.
" } }, "ReadSetList": { "base": null, "refs": { "ListReadSetsResponse$readSets": "A list of read sets.
" } }, "ReadSetListItem": { "base": "A read set.
", "refs": { "ReadSetList$member": null } }, "ReadSetName": { "base": null, "refs": { "CreateMultipartReadSetUploadRequest$name": "The name of the read set.
", "CreateMultipartReadSetUploadResponse$name": "The name of the read set.
", "GetReadSetMetadataResponse$name": "The read set's name.
", "ImportReadSetSourceItem$name": "The source's name.
", "MultipartReadSetUploadListItem$name": "The name of a read set.
", "ReadSetFilter$name": "A name to filter on.
", "ReadSetListItem$name": "The read set's name.
", "StartReadSetImportJobSourceItem$name": "The source's name.
" } }, "ReadSetPartSource": { "base": null, "refs": { "CompleteReadSetUploadPartListItem$partSource": "The source file of the part being uploaded.
", "ListReadSetUploadPartsRequest$partSource": "The source file for the upload part.
", "ReadSetUploadPartListItem$partSource": "The origin of the part being direct uploaded.
", "UploadReadSetPartRequest$partSource": "The source file for an upload part.
" } }, "ReadSetPartStreamingBlob": { "base": null, "refs": { "UploadReadSetPartRequest$payload": "The read set data to upload for a part.
" } }, "ReadSetS3Access": { "base": "The S3 URI for each read set file.
", "refs": { "FileInformation$s3Access": "The S3 URI metadata of a sequence store.
" } }, "ReadSetStatus": { "base": null, "refs": { "GetReadSetMetadataResponse$status": "The read set's status.
", "ReadSetFilter$status": "A status to filter on.
", "ReadSetListItem$status": "The read set's status.
" } }, "ReadSetStatusMessage": { "base": null, "refs": { "GetReadSetMetadataResponse$statusMessage": "The status message for a read set. It provides more detail as to why the read set has a status.
", "ReadSetListItem$statusMessage": "The status for a read set. It provides more detail as to why the read set has a status.
" } }, "ReadSetStreamingBlob": { "base": null, "refs": { "GetReadSetResponse$payload": "The read set file payload.
" } }, "ReadSetUploadPartList": { "base": null, "refs": { "ListReadSetUploadPartsResponse$parts": "An array of upload parts.
" } }, "ReadSetUploadPartListFilter": { "base": "Filter settings that select for read set upload parts of interest.
", "refs": { "ListReadSetUploadPartsRequest$filter": "Attributes used to filter for a specific subset of read set part uploads.
" } }, "ReadSetUploadPartListItem": { "base": "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.
", "refs": { "ReadSetUploadPartList$member": null } }, "ReadSetUploadPartListItemPartNumberInteger": { "base": null, "refs": { "ReadSetUploadPartListItem$partNumber": "The number identifying the part in an upload.
" } }, "ReadSetUploadPartListItemPartSizeLong": { "base": null, "refs": { "ReadSetUploadPartListItem$partSize": "The size of the the part in an upload.
" } }, "ReadmeMarkdown": { "base": null, "refs": { "CreateWorkflowRequest$readmeMarkdown": "The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
", "CreateWorkflowVersionRequest$readmeMarkdown": "The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.
", "UpdateWorkflowRequest$readmeMarkdown": "The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
", "UpdateWorkflowVersionRequest$readmeMarkdown": "The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.
" } }, "ReadmePath": { "base": null, "refs": { "CreateWorkflowRequest$readmePath": "The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
The README content for the workflow, providing documentation and usage information.
", "GetWorkflowVersionResponse$readme": "The README content for the workflow version, providing documentation and usage information specific to this version.
" } }, "ReferenceArn": { "base": null, "refs": { "CreateMultipartReadSetUploadRequest$referenceArn": "The ARN of the reference.
", "CreateMultipartReadSetUploadResponse$referenceArn": "The read set source's reference ARN.
", "GetReadSetMetadataResponse$referenceArn": "The read set's genome reference ARN.
", "GetReferenceMetadataResponse$arn": "The reference's ARN.
", "ImportReadSetSourceItem$referenceArn": "The source's genome reference ARN.
", "MultipartReadSetUploadListItem$referenceArn": "The source's reference ARN.
", "ReadSetListItem$referenceArn": "The read set's genome reference ARN.
", "ReferenceItem$referenceArn": "The reference's ARN.
", "ReferenceListItem$arn": "The reference's ARN.
", "StartReadSetImportJobSourceItem$referenceArn": "The source's reference ARN.
" } }, "ReferenceArnFilter": { "base": null, "refs": { "ReadSetFilter$referenceArn": "A genome reference ARN to filter on.
" } }, "ReferenceCreationType": { "base": null, "refs": { "GetReferenceMetadataResponse$creationType": "The reference's creation type.
" } }, "ReferenceDescription": { "base": null, "refs": { "GetReferenceMetadataResponse$description": "The reference's description.
", "ImportReferenceSourceItem$description": "The source's description.
", "ReferenceListItem$description": "The reference's description.
", "StartReferenceImportJobSourceItem$description": "The source's description.
" } }, "ReferenceFile": { "base": null, "refs": { "GetReferenceRequest$file": "The file to retrieve.
" } }, "ReferenceFiles": { "base": "A set of genome reference files.
", "refs": { "GetReferenceMetadataResponse$files": "The reference's files.
" } }, "ReferenceFilter": { "base": "A filter for references.
", "refs": { "ListReferencesRequest$filter": "A filter to apply to the list.
" } }, "ReferenceId": { "base": null, "refs": { "DeleteReferenceRequest$id": "The reference's ID.
", "GetReferenceMetadataRequest$id": "The reference's ID.
", "GetReferenceMetadataResponse$id": "The reference's ID.
", "GetReferenceRequest$id": "The reference's ID.
", "ImportReferenceSourceItem$referenceId": "The source's reference ID.
", "ReferenceListItem$id": "The reference's ID.
" } }, "ReferenceImportJobItemStatus": { "base": null, "refs": { "ImportReferenceSourceItem$status": "The source's status.
" } }, "ReferenceImportJobStatus": { "base": null, "refs": { "GetReferenceImportJobResponse$status": "The job's status.
", "ImportReferenceFilter$status": "A status to filter on.
", "ImportReferenceJobItem$status": "The job's status.
", "StartReferenceImportJobResponse$status": "The job's status.
" } }, "ReferenceItem": { "base": "A genome reference.
", "refs": { "AnnotationStoreItem$reference": "The store's genome reference.
", "CreateAnnotationStoreRequest$reference": "The genome reference for the store's annotations.
", "CreateAnnotationStoreResponse$reference": "The store's genome reference. Required for all stores except TSV format with generic annotations.
", "CreateVariantStoreRequest$reference": "The genome reference for the store's variants.
", "CreateVariantStoreResponse$reference": "The store's genome reference.
", "GetAnnotationStoreResponse$reference": "The store's genome reference.
", "GetVariantStoreResponse$reference": "The store's genome reference.
", "UpdateAnnotationStoreResponse$reference": "The store's genome reference.
", "UpdateVariantStoreResponse$reference": "The store's genome reference.
", "VariantStoreItem$reference": "The store's genome reference.
" } }, "ReferenceList": { "base": null, "refs": { "ListReferencesResponse$references": "A list of references.
" } }, "ReferenceListItem": { "base": "A genome reference.
", "refs": { "ReferenceList$member": null } }, "ReferenceName": { "base": null, "refs": { "GetReferenceMetadataResponse$name": "The reference's name.
", "ImportReferenceSourceItem$name": "The source's name.
", "ReferenceFilter$name": "A name to filter on.
", "ReferenceListItem$name": "The reference's name.
", "StartReferenceImportJobSourceItem$name": "The source's name.
" } }, "ReferenceStatus": { "base": null, "refs": { "GetReferenceMetadataResponse$status": "The reference's status.
", "ReferenceListItem$status": "The reference's status.
" } }, "ReferenceStoreArn": { "base": null, "refs": { "CreateReferenceStoreResponse$arn": "The store's ARN.
", "GetReferenceStoreResponse$arn": "The store's ARN.
", "ReferenceStoreDetail$arn": "The store's ARN.
" } }, "ReferenceStoreDescription": { "base": null, "refs": { "CreateReferenceStoreRequest$description": "A description for the store.
", "CreateReferenceStoreResponse$description": "The store's description.
", "GetReferenceStoreResponse$description": "The store's description.
", "ReferenceStoreDetail$description": "The store's description.
" } }, "ReferenceStoreDetail": { "base": "Details about a reference store.
", "refs": { "ReferenceStoreDetailList$member": null } }, "ReferenceStoreDetailList": { "base": null, "refs": { "ListReferenceStoresResponse$referenceStores": "A list of reference stores.
" } }, "ReferenceStoreFilter": { "base": "A filter for reference stores.
", "refs": { "ListReferenceStoresRequest$filter": "A filter to apply to the list.
" } }, "ReferenceStoreId": { "base": null, "refs": { "CreateReferenceStoreResponse$id": "The store's ID.
", "DeleteReferenceRequest$referenceStoreId": "The reference's store ID.
", "DeleteReferenceStoreRequest$id": "The store's ID.
", "GetReferenceImportJobRequest$referenceStoreId": "The job's reference store ID.
", "GetReferenceImportJobResponse$referenceStoreId": "The job's reference store ID.
", "GetReferenceMetadataRequest$referenceStoreId": "The reference's reference store ID.
", "GetReferenceMetadataResponse$referenceStoreId": "The reference's reference store ID.
", "GetReferenceRequest$referenceStoreId": "The reference's store ID.
", "GetReferenceStoreRequest$id": "The store's ID.
", "GetReferenceStoreResponse$id": "The store's ID.
", "ImportReferenceJobItem$referenceStoreId": "The job's reference store ID.
", "ListReferenceImportJobsRequest$referenceStoreId": "The job's reference store ID.
", "ListReferencesRequest$referenceStoreId": "The references' reference store ID.
", "ReferenceListItem$referenceStoreId": "The reference's store ID.
", "ReferenceStoreDetail$id": "The store's ID.
", "StartReferenceImportJobRequest$referenceStoreId": "The job's reference store ID.
", "StartReferenceImportJobResponse$referenceStoreId": "The job's reference store ID.
" } }, "ReferenceStoreName": { "base": null, "refs": { "CreateReferenceStoreRequest$name": "A name for the store.
", "CreateReferenceStoreResponse$name": "The store's name.
", "GetReferenceStoreResponse$name": "The store's name.
", "ReferenceStoreDetail$name": "The store's name.
", "ReferenceStoreFilter$name": "The name to filter on.
" } }, "ReferenceStreamingBlob": { "base": null, "refs": { "GetReferenceResponse$payload": "The reference file payload.
" } }, "RegistryMapping": { "base": "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.
", "refs": { "RegistryMappingsList$member": null } }, "RegistryMappingsList": { "base": null, "refs": { "ContainerRegistryMap$registryMappings": "Mapping that provides the ECR repository path where upstream container images are pulled and synchronized.
" } }, "RequestTimeoutException": { "base": "The request timed out.
", "refs": { } }, "ResourceId": { "base": null, "refs": { "AnnotationStoreItem$id": "The store's ID.
", "AnnotationStoreVersionItem$storeId": "The store ID for an annotation store version.
", "AnnotationStoreVersionItem$id": "The annotation store version ID.
", "CancelAnnotationImportRequest$jobId": "The job's ID.
", "CancelVariantImportRequest$jobId": "The job's ID.
", "CreateAnnotationStoreResponse$id": "The store's ID.
", "CreateAnnotationStoreVersionResponse$id": "A generated ID for the annotation store
", "CreateAnnotationStoreVersionResponse$storeId": "The ID for the annotation store from which new versions are being created.
", "CreateVariantStoreResponse$id": "The store's ID.
", "GetAnnotationImportRequest$jobId": "The job's ID.
", "GetAnnotationImportResponse$id": "The job's ID.
", "GetAnnotationStoreResponse$id": "The store's ID.
", "GetAnnotationStoreVersionResponse$storeId": "The store ID for annotation store version.
", "GetAnnotationStoreVersionResponse$id": "The annotation store version ID.
", "GetVariantImportRequest$jobId": "The job's ID.
", "GetVariantImportResponse$id": "The job's ID.
", "GetVariantStoreResponse$id": "The store's ID.
", "StartAnnotationImportResponse$jobId": "The job's ID.
", "StartVariantImportResponse$jobId": "The job's ID.
", "UpdateAnnotationStoreResponse$id": "The store's ID.
", "UpdateAnnotationStoreVersionResponse$storeId": "The annotation store ID.
", "UpdateAnnotationStoreVersionResponse$id": "The annotation store version ID.
", "UpdateVariantStoreResponse$id": "The store's ID.
", "VariantStoreItem$id": "The store's ID.
" } }, "ResourceIdentifier": { "base": null, "refs": { "ListAnnotationImportJobsRequestIdsList$member": null, "ListAnnotationStoresRequestIdsList$member": null, "ListVariantImportJobsRequestIdsList$member": null, "ListVariantStoresRequestIdsList$member": null } }, "ResourceNotFoundException": { "base": "The target resource was not found in the current Region.
", "refs": { } }, "ResourceOwner": { "base": null, "refs": { "ListSharesRequest$resourceOwner": "The account that owns the resource shares.
" } }, "RoleArn": { "base": null, "refs": { "GetReadSetImportJobResponse$roleArn": "The job's service role ARN.
", "GetReferenceImportJobResponse$roleArn": "The job's service role ARN.
", "ImportReadSetJobItem$roleArn": "The job's service role ARN.
", "ImportReferenceJobItem$roleArn": "The job's service role ARN.
", "StartReadSetExportJobRequest$roleArn": "A service role for the job.
", "StartReadSetImportJobRequest$roleArn": "A service role for the job.
", "StartReadSetImportJobResponse$roleArn": "The job's service role ARN.
", "StartReferenceImportJobRequest$roleArn": "A service role for the job.
", "StartReferenceImportJobResponse$roleArn": "The job's service role ARN.
" } }, "RunArn": { "base": null, "refs": { "GetRunResponse$arn": "The run's ARN.
", "RunListItem$arn": "The run's ARN.
", "StartRunResponse$arn": "Unique resource identifier for the run.
" } }, "RunCacheArn": { "base": null, "refs": { "CreateRunCacheResponse$arn": "Unique resource identifier for the run cache.
", "GetRunCacheResponse$arn": "Unique resource identifier for the run cache.
", "RunCacheListItem$arn": "Unique resource identifier for the run cache.
" } }, "RunCacheId": { "base": null, "refs": { "CreateRunCacheResponse$id": "Identifier for the run cache.
", "DeleteRunCacheRequest$id": "Run cache identifier for the cache you want to delete.
", "GetRunCacheRequest$id": "The identifier of the run cache to retrieve.
", "GetRunCacheResponse$id": "The run cache ID.
", "RunCacheListItem$id": "The identifier for this run cache.
", "UpdateRunCacheRequest$id": "The identifier of the run cache you want to update.
" } }, "RunCacheList": { "base": null, "refs": { "ListRunCachesResponse$items": "Details about each run cache in the response.
" } }, "RunCacheListItem": { "base": "List entry for one run cache.
", "refs": { "RunCacheList$member": null } }, "RunCacheRequestId": { "base": null, "refs": { "CreateRunCacheRequest$requestId": "A unique request token, to ensure idempotency. If you don't specify a token, Amazon Web Services HealthOmics automatically generates a universally unique identifier (UUID) for the request.
" } }, "RunCacheStatus": { "base": null, "refs": { "CreateRunCacheResponse$status": "Run cache status.
", "GetRunCacheResponse$status": "The run cache status.
", "RunCacheListItem$status": "The run cache status.
" } }, "RunCacheTimestamp": { "base": null, "refs": { "GetRunCacheResponse$creationTime": "Creation time of the run cache (an ISO 8601 formatted string).
", "RunCacheListItem$creationTime": "The time that this run cache was created (an ISO 8601 formatted string).
" } }, "RunExport": { "base": null, "refs": { "RunExportList$member": null } }, "RunExportList": { "base": null, "refs": { "GetRunRequest$export": "The run's export format.
" } }, "RunFailureReason": { "base": null, "refs": { "GetRunResponse$failureReason": "The reason a run has failed.
" } }, "RunGroupArn": { "base": null, "refs": { "CreateRunGroupResponse$arn": "The group's ARN.
", "GetRunGroupResponse$arn": "The group's ARN.
", "RunGroupListItem$arn": "The group's ARN.
" } }, "RunGroupId": { "base": null, "refs": { "CreateRunGroupResponse$id": "The group's ID.
", "DeleteRunGroupRequest$id": "The run group's ID.
", "GetRunGroupRequest$id": "The group's ID.
", "GetRunGroupResponse$id": "The group's ID.
", "GetRunResponse$runGroupId": "The run's group ID.
", "ListRunsRequest$runGroupId": "Filter the list by run group ID.
", "RunGroupListItem$id": "The group's ID.
", "StartRunRequest$runGroupId": "The run's group ID. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.
", "UpdateRunGroupRequest$id": "The group's ID.
" } }, "RunGroupList": { "base": null, "refs": { "ListRunGroupsResponse$items": "A list of groups.
" } }, "RunGroupListItem": { "base": "A run group.
", "refs": { "RunGroupList$member": null } }, "RunGroupListItemMaxCpusInteger": { "base": null, "refs": { "RunGroupListItem$maxCpus": "The group's maximum CPU count setting.
" } }, "RunGroupListItemMaxDurationInteger": { "base": null, "refs": { "RunGroupListItem$maxDuration": "The group's maximum duration setting in minutes.
" } }, "RunGroupListItemMaxGpusInteger": { "base": null, "refs": { "RunGroupListItem$maxGpus": "The maximum GPUs that can be used by a run group.
" } }, "RunGroupListItemMaxRunsInteger": { "base": null, "refs": { "RunGroupListItem$maxRuns": "The group's maximum concurrent run setting.
" } }, "RunGroupListToken": { "base": null, "refs": { "ListRunGroupsRequest$startingToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListRunGroupsResponse$nextToken": "A pagination token that's included if more results are available.
" } }, "RunGroupName": { "base": null, "refs": { "CreateRunGroupRequest$name": "A name for the group.
", "GetRunGroupResponse$name": "The group's name.
", "ListRunGroupsRequest$name": "The run groups' name.
", "RunGroupListItem$name": "The group's name.
", "UpdateRunGroupRequest$name": "A name for the group.
" } }, "RunGroupRequestId": { "base": null, "refs": { "CreateRunGroupRequest$requestId": "To ensure that requests don't run multiple times, specify a unique ID for each request.
" } }, "RunGroupTimestamp": { "base": null, "refs": { "GetRunGroupResponse$creationTime": "When the group was created.
", "RunGroupListItem$creationTime": "When the group was created.
" } }, "RunId": { "base": null, "refs": { "CancelRunRequest$id": "The run's ID.
", "DeleteRunRequest$id": "The run's ID.
", "GetRunRequest$id": "The run's ID.
", "GetRunResponse$id": "The run's ID.
", "GetRunResponse$runId": "The run's ID.
", "GetRunTaskRequest$id": "The workflow run ID.
", "ListRunTasksRequest$id": "The run's ID.
", "RunListItem$id": "The run's ID.
", "StartRunRequest$runId": "The ID of a run to duplicate.
", "StartRunResponse$id": "The run's ID.
" } }, "RunLeftNormalization": { "base": null, "refs": { "AnnotationImportJobItem$runLeftNormalization": "The job's left normalization setting.
", "GetAnnotationImportResponse$runLeftNormalization": "The job's left normalization setting.
", "GetVariantImportResponse$runLeftNormalization": "The job's left normalization setting.
", "StartAnnotationImportRequest$runLeftNormalization": "The job's left normalization setting.
", "StartVariantImportRequest$runLeftNormalization": "The job's left normalization setting.
", "VariantImportJobItem$runLeftNormalization": "The job's left normalization setting.
" } }, "RunList": { "base": null, "refs": { "ListRunsResponse$items": "A list of runs.
" } }, "RunListItem": { "base": "A workflow run.
", "refs": { "RunList$member": null } }, "RunListItemPriorityInteger": { "base": null, "refs": { "RunListItem$priority": "The run's priority.
" } }, "RunListItemStorageCapacityInteger": { "base": null, "refs": { "RunListItem$storageCapacity": "The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
" } }, "RunListToken": { "base": null, "refs": { "ListRunsRequest$startingToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListRunsResponse$nextToken": "A pagination token that's included if more results are available.
" } }, "RunLogLevel": { "base": null, "refs": { "GetRunResponse$logLevel": "The run's log level.
", "StartRunRequest$logLevel": "A log level for the run.
" } }, "RunLogLocation": { "base": "The URI for the run log.
", "refs": { "GetRunResponse$logLocation": "The location of the run log.
" } }, "RunLogStream": { "base": null, "refs": { "RunLogLocation$runLogStream": "The log stream ARN for the run log.
" } }, "RunName": { "base": null, "refs": { "GetRunResponse$name": "The run's name.
", "ListRunsRequest$name": "Filter the list by run name.
", "RunListItem$name": "The run's name.
", "StartRunRequest$name": "A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.
" } }, "RunOutputUri": { "base": null, "refs": { "GetRunResponse$outputUri": "The run's output URI.
", "GetRunResponse$runOutputUri": "The destination for workflow outputs.
", "StartRunRequest$outputUri": "An output S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.
", "StartRunResponse$runOutputUri": "The destination for workflow outputs.
" } }, "RunParameters": { "base": null, "refs": { "GetRunResponse$parameters": "The run's parameters.
", "StartRunRequest$parameters": "Parameters for the run. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.
" } }, "RunRequestId": { "base": null, "refs": { "StartRunRequest$requestId": "An idempotency token used to dedupe retry requests so that duplicate runs are not created.
" } }, "RunResourceDigest": { "base": null, "refs": { "RunResourceDigests$value": null } }, "RunResourceDigestKey": { "base": null, "refs": { "RunResourceDigests$key": null } }, "RunResourceDigests": { "base": null, "refs": { "GetRunResponse$resourceDigests": "The run's resource digests.
" } }, "RunRetentionMode": { "base": null, "refs": { "GetRunResponse$retentionMode": "The run's retention mode.
", "StartRunRequest$retentionMode": "The retention mode for the run. The default value is RETAIN.
Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.
For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.
" } }, "RunRoleArn": { "base": null, "refs": { "GetRunResponse$roleArn": "The run's service role ARN.
", "StartRunRequest$roleArn": "A service role for the run. The roleArn requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ. In this example, the AWS account ID is 123456789012 and the role name is omics-service-role-serviceRole-W8O1XMPL7QZ.
Who started the run.
" } }, "RunStatus": { "base": null, "refs": { "GetRunResponse$status": "The run's status.
", "ListRunsRequest$status": "The status of a run.
", "RunListItem$status": "The run's status.
", "StartRunResponse$status": "The run's status.
" } }, "RunStatusMessage": { "base": null, "refs": { "GetRunResponse$statusMessage": "The run's status message.
" } }, "RunTimestamp": { "base": null, "refs": { "GetRunResponse$creationTime": "When the run was created.
", "GetRunResponse$startTime": "When the run started.
", "GetRunResponse$stopTime": "The run's stop time.
", "RunListItem$creationTime": "When the run was created.
", "RunListItem$startTime": "When the run started.
", "RunListItem$stopTime": "When the run stopped.
" } }, "RunUuid": { "base": null, "refs": { "GetRunResponse$uuid": "The universally unique identifier for a run.
", "StartRunResponse$uuid": "The universally unique identifier for a run.
" } }, "S3AccessConfig": { "base": "S3 access configuration parameters.
", "refs": { "CreateSequenceStoreRequest$s3AccessConfig": "S3 access configuration parameters. This specifies the parameters needed to access logs stored in S3 buckets. The S3 bucket must be in the same region and account as the sequence store.
", "UpdateSequenceStoreRequest$s3AccessConfig": "S3 access configuration parameters.
" } }, "S3AccessPointArn": { "base": null, "refs": { "DeleteS3AccessPolicyRequest$s3AccessPointArn": "The S3 access point ARN that has the access policy.
", "GetS3AccessPolicyRequest$s3AccessPointArn": "The S3 access point ARN that has the access policy.
", "GetS3AccessPolicyResponse$s3AccessPointArn": "The S3 access point ARN that has the access policy.
", "PutS3AccessPolicyRequest$s3AccessPointArn": "The S3 access point ARN where you want to put the access policy.
", "PutS3AccessPolicyResponse$s3AccessPointArn": "The S3 access point ARN that now has the access policy.
", "SequenceStoreS3Access$s3AccessPointArn": "This is ARN of the access point associated with the S3 bucket storing read sets.
" } }, "S3AccessPolicy": { "base": null, "refs": { "GetS3AccessPolicyResponse$s3AccessPolicy": "The current resource policy that controls S3 access on the store.
", "PutS3AccessPolicyRequest$s3AccessPolicy": "The resource policy that controls S3 access to the store.
" } }, "S3Destination": { "base": null, "refs": { "ExportReadSetJobDetail$destination": "The job's destination in Amazon S3.
", "GetReadSetExportJobResponse$destination": "The job's destination in Amazon S3.
", "StartReadSetExportJobRequest$destination": "A location for exported files in Amazon S3.
", "StartReadSetExportJobResponse$destination": "The job's output location.
" } }, "S3Uri": { "base": null, "refs": { "AnnotationImportItemDetail$source": "The source file's location in Amazon S3.
", "AnnotationImportItemSource$source": "The source file's location in Amazon S3.
", "ImportReferenceSourceItem$sourceFile": "The source file's location in Amazon S3.
", "ReadSetS3Access$s3Uri": "The S3 URI for each read set file.
", "SequenceStoreS3Access$s3Uri": "The S3 URI of the sequence store.
", "SourceFiles$source1": "The location of the first file in Amazon S3.
", "SourceFiles$source2": "The location of the second file in Amazon S3.
", "StartReferenceImportJobSourceItem$sourceFile": "The source file's location in Amazon S3.
", "VariantImportItemDetail$source": "The source file's location in Amazon S3.
", "VariantImportItemSource$source": "The source file's location in Amazon S3.
" } }, "S3UriForBucketOrObject": { "base": "Uri to a S3 object or bucket
", "refs": { "CreateRunCacheRequest$cacheS3Location": "Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).
", "GetRunCacheResponse$cacheS3Uri": "The S3 URI where the cache data is stored.
", "GetRunTaskResponse$cacheS3Uri": "The S3 URI of the cache location.
", "RunCacheListItem$cacheS3Uri": "The S3 uri for the run cache data.
", "TaskListItem$cacheS3Uri": "The S3 URI of the cache location.
" } }, "S3UriForObject": { "base": null, "refs": { "CreateWorkflowRequest$readmeUri": "The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. Requirements include:
The S3 URI must begin with s3://USER-OWNED-BUCKET/
The requester must have access to the S3 bucket and object.
The max README content length is 500 KiB.
The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include:
The S3 URI must begin with s3://USER-OWNED-BUCKET/
The requester must have access to the S3 bucket and object.
The max README content length is 500 KiB.
The source's sample ID.
", "CreateMultipartReadSetUploadResponse$sampleId": "The source's sample ID.
", "GetReadSetMetadataResponse$sampleId": "The read set's sample ID.
", "ImportReadSetSourceItem$sampleId": "The source's sample ID.
", "MultipartReadSetUploadListItem$sampleId": "The read set source's sample ID.
", "ReadSetFilter$sampleId": "The read set source's sample ID.
", "ReadSetListItem$sampleId": "The read set's sample ID.
", "StartReadSetImportJobSourceItem$sampleId": "The source's sample ID.
" } }, "SchemaItem": { "base": null, "refs": { "TsvStoreOptionsSchemaList$member": null, "TsvVersionOptionsSchemaList$member": null } }, "SchemaItemKeyString": { "base": null, "refs": { "SchemaItem$key": null } }, "SchemaValueType": { "base": null, "refs": { "SchemaItem$value": null } }, "Separator": { "base": null, "refs": { "ReadOptions$sep": "The file's field separator.
" } }, "SequenceInformation": { "base": "Details about a sequence.
", "refs": { "GetReadSetMetadataResponse$sequenceInformation": "The read set's sequence information.
", "ReadSetListItem$sequenceInformation": null } }, "SequenceStoreArn": { "base": null, "refs": { "CreateSequenceStoreResponse$arn": "The store's ARN.
", "GetSequenceStoreResponse$arn": "The store's ARN.
", "SequenceStoreDetail$arn": "The store's ARN.
", "UpdateSequenceStoreResponse$arn": "The ARN of the sequence store.
" } }, "SequenceStoreDescription": { "base": null, "refs": { "CreateSequenceStoreRequest$description": "A description for the store.
", "CreateSequenceStoreResponse$description": "The store's description.
", "GetSequenceStoreResponse$description": "The store's description.
", "SequenceStoreDetail$description": "The store's description.
", "UpdateSequenceStoreRequest$description": "A description for the sequence store.
", "UpdateSequenceStoreResponse$description": "Description of the sequence store.
" } }, "SequenceStoreDetail": { "base": "Details about a sequence store.
", "refs": { "SequenceStoreDetailList$member": null } }, "SequenceStoreDetailList": { "base": null, "refs": { "ListSequenceStoresResponse$sequenceStores": "A list of sequence stores.
" } }, "SequenceStoreFilter": { "base": "A filter for a sequence store.
", "refs": { "ListSequenceStoresRequest$filter": "A filter to apply to the list.
" } }, "SequenceStoreId": { "base": null, "refs": { "AbortMultipartReadSetUploadRequest$sequenceStoreId": "The sequence store ID for the store involved in the multipart upload.
", "ActivateReadSetJobItem$sequenceStoreId": "The job's sequence store ID.
", "BatchDeleteReadSetRequest$sequenceStoreId": "The read sets' sequence store ID.
", "CompleteMultipartReadSetUploadRequest$sequenceStoreId": "The sequence store ID for the store involved in the multipart upload.
", "CreateMultipartReadSetUploadRequest$sequenceStoreId": "The sequence store ID for the store that is the destination of the multipart uploads.
", "CreateMultipartReadSetUploadResponse$sequenceStoreId": "The sequence store ID for the store that the read set will be created in.
", "CreateSequenceStoreResponse$id": "The store's ID.
", "DeleteSequenceStoreRequest$id": "The sequence store's ID.
", "ExportReadSetJobDetail$sequenceStoreId": "The job's sequence store ID.
", "GetReadSetActivationJobRequest$sequenceStoreId": "The job's sequence store ID.
", "GetReadSetActivationJobResponse$sequenceStoreId": "The job's sequence store ID.
", "GetReadSetExportJobRequest$sequenceStoreId": "The job's sequence store ID.
", "GetReadSetExportJobResponse$sequenceStoreId": "The job's sequence store ID.
", "GetReadSetImportJobRequest$sequenceStoreId": "The job's sequence store ID.
", "GetReadSetImportJobResponse$sequenceStoreId": "The job's sequence store ID.
", "GetReadSetMetadataRequest$sequenceStoreId": "The read set's sequence store ID.
", "GetReadSetMetadataResponse$sequenceStoreId": "The read set's sequence store ID.
", "GetReadSetRequest$sequenceStoreId": "The read set's sequence store ID.
", "GetSequenceStoreRequest$id": "The store's ID.
", "GetSequenceStoreResponse$id": "The store's ID.
", "ImportReadSetJobItem$sequenceStoreId": "The job's sequence store ID.
", "ListMultipartReadSetUploadsRequest$sequenceStoreId": "The Sequence Store ID used for the multipart uploads.
", "ListReadSetActivationJobsRequest$sequenceStoreId": "The read set's sequence store ID.
", "ListReadSetExportJobsRequest$sequenceStoreId": "The jobs' sequence store ID.
", "ListReadSetImportJobsRequest$sequenceStoreId": "The jobs' sequence store ID.
", "ListReadSetUploadPartsRequest$sequenceStoreId": "The Sequence Store ID used for the multipart uploads.
", "ListReadSetsRequest$sequenceStoreId": "The jobs' sequence store ID.
", "MultipartReadSetUploadListItem$sequenceStoreId": "The sequence store ID used for the multipart upload.
", "ReadSetListItem$sequenceStoreId": "The read set's sequence store ID.
", "SequenceStoreDetail$id": "The store's ID.
", "StartReadSetActivationJobRequest$sequenceStoreId": "The read set's sequence store ID.
", "StartReadSetActivationJobResponse$sequenceStoreId": "The read set's sequence store ID.
", "StartReadSetExportJobRequest$sequenceStoreId": "The read set's sequence store ID.
", "StartReadSetExportJobResponse$sequenceStoreId": "The read set's sequence store ID.
", "StartReadSetImportJobRequest$sequenceStoreId": "The read set's sequence store ID.
", "StartReadSetImportJobResponse$sequenceStoreId": "The read set's sequence store ID.
", "UpdateSequenceStoreRequest$id": "The ID of the sequence store.
", "UpdateSequenceStoreResponse$id": "The ID of the sequence store.
", "UploadReadSetPartRequest$sequenceStoreId": "The Sequence Store ID used for the multipart upload.
" } }, "SequenceStoreName": { "base": null, "refs": { "CreateSequenceStoreRequest$name": "A name for the store.
", "CreateSequenceStoreResponse$name": "The store's name.
", "GetSequenceStoreResponse$name": "The store's name.
", "SequenceStoreDetail$name": "The store's name.
", "SequenceStoreFilter$name": "A name to filter on.
", "UpdateSequenceStoreRequest$name": "A name for the sequence store.
", "UpdateSequenceStoreResponse$name": "The name of the sequence store.
" } }, "SequenceStoreS3Access": { "base": "The S3 access metadata of the sequence store.
", "refs": { "CreateSequenceStoreResponse$s3Access": null, "GetSequenceStoreResponse$s3Access": "The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.
", "UpdateSequenceStoreResponse$s3Access": null } }, "SequenceStoreStatus": { "base": null, "refs": { "CreateSequenceStoreResponse$status": "The status of the sequence store.
", "GetSequenceStoreResponse$status": "The status of the sequence store.
", "SequenceStoreDetail$status": "Status of the sequence store.
", "SequenceStoreFilter$status": "Filter results based on status.
", "UpdateSequenceStoreResponse$status": "The status of the sequence store.
" } }, "SequenceStoreStatusMessage": { "base": null, "refs": { "CreateSequenceStoreResponse$statusMessage": "The status message of the sequence store.
", "GetSequenceStoreResponse$statusMessage": "The status message of the sequence store.
", "SequenceStoreDetail$statusMessage": "The status message of the sequence store.
", "UpdateSequenceStoreResponse$statusMessage": "The status message of the sequence store.
" } }, "ServiceQuotaExceededException": { "base": "The request exceeds a service quota.
", "refs": { } }, "ShareDetails": { "base": "The details of a resource share.
", "refs": { "GetShareResponse$share": "A resource share details object. The object includes the status, the resourceArn, and ownerId.
", "ShareDetailsList$member": null } }, "ShareDetailsList": { "base": null, "refs": { "ListSharesResponse$shares": "The shares available and their metadata details.
" } }, "ShareName": { "base": null, "refs": { "CreateShareRequest$shareName": "A name that the owner defines for the share.
", "CreateShareResponse$shareName": "The name of the share.
", "ShareDetails$shareName": "The name of the resource share.
" } }, "ShareResourceType": { "base": null, "refs": { "TypeList$member": null } }, "ShareStatus": { "base": null, "refs": { "AcceptShareResponse$status": "The status of the resource share.
", "CreateShareResponse$status": "The status of the share.
", "DeleteShareResponse$status": "The status of the share being deleted.
", "ShareDetails$status": "The status of the share.
", "StatusList$member": null } }, "SourceFiles": { "base": "Source files for a sequence.
", "refs": { "ImportReadSetSourceItem$sourceFiles": "The source files' location in Amazon S3.
", "StartReadSetImportJobSourceItem$sourceFiles": "The source files' location in Amazon S3.
" } }, "SourceReference": { "base": "Contains information about the source reference in a code repository, such as a branch, tag, or commit.
", "refs": { "DefinitionRepository$sourceReference": "The source reference for the repository, such as a branch name, tag, or commit ID.
", "DefinitionRepositoryDetails$sourceReference": "The source reference for the repository, such as a branch name, tag, or commit ID.
" } }, "SourceReferenceType": { "base": null, "refs": { "SourceReference$type": "The type of source reference, such as branch, tag, or commit.
" } }, "SourceReferenceValue": { "base": null, "refs": { "SourceReference$value": "The value of the source reference, such as the branch name, tag name, or commit ID.
" } }, "SseConfig": { "base": "Server-side encryption (SSE) settings for a store.
", "refs": { "AnnotationStoreItem$sseConfig": "The store's server-side encryption (SSE) settings.
", "CreateAnnotationStoreRequest$sseConfig": "Server-side encryption (SSE) settings for the store.
", "CreateReferenceStoreRequest$sseConfig": "Server-side encryption (SSE) settings for the store.
", "CreateReferenceStoreResponse$sseConfig": "The store's SSE settings.
", "CreateSequenceStoreRequest$sseConfig": "Server-side encryption (SSE) settings for the store.
", "CreateSequenceStoreResponse$sseConfig": "Server-side encryption (SSE) settings for the store. This contains the KMS key ARN that is used to encrypt read set objects.
", "CreateVariantStoreRequest$sseConfig": "Server-side encryption (SSE) settings for the store.
", "GetAnnotationStoreResponse$sseConfig": "The store's server-side encryption (SSE) settings.
", "GetReferenceStoreResponse$sseConfig": "The store's server-side encryption (SSE) settings.
", "GetSequenceStoreResponse$sseConfig": "The store's server-side encryption (SSE) settings.
", "GetVariantStoreResponse$sseConfig": "The store's server-side encryption (SSE) settings.
", "ReferenceStoreDetail$sseConfig": "The store's server-side encryption (SSE) settings.
", "SequenceStoreDetail$sseConfig": "The store's server-side encryption (SSE) settings.
", "UpdateSequenceStoreResponse$sseConfig": null, "VariantStoreItem$sseConfig": "The store's server-side encryption (SSE) settings.
" } }, "SseConfigKeyArnString": { "base": null, "refs": { "SseConfig$keyArn": "An encryption key ARN.
" } }, "StartAnnotationImportRequest": { "base": null, "refs": { } }, "StartAnnotationImportResponse": { "base": null, "refs": { } }, "StartReadSetActivationJobRequest": { "base": null, "refs": { } }, "StartReadSetActivationJobRequestSourcesList": { "base": null, "refs": { "StartReadSetActivationJobRequest$sources": "The job's source files.
" } }, "StartReadSetActivationJobResponse": { "base": null, "refs": { } }, "StartReadSetActivationJobSourceItem": { "base": "A source for a read set activation job.
", "refs": { "StartReadSetActivationJobRequestSourcesList$member": null } }, "StartReadSetExportJobRequest": { "base": null, "refs": { } }, "StartReadSetExportJobRequestSourcesList": { "base": null, "refs": { "StartReadSetExportJobRequest$sources": "The job's source files.
" } }, "StartReadSetExportJobResponse": { "base": null, "refs": { } }, "StartReadSetImportJobRequest": { "base": null, "refs": { } }, "StartReadSetImportJobRequestSourcesList": { "base": null, "refs": { "StartReadSetImportJobRequest$sources": "The job's source files.
" } }, "StartReadSetImportJobResponse": { "base": null, "refs": { } }, "StartReadSetImportJobSourceItem": { "base": "A source for a read set import job.
", "refs": { "StartReadSetImportJobRequestSourcesList$member": null } }, "StartReferenceImportJobRequest": { "base": null, "refs": { } }, "StartReferenceImportJobRequestSourcesList": { "base": null, "refs": { "StartReferenceImportJobRequest$sources": "The job's source files.
" } }, "StartReferenceImportJobResponse": { "base": null, "refs": { } }, "StartReferenceImportJobSourceItem": { "base": "A source for a reference import job.
", "refs": { "StartReferenceImportJobRequestSourcesList$member": null } }, "StartRunRequest": { "base": null, "refs": { } }, "StartRunRequestPriorityInteger": { "base": null, "refs": { "StartRunRequest$priority": "Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see Run priority in the Amazon Web Services HealthOmics User Guide.
" } }, "StartRunRequestStorageCapacityInteger": { "base": null, "refs": { "StartRunRequest$storageCapacity": "The STATIC storage capacity (in gibibytes, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. This field is not required if the storage type is DYNAMIC (the system ignores any value that you enter).
Filter based on the resource status. You can specify up to 10 values.
" } }, "StatusMessage": { "base": null, "refs": { "AnnotationStoreItem$statusMessage": "The store's status message.
", "AnnotationStoreVersionItem$statusMessage": "The status of an annotation store version.
", "GetAnnotationStoreResponse$statusMessage": "A status message.
", "GetAnnotationStoreVersionResponse$statusMessage": "The status of an annotation store version.
", "GetVariantStoreResponse$statusMessage": "The store's status message.
", "ShareDetails$statusMessage": "The status message for a resource share. It provides additional details about the share status.
", "VariantStoreItem$statusMessage": "The store's status message.
" } }, "StorageType": { "base": null, "refs": { "CreateWorkflowRequest$storageType": "The default storage type for runs that use this workflow. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see Run storage types in the Amazon Web Services HealthOmics User Guide.
The default storage type for runs that use this workflow version. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see Run storage types in the Amazon Web Services HealthOmics User Guide.
The run's storage type.
", "GetWorkflowResponse$storageType": "The default storage type for runs using this workflow.
", "GetWorkflowVersionResponse$storageType": "The default storage type for the run.
", "RunListItem$storageType": "The run's storage type.
", "StartRunRequest$storageType": "The storage type for the run. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the Amazon Web Services HealthOmics User Guide.
The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.
", "UpdateWorkflowVersionRequest$storageType": "The default storage type for runs that use this workflow version. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see Run storage types in the in the Amazon Web Services HealthOmics User Guide .
The store's file format.
", "CreateAnnotationStoreRequest$storeFormat": "The annotation file format of the store.
", "CreateAnnotationStoreResponse$storeFormat": "The annotation file format of the store.
", "GetAnnotationStoreResponse$storeFormat": "The store's annotation file format.
", "UpdateAnnotationStoreResponse$storeFormat": "The annotation file format of the store.
" } }, "StoreId": { "base": null, "refs": { "GetS3AccessPolicyResponse$storeId": "The Amazon Web Services-generated Sequence Store or Reference Store ID.
", "PutS3AccessPolicyResponse$storeId": "The Amazon Web Services-generated Sequence Store or Reference Store ID.
" } }, "StoreName": { "base": null, "refs": { "AnnotationStoreVersionItem$name": "A name given to an annotation store version to distinguish it from others.
", "CreateAnnotationStoreRequest$name": "A name for the store.
", "CreateAnnotationStoreVersionRequest$name": "The name of an annotation store version from which versions are being created.
", "CreateAnnotationStoreVersionResponse$name": "The name given to an annotation store version to distinguish it from other versions.
", "CreateVariantStoreRequest$name": "A name for the store.
", "GetAnnotationImportResponse$destinationName": "The job's destination annotation store.
", "GetAnnotationStoreVersionResponse$name": "The name of the annotation store.
", "GetVariantImportResponse$destinationName": "The job's destination variant store.
", "StartAnnotationImportRequest$destinationName": "A destination annotation store for the job.
", "StartVariantImportRequest$destinationName": "The destination variant store for the job.
", "UpdateAnnotationStoreVersionResponse$name": "The name of an annotation store.
" } }, "StoreOptions": { "base": "Settings for a store.
", "refs": { "CreateAnnotationStoreRequest$storeOptions": "File parsing options for the annotation store.
", "CreateAnnotationStoreResponse$storeOptions": "The store's file parsing options.
", "GetAnnotationStoreResponse$storeOptions": "The store's parsing options.
", "UpdateAnnotationStoreResponse$storeOptions": "Parsing options for the store.
" } }, "StoreStatus": { "base": null, "refs": { "AnnotationStoreItem$status": "The store's status.
", "CreateAnnotationStoreResponse$status": "The store's status.
", "CreateVariantStoreResponse$status": "The store's status.
", "DeleteAnnotationStoreResponse$status": "The store's status.
", "DeleteVariantStoreResponse$status": "The store's status.
", "GetAnnotationStoreResponse$status": "The store's status.
", "GetVariantStoreResponse$status": "The store's status.
", "ListAnnotationStoresFilter$status": "A status to filter on.
", "ListVariantStoresFilter$status": "A status to filter on.
", "UpdateAnnotationStoreResponse$status": "The store's status.
", "UpdateVariantStoreResponse$status": "The store's status.
", "VariantStoreItem$status": "The store's status.
" } }, "StoreType": { "base": null, "refs": { "GetS3AccessPolicyResponse$storeType": "The type of store associated with the access point.
", "PutS3AccessPolicyResponse$storeType": "The type of store associated with the access point.
" } }, "String": { "base": null, "refs": { "AcceptShareRequest$shareId": "The ID of the resource share.
", "AccessDeniedException$message": null, "AnnotationImportJobItem$id": "The job's ID.
", "AnnotationImportJobItem$destinationName": "The job's destination annotation store.
", "AnnotationStoreItem$name": "The store's name.
", "ArnList$member": null, "ConflictException$message": null, "CreateAnnotationStoreResponse$name": "The store's name.
", "CreateShareRequest$resourceArn": "The ARN of the resource to be shared.
", "CreateShareRequest$principalSubscriber": "The principal subscriber is the account being offered shared access to the resource.
", "CreateShareResponse$shareId": "The ID that HealthOmics generates for the share.
", "CreateVariantStoreResponse$name": "The store's name.
", "DefinitionRepositoryDetails$providerType": "The provider type of the source code repository, such as Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, and GitLabSelfManaged.
", "DefinitionRepositoryDetails$providerEndpoint": "The endpoint URL of the source code repository provider.
", "DeleteAnnotationStoreRequest$name": "The store's name.
", "DeleteAnnotationStoreVersionsRequest$name": "The name of the annotation store from which versions are being deleted.
", "DeleteShareRequest$shareId": "The ID for the resource share to be deleted.
", "DeleteVariantStoreRequest$name": "The store's name.
", "ETag$source1": "The ETag hash calculated on Source1 of the read set.
", "ETag$source2": "The ETag hash calculated on Source2 of the read set.
", "ExcludeFilePatternList$member": null, "GetAnnotationStoreRequest$name": "The store's name.
", "GetAnnotationStoreResponse$name": "The store's name.
", "GetAnnotationStoreVersionRequest$name": "The name given to an annotation store version to distinguish it from others.
", "GetAnnotationStoreVersionRequest$versionName": "The name given to an annotation store version to distinguish it from others.
", "GetShareRequest$shareId": "The ID of the share.
", "GetVariantStoreRequest$name": "The store's name.
", "GetVariantStoreResponse$name": "The store's name.
", "InternalServerException$message": null, "ListAnnotationImportJobsFilter$storeName": "A store name to filter on.
", "ListAnnotationImportJobsResponse$nextToken": "Specifies the pagination token from a previous request to retrieve the next page of results.
", "ListAnnotationStoreVersionsRequest$name": "The name of an annotation store.
", "ListAnnotationStoreVersionsResponse$nextToken": "Specifies the pagination token from a previous request to retrieve the next page of results.
", "ListAnnotationStoresResponse$nextToken": "A pagination token that's included if more results are available.
", "ListSharesRequest$nextToken": "Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.
", "ListSharesResponse$nextToken": "Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.
", "ListVariantImportJobsFilter$storeName": "A store name to filter on.
", "ListVariantImportJobsResponse$nextToken": "A pagination token that's included if more results are available.
", "ListVariantStoresResponse$nextToken": "A pagination token that's included if more results are available.
", "NotSupportedOperationException$message": null, "RangeNotSatisfiableException$message": null, "ReadSetBatchError$code": "The error's code.
", "ReadSetBatchError$message": "The error's message.
", "ReadSetUploadPartListItem$checksum": "A unique identifier used to confirm that parts are being added to the correct upload.
", "RequestTimeoutException$message": null, "ResourceNotFoundException$message": null, "SequenceInformation$alignment": "The sequence's alignment setting.
", "ServiceQuotaExceededException$message": null, "ShareDetails$shareId": "The ID of the resource share.
", "ShareDetails$resourceArn": "The Arn of the shared resource.
", "ShareDetails$resourceId": "The ID of the shared resource.
", "ShareDetails$principalSubscriber": "The principal subscriber is the account that is sharing the resource.
", "ShareDetails$ownerId": "The account ID for the data owner. The owner creates the resource share.
", "ThrottlingException$message": null, "UpdateAnnotationStoreRequest$name": "A name for the store.
", "UpdateAnnotationStoreResponse$name": "The store's name.
", "UpdateAnnotationStoreVersionRequest$name": "The name of an annotation store.
", "UpdateAnnotationStoreVersionRequest$versionName": "The name of an annotation store version.
", "UpdateVariantStoreRequest$name": "A name for the store.
", "UpdateVariantStoreResponse$name": "The store's name.
", "UploadReadSetPartResponse$checksum": "An identifier used to confirm that parts are being added to the intended upload.
", "ValidationException$message": null, "VariantImportJobItem$id": "The job's ID.
", "VariantImportJobItem$destinationName": "The job's destination variant store.
", "VariantStoreItem$name": "The store's name.
", "VersionDeleteError$message": "The message explaining the error in annotation store deletion.
" } }, "SubjectId": { "base": null, "refs": { "CreateMultipartReadSetUploadRequest$subjectId": "The source's subject ID.
", "CreateMultipartReadSetUploadResponse$subjectId": "The source's subject ID.
", "GetReadSetMetadataResponse$subjectId": "The read set's subject ID.
", "ImportReadSetSourceItem$subjectId": "The source's subject ID.
", "MultipartReadSetUploadListItem$subjectId": "The read set source's subject ID.
", "ReadSetFilter$subjectId": "The read set source's subject ID.
", "ReadSetListItem$subjectId": "The read set's subject ID.
", "StartReadSetImportJobSourceItem$subjectId": "The source's subject ID.
" } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "ActivateReadSetFilter$createdAfter": "The filter's start date.
", "ActivateReadSetFilter$createdBefore": "The filter's end date.
", "ActivateReadSetJobItem$creationTime": "When the job was created.
", "ActivateReadSetJobItem$completionTime": "When the job completed.
", "CreateMultipartReadSetUploadResponse$creationTime": "The creation time of the multipart upload.
", "CreateReferenceStoreResponse$creationTime": "When the store was created.
", "CreateSequenceStoreResponse$creationTime": "When the store was created.
", "ExportReadSetFilter$createdAfter": "The filter's start date.
", "ExportReadSetFilter$createdBefore": "The filter's end date.
", "ExportReadSetJobDetail$creationTime": "When the job was created.
", "ExportReadSetJobDetail$completionTime": "When the job completed.
", "GetReadSetActivationJobResponse$creationTime": "When the job was created.
", "GetReadSetActivationJobResponse$completionTime": "When the job completed.
", "GetReadSetExportJobResponse$creationTime": "When the job was created.
", "GetReadSetExportJobResponse$completionTime": "When the job completed.
", "GetReadSetImportJobResponse$creationTime": "When the job was created.
", "GetReadSetImportJobResponse$completionTime": "When the job completed.
", "GetReadSetMetadataResponse$creationTime": "When the read set was created.
", "GetReferenceImportJobResponse$creationTime": "When the job was created.
", "GetReferenceImportJobResponse$completionTime": "When the job completed.
", "GetReferenceMetadataResponse$creationTime": "When the reference was created.
", "GetReferenceMetadataResponse$updateTime": "When the reference was updated.
", "GetReferenceStoreResponse$creationTime": "When the store was created.
", "GetS3AccessPolicyResponse$updateTime": "The time when the policy was last updated.
", "GetSequenceStoreResponse$creationTime": "When the store was created.
", "GetSequenceStoreResponse$updateTime": "The last-updated time of the sequence store.
", "ImportReadSetFilter$createdAfter": "The filter's start date.
", "ImportReadSetFilter$createdBefore": "The filter's end date.
", "ImportReadSetJobItem$creationTime": "When the job was created.
", "ImportReadSetJobItem$completionTime": "When the job completed.
", "ImportReferenceFilter$createdAfter": "The filter's start date.
", "ImportReferenceFilter$createdBefore": "The filter's end date.
", "ImportReferenceJobItem$creationTime": "When the job was created.
", "ImportReferenceJobItem$completionTime": "When the job completed.
", "MultipartReadSetUploadListItem$creationTime": "The time stamp for when a direct upload was created.
", "ReadSetFilter$createdAfter": "The filter's start date.
", "ReadSetFilter$createdBefore": "The filter's end date.
", "ReadSetListItem$creationTime": "When the read set was created.
", "ReadSetUploadPartListFilter$createdAfter": "Filters for read set uploads after a specified time.
", "ReadSetUploadPartListFilter$createdBefore": "Filters for read set part uploads before a specified time.
", "ReadSetUploadPartListItem$creationTime": "The time stamp for when a direct upload was created.
", "ReadSetUploadPartListItem$lastUpdatedTime": "The time stamp for the most recent update to an uploaded part.
", "ReferenceFilter$createdAfter": "The filter's start date.
", "ReferenceFilter$createdBefore": "The filter's end date.
", "ReferenceListItem$creationTime": "When the reference was created.
", "ReferenceListItem$updateTime": "When the reference was updated.
", "ReferenceStoreDetail$creationTime": "When the store was created.
", "ReferenceStoreFilter$createdAfter": "The filter's start date.
", "ReferenceStoreFilter$createdBefore": "The filter's end date.
", "SequenceStoreDetail$creationTime": "When the store was created.
", "SequenceStoreDetail$updateTime": "The last-updated time of the Sequence Store.
", "SequenceStoreFilter$createdAfter": "The filter's start date.
", "SequenceStoreFilter$createdBefore": "The filter's end date.
", "SequenceStoreFilter$updatedAfter": "Filter results based on stores updated after the specified time.
", "SequenceStoreFilter$updatedBefore": "Filter results based on stores updated before the specified time.
", "StartReadSetActivationJobResponse$creationTime": "When the job was created.
", "StartReadSetExportJobResponse$creationTime": "When the job was created.
", "StartReadSetImportJobResponse$creationTime": "When the job was created.
", "StartReferenceImportJobResponse$creationTime": "When the job was created.
", "UpdateSequenceStoreResponse$creationTime": "The time when the store was created.
", "UpdateSequenceStoreResponse$updateTime": "The last-updated time of the Sequence Store.
" } }, "TagArn": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The resource's ARN.
", "TagResourceRequest$resourceArn": "The resource's ARN.
", "UntagResourceRequest$resourceArn": "The resource's ARN.
" } }, "TagKey": { "base": null, "refs": { "PropagatedSetLevelTags$member": null, "TagKeyList$member": null, "TagMap$key": null, "TagResourceRequestTagsMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "Keys of tags to remove.
" } }, "TagMap": { "base": null, "refs": { "CreateAnnotationStoreRequest$tags": "Tags for the store.
", "CreateAnnotationStoreVersionRequest$tags": "Any tags added to annotation store version.
", "CreateMultipartReadSetUploadRequest$tags": "Any tags to add to the read set.
", "CreateMultipartReadSetUploadResponse$tags": "The tags to add to the read set.
", "CreateReferenceStoreRequest$tags": "Tags for the store.
", "CreateRunCacheRequest$tags": "Specify one or more tags to associate with this run cache.
", "CreateRunCacheResponse$tags": "The tags associated with this run cache.
", "CreateRunGroupRequest$tags": "Tags for the group.
", "CreateRunGroupResponse$tags": "Tags for the run group.
", "CreateSequenceStoreRequest$tags": "Tags for the store. You can configure up to 50 tags.
", "CreateVariantStoreRequest$tags": "Tags for the store.
", "CreateWorkflowRequest$tags": "Tags for the workflow. You can define up to 50 tags for the workflow. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.
", "CreateWorkflowResponse$tags": "The workflow's tags.
", "CreateWorkflowVersionRequest$tags": "Tags for this workflow version. You can define up to 50 tags for the workflow. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.
", "CreateWorkflowVersionResponse$tags": "The workflow version's tags.
", "GetAnnotationStoreResponse$tags": "The store's tags.
", "GetAnnotationStoreVersionResponse$tags": "Any tags associated with an annotation store version.
", "GetRunCacheResponse$tags": "The tags associated with the run cache.
", "GetRunGroupResponse$tags": "The group's tags.
", "GetRunResponse$tags": "The run's tags.
", "GetVariantStoreResponse$tags": "The store's tags.
", "GetWorkflowResponse$tags": "The workflow's tags.
", "GetWorkflowVersionResponse$tags": "The workflow version tags
", "ImportReadSetSourceItem$tags": "The source's tags.
", "ImportReferenceSourceItem$tags": "The source's tags.
", "ListTagsForResourceResponse$tags": "A list of tags.
", "MultipartReadSetUploadListItem$tags": "Any tags you wish to add to a read set.
", "StartReadSetImportJobSourceItem$tags": "The source's tags.
", "StartReferenceImportJobSourceItem$tags": "The source's tags.
", "StartRunRequest$tags": "Tags for the run. You can add up to 50 tags per run. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.
", "StartRunResponse$tags": "The run's tags.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceRequestTagsMap": { "base": null, "refs": { "TagResourceRequest$tags": "Tags for the resource.
" } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": null, "TagResourceRequestTagsMap$value": null } }, "TaskFailureReason": { "base": null, "refs": { "GetRunTaskResponse$failureReason": "The reason a task has failed.
" } }, "TaskId": { "base": null, "refs": { "GetRunTaskRequest$taskId": "The task's ID.
", "GetRunTaskResponse$taskId": "The task's ID.
", "TaskListItem$taskId": "The task's ID.
" } }, "TaskImageDigest": { "base": null, "refs": { "ImageDetails$imageDigest": "The container image digest. If the image URI was transformed, this will be the digest of the container image referenced by the transformed URI.
" } }, "TaskInstanceType": { "base": null, "refs": { "GetRunTaskResponse$instanceType": "The instance type for a task.
", "TaskListItem$instanceType": "The instance type for a task.
" } }, "TaskList": { "base": null, "refs": { "ListRunTasksResponse$items": "A list of tasks.
" } }, "TaskListItem": { "base": "A workflow run task.
", "refs": { "TaskList$member": null } }, "TaskListItemCpusInteger": { "base": null, "refs": { "TaskListItem$cpus": "The task's CPU count.
" } }, "TaskListItemGpusInteger": { "base": null, "refs": { "TaskListItem$gpus": "The number of Graphics Processing Units (GPU) specified for the task.
" } }, "TaskListItemMemoryInteger": { "base": null, "refs": { "TaskListItem$memory": "The task's memory use in gigabyes.
" } }, "TaskListToken": { "base": null, "refs": { "ListRunTasksRequest$startingToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListRunTasksResponse$nextToken": "A pagination token that's included if more results are available.
" } }, "TaskLogStream": { "base": null, "refs": { "GetRunTaskResponse$logStream": "The task's log stream.
" } }, "TaskName": { "base": null, "refs": { "GetRunTaskResponse$name": "The task's name.
", "TaskListItem$name": "The task's name.
" } }, "TaskStatus": { "base": null, "refs": { "GetRunTaskResponse$status": "The task's status.
", "ListRunTasksRequest$status": "Filter the list by status.
", "TaskListItem$status": "The task's status.
" } }, "TaskStatusMessage": { "base": null, "refs": { "GetRunTaskResponse$statusMessage": "The task's status message.
" } }, "TaskTimestamp": { "base": null, "refs": { "GetRunTaskResponse$creationTime": "When the task was created.
", "GetRunTaskResponse$startTime": "The task's start time.
", "GetRunTaskResponse$stopTime": "The task's stop time.
", "TaskListItem$creationTime": "When the task was created.
", "TaskListItem$startTime": "When the task started.
", "TaskListItem$stopTime": "When the task stopped.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": { } }, "TsvOptions": { "base": "Formatting options for a TSV file.
", "refs": { "FormatOptions$tsvOptions": "Options for a TSV file.
" } }, "TsvStoreOptions": { "base": "File settings for a TSV store.
", "refs": { "StoreOptions$tsvStoreOptions": "File settings for a TSV store.
" } }, "TsvStoreOptionsSchemaList": { "base": null, "refs": { "TsvStoreOptions$schema": "The store's schema.
" } }, "TsvVersionOptions": { "base": "The options for a TSV file.
", "refs": { "VersionOptions$tsvVersionOptions": "File settings for a version of a TSV store.
" } }, "TsvVersionOptionsSchemaList": { "base": null, "refs": { "TsvVersionOptions$schema": "The TSV schema for an annotation store version.
" } }, "TypeList": { "base": null, "refs": { "Filter$type": "The type of resources to be filtered. You can specify one or more of the resource types.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAnnotationStoreRequest": { "base": null, "refs": { } }, "UpdateAnnotationStoreResponse": { "base": null, "refs": { } }, "UpdateAnnotationStoreVersionRequest": { "base": null, "refs": { } }, "UpdateAnnotationStoreVersionResponse": { "base": null, "refs": { } }, "UpdateRunCacheRequest": { "base": null, "refs": { } }, "UpdateRunGroupRequest": { "base": null, "refs": { } }, "UpdateRunGroupRequestMaxCpusInteger": { "base": null, "refs": { "UpdateRunGroupRequest$maxCpus": "The maximum number of CPUs to use.
" } }, "UpdateRunGroupRequestMaxDurationInteger": { "base": null, "refs": { "UpdateRunGroupRequest$maxDuration": "A maximum run time for the group in minutes.
" } }, "UpdateRunGroupRequestMaxGpusInteger": { "base": null, "refs": { "UpdateRunGroupRequest$maxGpus": "The maximum GPUs that can be used by a run group.
" } }, "UpdateRunGroupRequestMaxRunsInteger": { "base": null, "refs": { "UpdateRunGroupRequest$maxRuns": "The maximum number of concurrent runs for the group.
" } }, "UpdateSequenceStoreRequest": { "base": null, "refs": { } }, "UpdateSequenceStoreResponse": { "base": null, "refs": { } }, "UpdateTime": { "base": null, "refs": { "AnnotationImportJobItem$updateTime": "When the job was updated.
", "AnnotationStoreItem$updateTime": "When the store was updated.
", "AnnotationStoreVersionItem$updateTime": "The time stamp for when an annotation store version was updated.
", "GetAnnotationImportResponse$updateTime": "When the job was updated.
", "GetAnnotationStoreResponse$updateTime": "When the store was updated.
", "GetAnnotationStoreVersionResponse$updateTime": "The time stamp for when an annotation store version was updated.
", "GetVariantImportResponse$updateTime": "When the job was updated.
", "GetVariantStoreResponse$updateTime": "When the store was updated.
", "ShareDetails$updateTime": "The timestamp of the resource share update.
", "UpdateAnnotationStoreResponse$updateTime": "When the store was updated.
", "UpdateAnnotationStoreVersionResponse$updateTime": "The time stamp for when an annotation store version was updated.
", "UpdateVariantStoreResponse$updateTime": "When the store was updated.
", "VariantImportJobItem$updateTime": "When the job was updated.
", "VariantStoreItem$updateTime": "When the store was updated.
" } }, "UpdateVariantStoreRequest": { "base": null, "refs": { } }, "UpdateVariantStoreResponse": { "base": null, "refs": { } }, "UpdateWorkflowRequest": { "base": null, "refs": { } }, "UpdateWorkflowRequestStorageCapacityInteger": { "base": null, "refs": { "UpdateWorkflowRequest$storageCapacity": "The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
" } }, "UpdateWorkflowVersionRequest": { "base": null, "refs": { } }, "UpdateWorkflowVersionRequestStorageCapacityInteger": { "base": null, "refs": { "UpdateWorkflowVersionRequest$storageCapacity": "The default static storage capacity (in gibibytes) for runs that use this workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.
The ID for the multipart upload.
", "CompleteMultipartReadSetUploadRequest$uploadId": "The ID for the multipart upload.
", "CreateMultipartReadSetUploadResponse$uploadId": "The ID for the initiated multipart upload.
", "ListReadSetUploadPartsRequest$uploadId": "The ID for the initiated multipart upload.
", "MultipartReadSetUploadListItem$uploadId": "The ID for the initiated multipart upload.
", "UploadReadSetPartRequest$uploadId": "The ID for the initiated multipart upload.
" } }, "UploadReadSetPartRequest": { "base": null, "refs": { } }, "UploadReadSetPartRequestPartNumberInteger": { "base": null, "refs": { "UploadReadSetPartRequest$partNumber": "The number of the part being uploaded.
" } }, "UploadReadSetPartResponse": { "base": null, "refs": { } }, "UpstreamRepositoryPrefix": { "base": null, "refs": { "RegistryMapping$upstreamRepositoryPrefix": "The repository prefix of the corresponding repository in the upstream registry.
" } }, "Uri": { "base": null, "refs": { "CreateWorkflowRequest$containerRegistryMapUri": "(Optional) URI of the S3 location for the registry mapping file.
", "CreateWorkflowVersionRequest$containerRegistryMapUri": "(Optional) URI of the S3 location for the registry mapping file.
", "ImageDetails$image": "The URI of the container image.
", "ImageDetails$sourceImage": "URI of the source registry. If the URI is from a third-party registry, Amazon Web Services HealthOmics transforms the URI to the corresponding ECR path, using the pull-through cache mapping rules.
", "ImageMapping$sourceImage": "Specifies the URI of the source image in the upstream registry.
", "ImageMapping$destinationImage": "Specifies the URI of the corresponding image in the private ECR registry.
", "RegistryMapping$upstreamRegistryUrl": "The URI of the upstream registry.
" } }, "UserCustomDescription": { "base": null, "refs": { "CreateRunCacheRequest$description": "Enter a description of the run cache.
", "GetRunCacheResponse$description": "The run cache description.
", "UpdateRunCacheRequest$description": "Update the run cache description.
" } }, "UserCustomName": { "base": null, "refs": { "CreateRunCacheRequest$name": "Enter a user-friendly name for the run cache.
", "GetRunCacheResponse$name": "The run cache name.
", "RunCacheListItem$name": "The name of the run cache.
", "UpdateRunCacheRequest$name": "Update the name of the run cache.
" } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an AWS service.
", "refs": { } }, "VariantImportItemDetail": { "base": "Details about an imported variant item.
", "refs": { "VariantImportItemDetails$member": null } }, "VariantImportItemDetails": { "base": null, "refs": { "GetVariantImportResponse$items": "The job's items.
" } }, "VariantImportItemSource": { "base": "A imported variant item's source.
", "refs": { "VariantImportItemSources$member": null } }, "VariantImportItemSources": { "base": null, "refs": { "StartVariantImportRequest$items": "Items to import.
" } }, "VariantImportJobItem": { "base": "A variant import job.
", "refs": { "VariantImportJobItems$member": null } }, "VariantImportJobItems": { "base": null, "refs": { "ListVariantImportJobsResponse$variantImportJobs": "A list of jobs.
" } }, "VariantStoreItem": { "base": "A variant store.
", "refs": { "VariantStoreItems$member": null } }, "VariantStoreItems": { "base": null, "refs": { "ListVariantStoresResponse$variantStores": "A list of variant stores.
" } }, "VcfOptions": { "base": "Formatting options for a VCF file.
", "refs": { "FormatOptions$vcfOptions": "Options for a VCF file.
" } }, "VersionDeleteError": { "base": "The error preventing deletion of the annotation store version.
", "refs": { "VersionDeleteErrorList$member": null } }, "VersionDeleteErrorList": { "base": null, "refs": { "DeleteAnnotationStoreVersionsResponse$errors": "Any errors that occur when attempting to delete an annotation store version.
" } }, "VersionList": { "base": null, "refs": { "DeleteAnnotationStoreVersionsRequest$versions": "The versions of an annotation store to be deleted.
" } }, "VersionName": { "base": null, "refs": { "AnnotationImportJobItem$versionName": "The name of the annotation store version.
", "AnnotationStoreVersionItem$versionName": "The name of an annotation store version.
", "CreateAnnotationStoreRequest$versionName": "The name given to an annotation store version to distinguish it from other versions.
", "CreateAnnotationStoreResponse$versionName": "The name given to an annotation store version to distinguish it from other versions.
", "CreateAnnotationStoreVersionRequest$versionName": "The name given to an annotation store version to distinguish it from other versions.
", "CreateAnnotationStoreVersionResponse$versionName": "The name given to an annotation store version to distinguish it from other versions.
", "GetAnnotationImportResponse$versionName": "The name of the annotation store version.
", "GetAnnotationStoreVersionResponse$versionName": "The name given to an annotation store version to distinguish it from others.
", "StartAnnotationImportRequest$versionName": "The name of the annotation store version.
", "UpdateAnnotationStoreVersionResponse$versionName": "The name of an annotation store version.
", "VersionDeleteError$versionName": "The name given to an annotation store version.
", "VersionList$member": null } }, "VersionOptions": { "base": "The options for an annotation store version.
", "refs": { "CreateAnnotationStoreVersionRequest$versionOptions": "The options for an annotation store version.
", "CreateAnnotationStoreVersionResponse$versionOptions": "The options for an annotation store version.
", "GetAnnotationStoreVersionResponse$versionOptions": "The options for an annotation store version.
" } }, "VersionStatus": { "base": null, "refs": { "AnnotationStoreVersionItem$status": "The status of an annotation store version.
", "CreateAnnotationStoreVersionResponse$status": "The status of a annotation store version.
", "GetAnnotationStoreVersionResponse$status": "The status of an annotation store version.
", "ListAnnotationStoreVersionsFilter$status": "The status of an annotation store version.
", "UpdateAnnotationStoreVersionResponse$status": "The status of an annotation store version.
" } }, "WorkflowArn": { "base": null, "refs": { "CreateWorkflowResponse$arn": "The workflow's ARN.
", "GetWorkflowResponse$arn": "The workflow's ARN.
", "WorkflowListItem$arn": "The workflow's ARN.
" } }, "WorkflowBucketOwnerId": { "base": null, "refs": { "CreateWorkflowRequest$workflowBucketOwnerId": "The Amazon Web Services account ID of the expected owner of the S3 bucket that contains the workflow definition. If not specified, the service skips the validation.
", "CreateWorkflowVersionRequest$workflowBucketOwnerId": "Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.
", "GetWorkflowVersionResponse$workflowBucketOwnerId": "Amazon Web Services Id of the owner of the bucket.
" } }, "WorkflowDefinition": { "base": null, "refs": { "CreateWorkflowRequest$definitionUri": "The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.
", "CreateWorkflowVersionRequest$definitionUri": "The S3 URI of a definition for this workflow version. The S3 bucket must be in the same region as this workflow version.
", "GetRunResponse$definition": "The run's definition.
", "GetWorkflowResponse$definition": "The workflow's definition.
", "GetWorkflowVersionResponse$definition": "Definition of the workflow version.
" } }, "WorkflowDescription": { "base": null, "refs": { "CreateWorkflowRequest$description": "A description for the workflow.
", "GetWorkflowResponse$description": "The workflow's description.
", "UpdateWorkflowRequest$description": "A description for the workflow.
" } }, "WorkflowDigest": { "base": null, "refs": { "GetRunResponse$digest": "The run's digest.
", "GetWorkflowResponse$digest": "The workflow's digest.
", "GetWorkflowVersionResponse$digest": "The workflow version's digest.
", "WorkflowListItem$digest": "The workflow's digest.
", "WorkflowVersionListItem$digest": "The digist of the workflow version.
" } }, "WorkflowEngine": { "base": null, "refs": { "CreateWorkflowRequest$engine": "The workflow engine for the workflow. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.
", "CreateWorkflowVersionRequest$engine": "The workflow engine for this workflow version. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.
", "GetWorkflowResponse$engine": "The workflow's engine.
", "GetWorkflowVersionResponse$engine": "The workflow engine for this workflow version.
" } }, "WorkflowExport": { "base": null, "refs": { "WorkflowExportList$member": null } }, "WorkflowExportList": { "base": null, "refs": { "GetWorkflowRequest$export": "The export format for the workflow.
", "GetWorkflowVersionRequest$export": "The export format for the workflow.
" } }, "WorkflowId": { "base": null, "refs": { "CreateWorkflowResponse$id": "The workflow's ID.
", "CreateWorkflowVersionRequest$workflowId": "The ID of the workflow where you are creating the new version. The workflowId is not the UUID.
The workflow's ID.
", "DeleteWorkflowRequest$id": "The workflow's ID.
", "DeleteWorkflowVersionRequest$workflowId": "The workflow's ID.
", "GetRunResponse$workflowId": "The run's workflow ID.
", "GetWorkflowRequest$id": "The workflow's ID.
", "GetWorkflowResponse$id": "The workflow's ID.
", "GetWorkflowVersionRequest$workflowId": "The workflow's ID. The workflowId is not the UUID.
The workflow's ID.
", "ListWorkflowVersionsRequest$workflowId": "The workflow's ID. The workflowId is not the UUID.
The run's workflow ID.
", "StartRunRequest$workflowId": "The run's workflow ID. The workflowId is not the UUID.
The workflow's ID.
", "UpdateWorkflowVersionRequest$workflowId": "The workflow's ID. The workflowId is not the UUID.
The workflow's ID.
", "WorkflowVersionListItem$workflowId": "The workflow's ID.
" } }, "WorkflowList": { "base": null, "refs": { "ListWorkflowsResponse$items": "A list of workflow items.
" } }, "WorkflowListItem": { "base": "A workflow.
", "refs": { "WorkflowList$member": null } }, "WorkflowListToken": { "base": null, "refs": { "ListWorkflowsRequest$startingToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListWorkflowsResponse$nextToken": "A pagination token that's included if more results are available.
" } }, "WorkflowMain": { "base": null, "refs": { "CreateWorkflowRequest$main": "The path of the main definition file for the workflow. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: workflow-definition/main-file.wdl.
The path of the main definition file for this workflow version. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: workflow-definition/main-file.wdl.
The path of the main definition file for the workflow.
", "GetWorkflowVersionResponse$main": "The path of the main definition file for the workflow.
" } }, "WorkflowMetadata": { "base": null, "refs": { "GetWorkflowResponse$metadata": "Gets metadata for the workflow.
", "GetWorkflowVersionResponse$metadata": "The metadata for the workflow version.
", "WorkflowListItem$metadata": "Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return.
", "WorkflowVersionListItem$metadata": "Metadata for the workflow version.
" } }, "WorkflowMetadataKey": { "base": null, "refs": { "WorkflowMetadata$key": null } }, "WorkflowMetadataValue": { "base": null, "refs": { "WorkflowMetadata$value": null } }, "WorkflowName": { "base": null, "refs": { "CreateWorkflowRequest$name": "Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.
", "GetWorkflowResponse$name": "The workflow's name.
", "ListWorkflowsRequest$name": "Filter the list by workflow name.
", "UpdateWorkflowRequest$name": "A name for the workflow.
", "WorkflowListItem$name": "The workflow's name.
" } }, "WorkflowOwnerId": { "base": null, "refs": { "GetRunResponse$workflowOwnerId": "The ID of the workflow owner.
", "GetWorkflowRequest$workflowOwnerId": "The ID of the workflow owner.
", "GetWorkflowVersionRequest$workflowOwnerId": "The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.
The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.
The 12-digit account ID of the workflow owner that is used for running a shared workflow. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.
A workflow parameter.
", "refs": { "WorkflowParameterTemplate$value": null } }, "WorkflowParameterDescription": { "base": null, "refs": { "WorkflowParameter$description": "The parameter's description.
" } }, "WorkflowParameterName": { "base": null, "refs": { "WorkflowParameterTemplate$key": null } }, "WorkflowParameterTemplate": { "base": null, "refs": { "CreateWorkflowRequest$parameterTemplate": "A parameter template for the workflow. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see Parameter template files in the Amazon Web Services HealthOmics User Guide.
", "CreateWorkflowVersionRequest$parameterTemplate": "A parameter template for this workflow version. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see Parameter template files in the Amazon Web Services HealthOmics User Guide.
", "GetWorkflowResponse$parameterTemplate": "The workflow's parameter template.
", "GetWorkflowVersionResponse$parameterTemplate": "The parameter template for the workflow version.
" } }, "WorkflowRequestId": { "base": null, "refs": { "CreateWorkflowRequest$requestId": "An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.
", "CreateWorkflowVersionRequest$requestId": "An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.
" } }, "WorkflowStatus": { "base": null, "refs": { "CreateWorkflowResponse$status": "The workflow's status.
", "CreateWorkflowVersionResponse$status": "The workflow version status.
", "GetWorkflowResponse$status": "The workflow's status.
", "GetWorkflowVersionResponse$status": "The workflow version status
", "WorkflowListItem$status": "The workflow's status.
", "WorkflowVersionListItem$status": "The status of the workflow version.
" } }, "WorkflowStatusMessage": { "base": null, "refs": { "GetWorkflowResponse$statusMessage": "The workflow's status message.
", "GetWorkflowVersionResponse$statusMessage": "The workflow version status message
" } }, "WorkflowTimestamp": { "base": null, "refs": { "GetWorkflowResponse$creationTime": "When the workflow was created.
", "GetWorkflowVersionResponse$creationTime": "When the workflow version was created.
", "WorkflowListItem$creationTime": "When the workflow was created.
", "WorkflowVersionListItem$creationTime": "The creation time of the workflow version.
" } }, "WorkflowType": { "base": null, "refs": { "GetRunResponse$workflowType": "The run's workflow type.
", "GetWorkflowRequest$type": "The workflow's type.
", "GetWorkflowResponse$type": "The workflow's type.
", "GetWorkflowVersionRequest$type": "The workflow's type.
", "GetWorkflowVersionResponse$type": "The workflow version type
", "ListWorkflowVersionsRequest$type": "The workflow type.
", "ListWorkflowsRequest$type": "Filter the list by workflow type.
", "StartRunRequest$workflowType": "The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.
The workflow's type.
", "WorkflowVersionListItem$type": "The type of the workflow version.
" } }, "WorkflowUuid": { "base": null, "refs": { "CreateWorkflowResponse$uuid": "The universally unique identifier (UUID) value for this workflow.
", "CreateWorkflowVersionResponse$uuid": "The universally unique identifier (UUID) value for this workflow version.
", "GetRunResponse$workflowUuid": "The universally unique identifier (UUID) value for the workflow.
", "GetWorkflowResponse$uuid": "The universally unique identifier (UUID) value for this workflow.
", "GetWorkflowVersionResponse$uuid": "The universally unique identifier (UUID) value for this workflow version
" } }, "WorkflowVersionArn": { "base": null, "refs": { "CreateWorkflowVersionResponse$arn": "ARN of the workflow version.
", "GetWorkflowVersionResponse$arn": "ARN of the workflow version.
", "WorkflowVersionListItem$arn": "ARN of the workflow version.
" } }, "WorkflowVersionDescription": { "base": null, "refs": { "CreateWorkflowVersionRequest$description": "A description for this workflow version.
", "GetWorkflowVersionResponse$description": "Description of the workflow version.
", "UpdateWorkflowVersionRequest$description": "Description of the workflow version.
", "WorkflowVersionListItem$description": "The description of the workflow version.
" } }, "WorkflowVersionList": { "base": null, "refs": { "ListWorkflowVersionsResponse$items": "A list of workflow version items.
" } }, "WorkflowVersionListItem": { "base": "A list of workflow version items.
", "refs": { "WorkflowVersionList$member": null } }, "WorkflowVersionListToken": { "base": null, "refs": { "ListWorkflowVersionsRequest$startingToken": "Specify the pagination token from a previous request to retrieve the next page of results.
", "ListWorkflowVersionsResponse$nextToken": "A pagination token that's included if more results are available.
" } }, "WorkflowVersionName": { "base": null, "refs": { "CreateWorkflowVersionRequest$versionName": "A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.
The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.
", "CreateWorkflowVersionResponse$versionName": "The workflow version name.
", "DeleteWorkflowVersionRequest$versionName": "The workflow version name.
", "GetRunResponse$workflowVersionName": "The workflow version name.
", "GetWorkflowVersionRequest$versionName": "The workflow version name.
", "GetWorkflowVersionResponse$versionName": "The workflow version name.
", "RunListItem$workflowVersionName": "The name of the workflow version.
", "StartRunRequest$workflowVersionName": "The name of the workflow version. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see Workflow versioning in the Amazon Web Services HealthOmics User Guide.
", "UpdateWorkflowVersionRequest$versionName": "The name of the workflow version.
", "WorkflowVersionListItem$versionName": "The name of the workflow version.
" } } } }