# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AbortMultipartReadSetUpload](API_AbortMultipartReadSetUpload.md) 
+  [AcceptShare](API_AcceptShare.md) 
+  [BatchDeleteReadSet](API_BatchDeleteReadSet.md) 
+  [CancelAnnotationImportJob](API_CancelAnnotationImportJob.md) 
+  [CancelRun](API_CancelRun.md) 
+  [CancelRunBatch](API_CancelRunBatch.md) 
+  [CancelVariantImportJob](API_CancelVariantImportJob.md) 
+  [CompleteMultipartReadSetUpload](API_CompleteMultipartReadSetUpload.md) 
+  [CreateAnnotationStore](API_CreateAnnotationStore.md) 
+  [CreateAnnotationStoreVersion](API_CreateAnnotationStoreVersion.md) 
+  [CreateConfiguration](API_CreateConfiguration.md) 
+  [CreateMultipartReadSetUpload](API_CreateMultipartReadSetUpload.md) 
+  [CreateReferenceStore](API_CreateReferenceStore.md) 
+  [CreateRunCache](API_CreateRunCache.md) 
+  [CreateRunGroup](API_CreateRunGroup.md) 
+  [CreateSequenceStore](API_CreateSequenceStore.md) 
+  [CreateShare](API_CreateShare.md) 
+  [CreateVariantStore](API_CreateVariantStore.md) 
+  [CreateWorkflow](API_CreateWorkflow.md) 
+  [CreateWorkflowVersion](API_CreateWorkflowVersion.md) 
+  [DeleteAnnotationStore](API_DeleteAnnotationStore.md) 
+  [DeleteAnnotationStoreVersions](API_DeleteAnnotationStoreVersions.md) 
+  [DeleteBatch](API_DeleteBatch.md) 
+  [DeleteConfiguration](API_DeleteConfiguration.md) 
+  [DeleteReference](API_DeleteReference.md) 
+  [DeleteReferenceStore](API_DeleteReferenceStore.md) 
+  [DeleteRun](API_DeleteRun.md) 
+  [DeleteRunBatch](API_DeleteRunBatch.md) 
+  [DeleteRunCache](API_DeleteRunCache.md) 
+  [DeleteRunGroup](API_DeleteRunGroup.md) 
+  [DeleteS3AccessPolicy](API_DeleteS3AccessPolicy.md) 
+  [DeleteSequenceStore](API_DeleteSequenceStore.md) 
+  [DeleteShare](API_DeleteShare.md) 
+  [DeleteVariantStore](API_DeleteVariantStore.md) 
+  [DeleteWorkflow](API_DeleteWorkflow.md) 
+  [DeleteWorkflowVersion](API_DeleteWorkflowVersion.md) 
+  [GetAnnotationImportJob](API_GetAnnotationImportJob.md) 
+  [GetAnnotationStore](API_GetAnnotationStore.md) 
+  [GetAnnotationStoreVersion](API_GetAnnotationStoreVersion.md) 
+  [GetBatch](API_GetBatch.md) 
+  [GetConfiguration](API_GetConfiguration.md) 
+  [GetReadSet](API_GetReadSet.md) 
+  [GetReadSetActivationJob](API_GetReadSetActivationJob.md) 
+  [GetReadSetExportJob](API_GetReadSetExportJob.md) 
+  [GetReadSetImportJob](API_GetReadSetImportJob.md) 
+  [GetReadSetMetadata](API_GetReadSetMetadata.md) 
+  [GetReference](API_GetReference.md) 
+  [GetReferenceImportJob](API_GetReferenceImportJob.md) 
+  [GetReferenceMetadata](API_GetReferenceMetadata.md) 
+  [GetReferenceStore](API_GetReferenceStore.md) 
+  [GetRun](API_GetRun.md) 
+  [GetRunCache](API_GetRunCache.md) 
+  [GetRunGroup](API_GetRunGroup.md) 
+  [GetRunTask](API_GetRunTask.md) 
+  [GetS3AccessPolicy](API_GetS3AccessPolicy.md) 
+  [GetSequenceStore](API_GetSequenceStore.md) 
+  [GetShare](API_GetShare.md) 
+  [GetVariantImportJob](API_GetVariantImportJob.md) 
+  [GetVariantStore](API_GetVariantStore.md) 
+  [GetWorkflow](API_GetWorkflow.md) 
+  [GetWorkflowVersion](API_GetWorkflowVersion.md) 
+  [ListAnnotationImportJobs](API_ListAnnotationImportJobs.md) 
+  [ListAnnotationStores](API_ListAnnotationStores.md) 
+  [ListAnnotationStoreVersions](API_ListAnnotationStoreVersions.md) 
+  [ListBatch](API_ListBatch.md) 
+  [ListConfigurations](API_ListConfigurations.md) 
+  [ListMultipartReadSetUploads](API_ListMultipartReadSetUploads.md) 
+  [ListReadSetActivationJobs](API_ListReadSetActivationJobs.md) 
+  [ListReadSetExportJobs](API_ListReadSetExportJobs.md) 
+  [ListReadSetImportJobs](API_ListReadSetImportJobs.md) 
+  [ListReadSets](API_ListReadSets.md) 
+  [ListReadSetUploadParts](API_ListReadSetUploadParts.md) 
+  [ListReferenceImportJobs](API_ListReferenceImportJobs.md) 
+  [ListReferences](API_ListReferences.md) 
+  [ListReferenceStores](API_ListReferenceStores.md) 
+  [ListRunCaches](API_ListRunCaches.md) 
+  [ListRunGroups](API_ListRunGroups.md) 
+  [ListRuns](API_ListRuns.md) 
+  [ListRunsInBatch](API_ListRunsInBatch.md) 
+  [ListRunTasks](API_ListRunTasks.md) 
+  [ListSequenceStores](API_ListSequenceStores.md) 
+  [ListShares](API_ListShares.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListVariantImportJobs](API_ListVariantImportJobs.md) 
+  [ListVariantStores](API_ListVariantStores.md) 
+  [ListWorkflows](API_ListWorkflows.md) 
+  [ListWorkflowVersions](API_ListWorkflowVersions.md) 
+  [PutS3AccessPolicy](API_PutS3AccessPolicy.md) 
+  [StartAnnotationImportJob](API_StartAnnotationImportJob.md) 
+  [StartReadSetActivationJob](API_StartReadSetActivationJob.md) 
+  [StartReadSetExportJob](API_StartReadSetExportJob.md) 
+  [StartReadSetImportJob](API_StartReadSetImportJob.md) 
+  [StartReferenceImportJob](API_StartReferenceImportJob.md) 
+  [StartRun](API_StartRun.md) 
+  [StartRunBatch](API_StartRunBatch.md) 
+  [StartVariantImportJob](API_StartVariantImportJob.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAnnotationStore](API_UpdateAnnotationStore.md) 
+  [UpdateAnnotationStoreVersion](API_UpdateAnnotationStoreVersion.md) 
+  [UpdateRunCache](API_UpdateRunCache.md) 
+  [UpdateRunGroup](API_UpdateRunGroup.md) 
+  [UpdateSequenceStore](API_UpdateSequenceStore.md) 
+  [UpdateVariantStore](API_UpdateVariantStore.md) 
+  [UpdateWorkflow](API_UpdateWorkflow.md) 
+  [UpdateWorkflowVersion](API_UpdateWorkflowVersion.md) 
+  [UploadReadSetPart](API_UploadReadSetPart.md) 

# AbortMultipartReadSetUpload
<a name="API_AbortMultipartReadSetUpload"></a>

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.

## Request Syntax
<a name="API_AbortMultipartReadSetUpload_RequestSyntax"></a>

```
DELETE /sequencestore/sequenceStoreId/upload/uploadId/abort HTTP/1.1
```

## URI Request Parameters
<a name="API_AbortMultipartReadSetUpload_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sequenceStoreId](#API_AbortMultipartReadSetUpload_RequestSyntax) **   <a name="omics-AbortMultipartReadSetUpload-request-uri-sequenceStoreId"></a>
The sequence store ID for the store involved in the multipart upload.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [uploadId](#API_AbortMultipartReadSetUpload_RequestSyntax) **   <a name="omics-AbortMultipartReadSetUpload-request-uri-uploadId"></a>
The ID for the multipart upload.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_AbortMultipartReadSetUpload_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_AbortMultipartReadSetUpload_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AbortMultipartReadSetUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AbortMultipartReadSetUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_AbortMultipartReadSetUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/AbortMultipartReadSetUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/AbortMultipartReadSetUpload) 

# AcceptShare
<a name="API_AcceptShare"></a>

Accept a resource share request.

## Request Syntax
<a name="API_AcceptShare_RequestSyntax"></a>

```
POST /share/shareId HTTP/1.1
```

## URI Request Parameters
<a name="API_AcceptShare_RequestParameters"></a>

The request uses the following URI parameters.

 ** [shareId](#API_AcceptShare_RequestSyntax) **   <a name="omics-AcceptShare-request-uri-shareId"></a>
The ID of the resource share.  
Required: Yes

## Request Body
<a name="API_AcceptShare_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_AcceptShare_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "status": "string"
}
```

## Response Elements
<a name="API_AcceptShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [status](#API_AcceptShare_ResponseSyntax) **   <a name="omics-AcceptShare-response-status"></a>
The status of the resource share.  
Type: String  
Valid Values: `PENDING | ACTIVATING | ACTIVE | DELETING | DELETED | FAILED` 

## Errors
<a name="API_AcceptShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_AcceptShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/AcceptShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/AcceptShare) 

# BatchDeleteReadSet
<a name="API_BatchDeleteReadSet"></a>

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.

## Request Syntax
<a name="API_BatchDeleteReadSet_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/readset/batch/delete HTTP/1.1
Content-type: application/json

{
   "ids": [ "string" ]
}
```

## URI Request Parameters
<a name="API_BatchDeleteReadSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sequenceStoreId](#API_BatchDeleteReadSet_RequestSyntax) **   <a name="omics-BatchDeleteReadSet-request-uri-sequenceStoreId"></a>
The read sets' sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_BatchDeleteReadSet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ids](#API_BatchDeleteReadSet_RequestSyntax) **   <a name="omics-BatchDeleteReadSet-request-ids"></a>
The read sets' IDs.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BatchDeleteReadSet_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "code": "string",
         "id": "string",
         "message": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDeleteReadSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_BatchDeleteReadSet_ResponseSyntax) **   <a name="omics-BatchDeleteReadSet-response-errors"></a>
Errors returned by individual delete operations.  
Type: Array of [ReadSetBatchError](API_ReadSetBatchError.md) objects

## Errors
<a name="API_BatchDeleteReadSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_BatchDeleteReadSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/BatchDeleteReadSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/BatchDeleteReadSet) 

# CancelAnnotationImportJob
<a name="API_CancelAnnotationImportJob"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Cancels an annotation import job.

## Request Syntax
<a name="API_CancelAnnotationImportJob_RequestSyntax"></a>

```
DELETE /import/annotation/jobId HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelAnnotationImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobId](#API_CancelAnnotationImportJob_RequestSyntax) **   <a name="omics-CancelAnnotationImportJob-request-uri-jobId"></a>
The job's ID.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_CancelAnnotationImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelAnnotationImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CancelAnnotationImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CancelAnnotationImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CancelAnnotationImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CancelAnnotationImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CancelAnnotationImportJob) 

# CancelRun
<a name="API_CancelRun"></a>

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.

## Request Syntax
<a name="API_CancelRun_RequestSyntax"></a>

```
POST /run/id/cancel HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_CancelRun_RequestSyntax) **   <a name="omics-CancelRun-request-uri-id"></a>
The run's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_CancelRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelRun_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_CancelRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_CancelRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CancelRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CancelRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CancelRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CancelRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CancelRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CancelRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CancelRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CancelRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CancelRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CancelRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CancelRun) 

# CancelRunBatch
<a name="API_CancelRunBatch"></a>

Cancels all runs within a specified batch. This operation prevents not-yet-submitted runs from starting and submits `CancelRun` requests for runs that have already started.

Cancel is only allowed on batches in `PENDING`, `SUBMITTING`, or `INPROGRESS` state. Cancel operations are non-atomic and may be partially successful. Use `GetBatch` to review `successfulCancelSubmissionCount` and `failedCancelSubmissionCount` in the `submissionSummary`. Only one cancel or delete operation per batch is allowed at a time.

## Request Syntax
<a name="API_CancelRunBatch_RequestSyntax"></a>

```
POST /runBatch/cancel HTTP/1.1
Content-type: application/json

{
   "batchId": "string"
}
```

## URI Request Parameters
<a name="API_CancelRunBatch_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CancelRunBatch_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [batchId](#API_CancelRunBatch_RequestSyntax) **   <a name="omics-CancelRunBatch-request-batchId"></a>
The identifier portion of the run batch ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Response Syntax
<a name="API_CancelRunBatch_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_CancelRunBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_CancelRunBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CancelRunBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CancelRunBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CancelRunBatch) 

# CancelVariantImportJob
<a name="API_CancelVariantImportJob"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Cancels a variant import job.

## Request Syntax
<a name="API_CancelVariantImportJob_RequestSyntax"></a>

```
DELETE /import/variant/jobId HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelVariantImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobId](#API_CancelVariantImportJob_RequestSyntax) **   <a name="omics-CancelVariantImportJob-request-uri-jobId"></a>
The job's ID.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_CancelVariantImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelVariantImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CancelVariantImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CancelVariantImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CancelVariantImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CancelVariantImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CancelVariantImportJob) 

# CompleteMultipartReadSetUpload
<a name="API_CompleteMultipartReadSetUpload"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_CompleteMultipartReadSetUpload_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/upload/uploadId/complete HTTP/1.1
Content-type: application/json

{
   "parts": [ 
      { 
         "checksum": "string",
         "partNumber": number,
         "partSource": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CompleteMultipartReadSetUpload_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sequenceStoreId](#API_CompleteMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CompleteMultipartReadSetUpload-request-uri-sequenceStoreId"></a>
The sequence store ID for the store involved in the multipart upload.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [uploadId](#API_CompleteMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CompleteMultipartReadSetUpload-request-uri-uploadId"></a>
The ID for the multipart upload.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_CompleteMultipartReadSetUpload_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [parts](#API_CompleteMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CompleteMultipartReadSetUpload-request-parts"></a>
The individual uploads or parts of a multipart upload.  
Type: Array of [CompleteReadSetUploadPartListItem](API_CompleteReadSetUploadPartListItem.md) objects  
Required: Yes

## Response Syntax
<a name="API_CompleteMultipartReadSetUpload_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "readSetId": "string"
}
```

## Response Elements
<a name="API_CompleteMultipartReadSetUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [readSetId](#API_CompleteMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CompleteMultipartReadSetUpload-response-readSetId"></a>
The read set ID created for an uploaded read set.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

## Errors
<a name="API_CompleteMultipartReadSetUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CompleteMultipartReadSetUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CompleteMultipartReadSetUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CompleteMultipartReadSetUpload) 

# CreateAnnotationStore
<a name="API_CreateAnnotationStore"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Creates an annotation store.

## Request Syntax
<a name="API_CreateAnnotationStore_RequestSyntax"></a>

```
POST /annotationStore HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "reference": { ... },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "storeFormat": "string",
   "storeOptions": { ... },
   "tags": { 
      "string" : "string" 
   },
   "versionName": "string"
}
```

## URI Request Parameters
<a name="API_CreateAnnotationStore_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateAnnotationStore_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateAnnotationStore_RequestSyntax) **   <a name="omics-CreateAnnotationStore-request-description"></a>
A description for the store.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [name](#API_CreateAnnotationStore_RequestSyntax) **   <a name="omics-CreateAnnotationStore-request-name"></a>
A name for the store.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: No

 ** [reference](#API_CreateAnnotationStore_RequestSyntax) **   <a name="omics-CreateAnnotationStore-request-reference"></a>
The genome reference for the store's annotations.  
Type: [ReferenceItem](API_ReferenceItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [sseConfig](#API_CreateAnnotationStore_RequestSyntax) **   <a name="omics-CreateAnnotationStore-request-sseConfig"></a>
Server-side encryption (SSE) settings for the store.  
Type: [SseConfig](API_SseConfig.md) object  
Required: No

 ** [storeFormat](#API_CreateAnnotationStore_RequestSyntax) **   <a name="omics-CreateAnnotationStore-request-storeFormat"></a>
The annotation file format of the store.  
Type: String  
Valid Values: `GFF | TSV | VCF`   
Required: Yes

 ** [storeOptions](#API_CreateAnnotationStore_RequestSyntax) **   <a name="omics-CreateAnnotationStore-request-storeOptions"></a>
File parsing options for the annotation store.  
Type: [StoreOptions](API_StoreOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [tags](#API_CreateAnnotationStore_RequestSyntax) **   <a name="omics-CreateAnnotationStore-request-tags"></a>
Tags for the store.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [versionName](#API_CreateAnnotationStore_RequestSyntax) **   <a name="omics-CreateAnnotationStore-request-versionName"></a>
 The name given to an annotation store version to distinguish it from other versions.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: No

## Response Syntax
<a name="API_CreateAnnotationStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "name": "string",
   "reference": { ... },
   "status": "string",
   "storeFormat": "string",
   "storeOptions": { ... },
   "versionName": "string"
}
```

## Response Elements
<a name="API_CreateAnnotationStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_CreateAnnotationStore_ResponseSyntax) **   <a name="omics-CreateAnnotationStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [id](#API_CreateAnnotationStore_ResponseSyntax) **   <a name="omics-CreateAnnotationStore-response-id"></a>
The store's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_CreateAnnotationStore_ResponseSyntax) **   <a name="omics-CreateAnnotationStore-response-name"></a>
The store's name.  
Type: String

 ** [reference](#API_CreateAnnotationStore_ResponseSyntax) **   <a name="omics-CreateAnnotationStore-response-reference"></a>
The store's genome reference. Required for all stores except TSV format with generic annotations.  
Type: [ReferenceItem](API_ReferenceItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_CreateAnnotationStore_ResponseSyntax) **   <a name="omics-CreateAnnotationStore-response-status"></a>
The store's status.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

 ** [storeFormat](#API_CreateAnnotationStore_ResponseSyntax) **   <a name="omics-CreateAnnotationStore-response-storeFormat"></a>
The annotation file format of the store.  
Type: String  
Valid Values: `GFF | TSV | VCF` 

 ** [storeOptions](#API_CreateAnnotationStore_ResponseSyntax) **   <a name="omics-CreateAnnotationStore-response-storeOptions"></a>
The store's file parsing options.  
Type: [StoreOptions](API_StoreOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [versionName](#API_CreateAnnotationStore_ResponseSyntax) **   <a name="omics-CreateAnnotationStore-response-versionName"></a>
 The name given to an annotation store version to distinguish it from other versions.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

## Errors
<a name="API_CreateAnnotationStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateAnnotationStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateAnnotationStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateAnnotationStore) 

# CreateAnnotationStoreVersion
<a name="API_CreateAnnotationStoreVersion"></a>

 Creates a new version of an annotation store. 

## Request Syntax
<a name="API_CreateAnnotationStoreVersion_RequestSyntax"></a>

```
POST /annotationStore/name/version HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "tags": { 
      "string" : "string" 
   },
   "versionName": "string",
   "versionOptions": { ... }
}
```

## URI Request Parameters
<a name="API_CreateAnnotationStoreVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_CreateAnnotationStoreVersion_RequestSyntax) **   <a name="omics-CreateAnnotationStoreVersion-request-uri-name"></a>
 The name of an annotation store version from which versions are being created.   
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: Yes

## Request Body
<a name="API_CreateAnnotationStoreVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateAnnotationStoreVersion_RequestSyntax) **   <a name="omics-CreateAnnotationStoreVersion-request-description"></a>
 The description of an annotation store version.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [tags](#API_CreateAnnotationStoreVersion_RequestSyntax) **   <a name="omics-CreateAnnotationStoreVersion-request-tags"></a>
 Any tags added to annotation store version.   
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [versionName](#API_CreateAnnotationStoreVersion_RequestSyntax) **   <a name="omics-CreateAnnotationStoreVersion-request-versionName"></a>
 The name given to an annotation store version to distinguish it from other versions.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: Yes

 ** [versionOptions](#API_CreateAnnotationStoreVersion_RequestSyntax) **   <a name="omics-CreateAnnotationStoreVersion-request-versionOptions"></a>
 The options for an annotation store version.   
Type: [VersionOptions](API_VersionOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_CreateAnnotationStoreVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "storeId": "string",
   "versionName": "string",
   "versionOptions": { ... }
}
```

## Response Elements
<a name="API_CreateAnnotationStoreVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_CreateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-CreateAnnotationStoreVersion-response-creationTime"></a>
 The time stamp for the creation of an annotation store version.   
Type: Timestamp

 ** [id](#API_CreateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-CreateAnnotationStoreVersion-response-id"></a>
 A generated ID for the annotation store   
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_CreateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-CreateAnnotationStoreVersion-response-name"></a>
 The name given to an annotation store version to distinguish it from other versions.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

 ** [status](#API_CreateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-CreateAnnotationStoreVersion-response-status"></a>
 The status of a annotation store version.   
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

 ** [storeId](#API_CreateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-CreateAnnotationStoreVersion-response-storeId"></a>
 The ID for the annotation store from which new versions are being created.   
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [versionName](#API_CreateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-CreateAnnotationStoreVersion-response-versionName"></a>
 The name given to an annotation store version to distinguish it from other versions.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

 ** [versionOptions](#API_CreateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-CreateAnnotationStoreVersion-response-versionOptions"></a>
 The options for an annotation store version.   
Type: [VersionOptions](API_VersionOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

## Errors
<a name="API_CreateAnnotationStoreVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateAnnotationStoreVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateAnnotationStoreVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateAnnotationStoreVersion) 

# CreateConfiguration
<a name="API_CreateConfiguration"></a>

Create a new configuration.

## Request Syntax
<a name="API_CreateConfiguration_RequestSyntax"></a>

```
POST /configuration HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "requestId": "string",
   "runConfigurations": { 
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ]
      }
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateConfiguration_RequestSyntax) **   <a name="omics-CreateConfiguration-request-description"></a>
Optional description for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [name](#API_CreateConfiguration_RequestSyntax) **   <a name="omics-CreateConfiguration-request-name"></a>
User-friendly name for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: Yes

 ** [requestId](#API_CreateConfiguration_RequestSyntax) **   <a name="omics-CreateConfiguration-request-requestId"></a>
Optional request idempotency token. If not specified, a universally unique identifier (UUID) will be automatically generated for the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [runConfigurations](#API_CreateConfiguration_RequestSyntax) **   <a name="omics-CreateConfiguration-request-runConfigurations"></a>
Required run-specific configurations.  
Type: [RunConfigurations](API_RunConfigurations.md) object  
Required: Yes

 ** [tags](#API_CreateConfiguration_RequestSyntax) **   <a name="omics-CreateConfiguration-request-tags"></a>
Optional tags for the configuration.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "description": "string",
   "name": "string",
   "runConfigurations": { 
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "uuid": "string"
}
```

## Response Elements
<a name="API_CreateConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateConfiguration_ResponseSyntax) **   <a name="omics-CreateConfiguration-response-arn"></a>
Unique resource identifier for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 190.  
Pattern: `arn:.+` 

 ** [creationTime](#API_CreateConfiguration_ResponseSyntax) **   <a name="omics-CreateConfiguration-response-creationTime"></a>
Configuration creation timestamp.  
Type: Timestamp

 ** [description](#API_CreateConfiguration_ResponseSyntax) **   <a name="omics-CreateConfiguration-response-description"></a>
Description for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [name](#API_CreateConfiguration_ResponseSyntax) **   <a name="omics-CreateConfiguration-response-name"></a>
User-friendly name for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*` 

 ** [runConfigurations](#API_CreateConfiguration_ResponseSyntax) **   <a name="omics-CreateConfiguration-response-runConfigurations"></a>
Run-specific configurations.  
Type: [RunConfigurationsResponse](API_RunConfigurationsResponse.md) object

 ** [status](#API_CreateConfiguration_ResponseSyntax) **   <a name="omics-CreateConfiguration-response-status"></a>
Current configuration status.  
Type: String  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | DELETED | FAILED` 

 ** [tags](#API_CreateConfiguration_ResponseSyntax) **   <a name="omics-CreateConfiguration-response-tags"></a>
Tags for the configuration.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [uuid](#API_CreateConfiguration_ResponseSyntax) **   <a name="omics-CreateConfiguration-response-uuid"></a>
Unique identifier for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_CreateConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateConfiguration) 

# CreateMultipartReadSetUpload
<a name="API_CreateMultipartReadSetUpload"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_CreateMultipartReadSetUpload_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/upload HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "generatedFrom": "string",
   "name": "string",
   "referenceArn": "string",
   "sampleId": "string",
   "sourceFileType": "string",
   "subjectId": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateMultipartReadSetUpload_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sequenceStoreId](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-uri-sequenceStoreId"></a>
The sequence store ID for the store that is the destination of the multipart uploads.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_CreateMultipartReadSetUpload_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-clientToken"></a>
An idempotency token that can be used to avoid triggering multiple multipart uploads.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [description](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-description"></a>
The description of the read set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [generatedFrom](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-generatedFrom"></a>
Where the source originated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [name](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-name"></a>
The name of the read set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [referenceArn](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-referenceArn"></a>
The ARN of the reference.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+`   
Required: No

 ** [sampleId](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-sampleId"></a>
The source's sample ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [sourceFileType](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-sourceFileType"></a>
The type of file being uploaded.  
Type: String  
Valid Values: `FASTQ | BAM | CRAM | UBAM`   
Required: Yes

 ** [subjectId](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-subjectId"></a>
The source's subject ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [tags](#API_CreateMultipartReadSetUpload_RequestSyntax) **   <a name="omics-CreateMultipartReadSetUpload-request-tags"></a>
Any tags to add to the read set.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateMultipartReadSetUpload_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "description": "string",
   "generatedFrom": "string",
   "name": "string",
   "referenceArn": "string",
   "sampleId": "string",
   "sequenceStoreId": "string",
   "sourceFileType": "string",
   "subjectId": "string",
   "tags": { 
      "string" : "string" 
   },
   "uploadId": "string"
}
```

## Response Elements
<a name="API_CreateMultipartReadSetUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-creationTime"></a>
The creation time of the multipart upload.  
Type: Timestamp

 ** [description](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-description"></a>
The description of the read set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [generatedFrom](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-generatedFrom"></a>
The source of the read set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [name](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-name"></a>
The name of the read set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [referenceArn](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-referenceArn"></a>
The read set source's reference ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [sampleId](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-sampleId"></a>
The source's sample ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceStoreId](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-sequenceStoreId"></a>
The sequence store ID for the store that the read set will be created in.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [sourceFileType](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-sourceFileType"></a>
The file type of the read set source.  
Type: String  
Valid Values: `FASTQ | BAM | CRAM | UBAM` 

 ** [subjectId](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-subjectId"></a>
The source's subject ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [tags](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-tags"></a>
The tags to add to the read set.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [uploadId](#API_CreateMultipartReadSetUpload_ResponseSyntax) **   <a name="omics-CreateMultipartReadSetUpload-response-uploadId"></a>
The ID for the initiated multipart upload.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

## Errors
<a name="API_CreateMultipartReadSetUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateMultipartReadSetUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateMultipartReadSetUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateMultipartReadSetUpload) 

# CreateReferenceStore
<a name="API_CreateReferenceStore"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_CreateReferenceStore_RequestSyntax"></a>

```
POST /referencestore HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateReferenceStore_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateReferenceStore_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateReferenceStore_RequestSyntax) **   <a name="omics-CreateReferenceStore-request-clientToken"></a>
To ensure that requests don't run multiple times, specify a unique token for each request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [description](#API_CreateReferenceStore_RequestSyntax) **   <a name="omics-CreateReferenceStore-request-description"></a>
A description for the store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [name](#API_CreateReferenceStore_RequestSyntax) **   <a name="omics-CreateReferenceStore-request-name"></a>
A name for the store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [sseConfig](#API_CreateReferenceStore_RequestSyntax) **   <a name="omics-CreateReferenceStore-request-sseConfig"></a>
Server-side encryption (SSE) settings for the store.  
Type: [SseConfig](API_SseConfig.md) object  
Required: No

 ** [tags](#API_CreateReferenceStore_RequestSyntax) **   <a name="omics-CreateReferenceStore-request-tags"></a>
Tags for the store.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateReferenceStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   }
}
```

## Response Elements
<a name="API_CreateReferenceStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateReferenceStore_ResponseSyntax) **   <a name="omics-CreateReferenceStore-response-arn"></a>
The store's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [creationTime](#API_CreateReferenceStore_ResponseSyntax) **   <a name="omics-CreateReferenceStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [description](#API_CreateReferenceStore_ResponseSyntax) **   <a name="omics-CreateReferenceStore-response-description"></a>
The store's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [id](#API_CreateReferenceStore_ResponseSyntax) **   <a name="omics-CreateReferenceStore-response-id"></a>
The store's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [name](#API_CreateReferenceStore_ResponseSyntax) **   <a name="omics-CreateReferenceStore-response-name"></a>
The store's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sseConfig](#API_CreateReferenceStore_ResponseSyntax) **   <a name="omics-CreateReferenceStore-response-sseConfig"></a>
The store's SSE settings.  
Type: [SseConfig](API_SseConfig.md) object

## Errors
<a name="API_CreateReferenceStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateReferenceStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateReferenceStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateReferenceStore) 

# CreateRunCache
<a name="API_CreateRunCache"></a>

Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where AWS 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](https://docs.aws.amazon.com/omics/latest/dev/workflows-call-caching.html) and [Creating a run cache](https://docs.aws.amazon.com/omics/latest/dev/workflow-cache-create.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_CreateRunCache_RequestSyntax"></a>

```
POST /runCache HTTP/1.1
Content-type: application/json

{
   "cacheBehavior": "string",
   "cacheBucketOwnerId": "string",
   "cacheS3Location": "string",
   "description": "string",
   "name": "string",
   "requestId": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateRunCache_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateRunCache_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [cacheBehavior](#API_CreateRunCache_RequestSyntax) **   <a name="omics-CreateRunCache-request-cacheBehavior"></a>
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\$1ON\$1FAILURE. When you start a run that uses this cache, you can override the default cache behavior.  
For more information, see [Run cache behavior](https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior) in the * AWS HealthOmics User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CACHE_ON_FAILURE | CACHE_ALWAYS`   
Required: No

 ** [cacheBucketOwnerId](#API_CreateRunCache_RequestSyntax) **   <a name="omics-CreateRunCache-request-cacheBucketOwnerId"></a>
The AWS 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.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]+`   
Required: No

 ** [cacheS3Location](#API_CreateRunCache_RequestSyntax) **   <a name="omics-CreateRunCache-request-cacheS3Location"></a>
Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).  
Type: String  
Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?`   
Required: Yes

 ** [description](#API_CreateRunCache_RequestSyntax) **   <a name="omics-CreateRunCache-request-description"></a>
Enter a description of the run cache.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [name](#API_CreateRunCache_RequestSyntax) **   <a name="omics-CreateRunCache-request-name"></a>
Enter a user-friendly name for the run cache.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [requestId](#API_CreateRunCache_RequestSyntax) **   <a name="omics-CreateRunCache-request-requestId"></a>
A unique request token, to ensure idempotency. If you don't specify a token, AWS HealthOmics automatically generates a universally unique identifier (UUID) for the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [tags](#API_CreateRunCache_RequestSyntax) **   <a name="omics-CreateRunCache-request-tags"></a>
Specify one or more tags to associate with this run cache.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateRunCache_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_CreateRunCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateRunCache_ResponseSyntax) **   <a name="omics-CreateRunCache-response-arn"></a>
Unique resource identifier for the run cache.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [id](#API_CreateRunCache_ResponseSyntax) **   <a name="omics-CreateRunCache-response-id"></a>
Identifier for the run cache.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [status](#API_CreateRunCache_ResponseSyntax) **   <a name="omics-CreateRunCache-response-status"></a>
Run cache status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `ACTIVE | DELETED | FAILED` 

 ** [tags](#API_CreateRunCache_ResponseSyntax) **   <a name="omics-CreateRunCache-response-tags"></a>
The tags associated with this run cache.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_CreateRunCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateRunCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateRunCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateRunCache) 

# CreateRunGroup
<a name="API_CreateRunGroup"></a>

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.

## Request Syntax
<a name="API_CreateRunGroup_RequestSyntax"></a>

```
POST /runGroup HTTP/1.1
Content-type: application/json

{
   "maxCpus": number,
   "maxDuration": number,
   "maxGpus": number,
   "maxRuns": number,
   "name": "string",
   "requestId": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateRunGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateRunGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxCpus](#API_CreateRunGroup_RequestSyntax) **   <a name="omics-CreateRunGroup-request-maxCpus"></a>
The maximum number of CPUs that can run concurrently across all active runs in the run group.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** [maxDuration](#API_CreateRunGroup_RequestSyntax) **   <a name="omics-CreateRunGroup-request-maxDuration"></a>
The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** [maxGpus](#API_CreateRunGroup_RequestSyntax) **   <a name="omics-CreateRunGroup-request-maxGpus"></a>
The maximum number of GPUs that can run concurrently across all active runs in the run group.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** [maxRuns](#API_CreateRunGroup_RequestSyntax) **   <a name="omics-CreateRunGroup-request-maxRuns"></a>
The maximum number of runs that can be running at the same time.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** [name](#API_CreateRunGroup_RequestSyntax) **   <a name="omics-CreateRunGroup-request-name"></a>
A name for the group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [requestId](#API_CreateRunGroup_RequestSyntax) **   <a name="omics-CreateRunGroup-request-requestId"></a>
To ensure that requests don't run multiple times, specify a unique ID for each request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [tags](#API_CreateRunGroup_RequestSyntax) **   <a name="omics-CreateRunGroup-request-tags"></a>
Tags for the group.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateRunGroup_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_CreateRunGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateRunGroup_ResponseSyntax) **   <a name="omics-CreateRunGroup-response-arn"></a>
The group's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [id](#API_CreateRunGroup_ResponseSyntax) **   <a name="omics-CreateRunGroup-response-id"></a>
The group's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [tags](#API_CreateRunGroup_ResponseSyntax) **   <a name="omics-CreateRunGroup-response-tags"></a>
Tags for the run group.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_CreateRunGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateRunGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateRunGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateRunGroup) 

# CreateSequenceStore
<a name="API_CreateSequenceStore"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/create-sequence-store.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_CreateSequenceStore_RequestSyntax"></a>

```
POST /sequencestore HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "eTagAlgorithmFamily": "string",
   "fallbackLocation": "string",
   "name": "string",
   "propagatedSetLevelTags": [ "string" ],
   "s3AccessConfig": { 
      "accessLogLocation": "string"
   },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateSequenceStore_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateSequenceStore_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-clientToken"></a>
An idempotency token used to dedupe retry requests so that duplicate runs are not created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [description](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-description"></a>
A description for the store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [eTagAlgorithmFamily](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-eTagAlgorithmFamily"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/etags-and-provenance.html) in the * AWS HealthOmics User Guide*.  
Type: String  
Valid Values: `MD5up | SHA256up | SHA512up`   
Required: No

 ** [fallbackLocation](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-fallbackLocation"></a>
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.  
Type: String  
Pattern: `$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?`   
Required: No

 ** [name](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-name"></a>
A name for the store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [propagatedSetLevelTags](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-propagatedSetLevelTags"></a>
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.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [s3AccessConfig](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-s3AccessConfig"></a>
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.   
Type: [S3AccessConfig](API_S3AccessConfig.md) object  
Required: No

 ** [sseConfig](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-sseConfig"></a>
Server-side encryption (SSE) settings for the store.  
Type: [SseConfig](API_SseConfig.md) object  
Required: No

 ** [tags](#API_CreateSequenceStore_RequestSyntax) **   <a name="omics-CreateSequenceStore-request-tags"></a>
Tags for the store. You can configure up to 50 tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateSequenceStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "description": "string",
   "eTagAlgorithmFamily": "string",
   "fallbackLocation": "string",
   "id": "string",
   "name": "string",
   "propagatedSetLevelTags": [ "string" ],
   "s3Access": { 
      "accessLogLocation": "string",
      "s3AccessPointArn": "string",
      "s3Uri": "string"
   },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "status": "string",
   "statusMessage": "string"
}
```

## Response Elements
<a name="API_CreateSequenceStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-arn"></a>
The store's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [creationTime](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [description](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-description"></a>
The store's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [eTagAlgorithmFamily](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-eTagAlgorithmFamily"></a>
The algorithm family of the ETag.  
Type: String  
Valid Values: `MD5up | SHA256up | SHA512up` 

 ** [fallbackLocation](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-fallbackLocation"></a>
An S3 location that is used to store files that have failed a direct upload.  
Type: String  
Pattern: `$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?` 

 ** [id](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-id"></a>
The store's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [name](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-name"></a>
The store's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [propagatedSetLevelTags](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-propagatedSetLevelTags"></a>
The tags keys to propagate to the S3 objects associated with read sets in the sequence store.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [s3Access](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-s3Access"></a>
The S3 access metadata of the sequence store.  
Type: [SequenceStoreS3Access](API_SequenceStoreS3Access.md) object

 ** [sseConfig](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-sseConfig"></a>
Server-side encryption (SSE) settings for the store. This contains the KMS key ARN that is used to encrypt read set objects.  
Type: [SseConfig](API_SseConfig.md) object

 ** [status](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-status"></a>
The status of the sequence store.  
Type: String  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | FAILED` 

 ** [statusMessage](#API_CreateSequenceStore_ResponseSyntax) **   <a name="omics-CreateSequenceStore-response-statusMessage"></a>
The status message of the sequence store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_CreateSequenceStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateSequenceStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateSequenceStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateSequenceStore) 

# CreateShare
<a name="API_CreateShare"></a>

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

## Request Syntax
<a name="API_CreateShare_RequestSyntax"></a>

```
POST /share HTTP/1.1
Content-type: application/json

{
   "principalSubscriber": "string",
   "resourceArn": "string",
   "shareName": "string"
}
```

## URI Request Parameters
<a name="API_CreateShare_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateShare_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [principalSubscriber](#API_CreateShare_RequestSyntax) **   <a name="omics-CreateShare-request-principalSubscriber"></a>
The principal subscriber is the account being offered shared access to the resource.   
Type: String  
Required: Yes

 ** [resourceArn](#API_CreateShare_RequestSyntax) **   <a name="omics-CreateShare-request-resourceArn"></a>
The ARN of the resource to be shared.  
Type: String  
Required: Yes

 ** [shareName](#API_CreateShare_RequestSyntax) **   <a name="omics-CreateShare-request-shareName"></a>
A name that the owner defines for the share.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: No

## Response Syntax
<a name="API_CreateShare_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "shareId": "string",
   "shareName": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_CreateShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [shareId](#API_CreateShare_ResponseSyntax) **   <a name="omics-CreateShare-response-shareId"></a>
The ID that HealthOmics generates for the share.  
Type: String

 ** [shareName](#API_CreateShare_ResponseSyntax) **   <a name="omics-CreateShare-response-shareName"></a>
The name of the share.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_-]+` 

 ** [status](#API_CreateShare_ResponseSyntax) **   <a name="omics-CreateShare-response-status"></a>
The status of the share.  
Type: String  
Valid Values: `PENDING | ACTIVATING | ACTIVE | DELETING | DELETED | FAILED` 

## Errors
<a name="API_CreateShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateShare) 

# CreateVariantStore
<a name="API_CreateVariantStore"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Creates a variant store.

## Request Syntax
<a name="API_CreateVariantStore_RequestSyntax"></a>

```
POST /variantStore HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "reference": { ... },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateVariantStore_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateVariantStore_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateVariantStore_RequestSyntax) **   <a name="omics-CreateVariantStore-request-description"></a>
A description for the store.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [name](#API_CreateVariantStore_RequestSyntax) **   <a name="omics-CreateVariantStore-request-name"></a>
A name for the store.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: No

 ** [reference](#API_CreateVariantStore_RequestSyntax) **   <a name="omics-CreateVariantStore-request-reference"></a>
The genome reference for the store's variants.  
Type: [ReferenceItem](API_ReferenceItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [sseConfig](#API_CreateVariantStore_RequestSyntax) **   <a name="omics-CreateVariantStore-request-sseConfig"></a>
Server-side encryption (SSE) settings for the store.  
Type: [SseConfig](API_SseConfig.md) object  
Required: No

 ** [tags](#API_CreateVariantStore_RequestSyntax) **   <a name="omics-CreateVariantStore-request-tags"></a>
Tags for the store.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateVariantStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "name": "string",
   "reference": { ... },
   "status": "string"
}
```

## Response Elements
<a name="API_CreateVariantStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_CreateVariantStore_ResponseSyntax) **   <a name="omics-CreateVariantStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [id](#API_CreateVariantStore_ResponseSyntax) **   <a name="omics-CreateVariantStore-response-id"></a>
The store's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_CreateVariantStore_ResponseSyntax) **   <a name="omics-CreateVariantStore-response-name"></a>
The store's name.  
Type: String

 ** [reference](#API_CreateVariantStore_ResponseSyntax) **   <a name="omics-CreateVariantStore-response-reference"></a>
The store's genome reference.  
Type: [ReferenceItem](API_ReferenceItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_CreateVariantStore_ResponseSyntax) **   <a name="omics-CreateVariantStore-response-status"></a>
The store's status.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

## Errors
<a name="API_CreateVariantStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateVariantStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateVariantStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateVariantStore) 

# CreateWorkflow
<a name="API_CreateWorkflow"></a>

Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:
+  *Workflow definition file:* A workflow definition file written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in `.zip` format. For more information, see [Workflow definition files](https://docs.aws.amazon.com/omics/latest/dev/workflow-definition-files.html) in AWS HealthOmics.
  + You can use Amazon Q CLI to build and validate your workflow definition files in WDL, Nextflow, and CWL. For more information, see [Example prompts for Amazon Q CLI](https://docs.aws.amazon.com/omics/latest/dev/getting-started.html#omics-q-prompts) and the [AWS HealthOmics Agentic generative AI tutorial](https://github.com/aws-samples/aws-healthomics-tutorials/tree/main/generative-ai) on GitHub.
+  *(Optional) Parameter template file:* A parameter template file written in JSON. Create the file to define the run parameters, or AWS HealthOmics generates the parameter template for you. For more information, see [Parameter template files for HealthOmics workflows](https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html). 
+  *ECR container images:* Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository.
+  *(Optional) Sentieon licenses:* Request a Sentieon license to use the Sentieon software in private workflows.

For more information, see [Creating or updating a private workflow in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_CreateWorkflow_RequestSyntax"></a>

```
POST /workflow HTTP/1.1
Content-type: application/json

{
   "accelerators": "string",
   "containerRegistryMap": { 
      "imageMappings": [ 
         { 
            "destinationImage": "string",
            "sourceImage": "string"
         }
      ],
      "registryMappings": [ 
         { 
            "ecrAccountId": "string",
            "ecrRepositoryPrefix": "string",
            "upstreamRegistryUrl": "string",
            "upstreamRepositoryPrefix": "string"
         }
      ]
   },
   "containerRegistryMapUri": "string",
   "definitionRepository": { 
      "connectionArn": "string",
      "excludeFilePatterns": [ "string" ],
      "fullRepositoryId": "string",
      "sourceReference": { 
         "type": "string",
         "value": "string"
      }
   },
   "definitionUri": "string",
   "definitionZip": blob,
   "description": "string",
   "engine": "string",
   "main": "string",
   "name": "string",
   "parameterTemplate": { 
      "string" : { 
         "description": "string",
         "optional": boolean
      }
   },
   "parameterTemplatePath": "string",
   "readmeMarkdown": "string",
   "readmePath": "string",
   "readmeUri": "string",
   "requestId": "string",
   "storageCapacity": number,
   "storageType": "string",
   "tags": { 
      "string" : "string" 
   },
   "workflowBucketOwnerId": "string"
}
```

## URI Request Parameters
<a name="API_CreateWorkflow_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateWorkflow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [accelerators](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-accelerators"></a>
The computational accelerator specified to run the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `GPU`   
Required: No

 ** [containerRegistryMap](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-containerRegistryMap"></a>
(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](https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html) in the * AWS HealthOmics User Guide*.  
Type: [ContainerRegistryMap](API_ContainerRegistryMap.md) object  
Required: No

 ** [containerRegistryMapUri](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-containerRegistryMapUri"></a>
(Optional) URI of the S3 location for the registry mapping file.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 750.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [definitionRepository](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-definitionRepository"></a>
The repository information for the workflow definition. This allows you to source your workflow definition directly from a code repository.  
Type: [DefinitionRepository](API_DefinitionRepository.md) object  
Required: No

 ** [definitionUri](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-definitionUri"></a>
The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [definitionZip](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-definitionZip"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/workflow-defn-requirements.html) in the * AWS HealthOmics User Guide*.  
Type: Base64-encoded binary data object  
Required: No

 ** [description](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-description"></a>
A description for the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [engine](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-engine"></a>
The workflow engine for the workflow. By default, AWS HealthOmics detects the engine automatically from your workflow definition. Provide a value if you have workflow definition files from more than one engine in your zip file, or to use WDL lenient.  
WDL lenient is designed to handle workflows migrated from Cromwell. It supports customer Cromwell directives and some non-conformant logic. For details, see [Implicit type conversion in WDL lenient](https://docs.aws.amazon.com/omics/latest/dev/workflow-wdl-type-conversion.html) in the * AWS HealthOmics User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `WDL | NEXTFLOW | CWL | WDL_LENIENT`   
Required: No

 ** [main](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-main"></a>
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`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [name](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-name"></a>
Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and AWS HealthOmics console.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [parameterTemplate](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-parameterTemplate"></a>
A parameter template for the workflow. If this field is blank, AWS 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](https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html) in the * AWS HealthOmics User Guide*.  
Type: String to [WorkflowParameter](API_WorkflowParameter.md) object map  
Map Entries: Maximum number of 2000 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [parameterTemplatePath](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-parameterTemplatePath"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [readmeMarkdown](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-readmeMarkdown"></a>
The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.  
Type: String  
Required: No

 ** [readmePath](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-readmePath"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [readmeUri](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-readmeUri"></a>
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.
Type: String  
Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))`   
Required: No

 ** [requestId](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-requestId"></a>
An idempotency token to ensure that duplicate workflows are not created when AWS HealthOmics submits retry requests.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [storageCapacity](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-storageCapacity"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.  
Required: No

 ** [storageType](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-storageType"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html) in the * AWS HealthOmics User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `STATIC | DYNAMIC`   
Required: No

 ** [tags](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-tags"></a>
Tags for the workflow. You can define up to 50 tags for the workflow. For more information, see [Adding a tag](https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html) in the * AWS HealthOmics User Guide*.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [workflowBucketOwnerId](#API_CreateWorkflow_RequestSyntax) **   <a name="omics-CreateWorkflow-request-workflowBucketOwnerId"></a>
The AWS account ID of the expected owner of the S3 bucket that contains the workflow definition. If not specified, the service skips the validation.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

## Response Syntax
<a name="API_CreateWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "uuid": "string"
}
```

## Response Elements
<a name="API_CreateWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateWorkflow_ResponseSyntax) **   <a name="omics-CreateWorkflow-response-arn"></a>
The workflow's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [id](#API_CreateWorkflow_ResponseSyntax) **   <a name="omics-CreateWorkflow-response-id"></a>
The workflow's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [status](#API_CreateWorkflow_ResponseSyntax) **   <a name="omics-CreateWorkflow-response-status"></a>
The workflow's status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETED | FAILED | INACTIVE` 

 ** [tags](#API_CreateWorkflow_ResponseSyntax) **   <a name="omics-CreateWorkflow-response-tags"></a>
The workflow's tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [uuid](#API_CreateWorkflow_ResponseSyntax) **   <a name="omics-CreateWorkflow-response-uuid"></a>
The universally unique identifier (UUID) value for this workflow.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` 

## Errors
<a name="API_CreateWorkflow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateWorkflow) 

# CreateWorkflowVersion
<a name="API_CreateWorkflowVersion"></a>

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.

**Note**  
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 AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_CreateWorkflowVersion_RequestSyntax"></a>

```
POST /workflow/workflowId/version HTTP/1.1
Content-type: application/json

{
   "accelerators": "string",
   "containerRegistryMap": { 
      "imageMappings": [ 
         { 
            "destinationImage": "string",
            "sourceImage": "string"
         }
      ],
      "registryMappings": [ 
         { 
            "ecrAccountId": "string",
            "ecrRepositoryPrefix": "string",
            "upstreamRegistryUrl": "string",
            "upstreamRepositoryPrefix": "string"
         }
      ]
   },
   "containerRegistryMapUri": "string",
   "definitionRepository": { 
      "connectionArn": "string",
      "excludeFilePatterns": [ "string" ],
      "fullRepositoryId": "string",
      "sourceReference": { 
         "type": "string",
         "value": "string"
      }
   },
   "definitionUri": "string",
   "definitionZip": blob,
   "description": "string",
   "engine": "string",
   "main": "string",
   "parameterTemplate": { 
      "string" : { 
         "description": "string",
         "optional": boolean
      }
   },
   "parameterTemplatePath": "string",
   "readmeMarkdown": "string",
   "readmePath": "string",
   "readmeUri": "string",
   "requestId": "string",
   "storageCapacity": number,
   "storageType": "string",
   "tags": { 
      "string" : "string" 
   },
   "versionName": "string",
   "workflowBucketOwnerId": "string"
}
```

## URI Request Parameters
<a name="API_CreateWorkflowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [workflowId](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-uri-workflowId"></a>
The ID of the workflow where you are creating the new version. The `workflowId` is not the UUID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_CreateWorkflowVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [accelerators](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-accelerators"></a>
The computational accelerator for this workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `GPU`   
Required: No

 ** [containerRegistryMap](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-containerRegistryMap"></a>
(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](https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html) in the * AWS HealthOmics User Guide*.  
Type: [ContainerRegistryMap](API_ContainerRegistryMap.md) object  
Required: No

 ** [containerRegistryMapUri](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-containerRegistryMapUri"></a>
(Optional) URI of the S3 location for the registry mapping file.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 750.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [definitionRepository](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-definitionRepository"></a>
The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.  
Type: [DefinitionRepository](API_DefinitionRepository.md) object  
Required: No

 ** [definitionUri](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-definitionUri"></a>
The S3 URI of a definition for this workflow version. The S3 bucket must be in the same region as this workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [definitionZip](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-definitionZip"></a>
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 * AWS HealthOmics User Guide*.  
Type: Base64-encoded binary data object  
Required: No

 ** [description](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-description"></a>
A description for this workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [engine](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-engine"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `WDL | NEXTFLOW | CWL | WDL_LENIENT`   
Required: No

 ** [main](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-main"></a>
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`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [parameterTemplate](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-parameterTemplate"></a>
A parameter template for this workflow version. If this field is blank, AWS 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](https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html) in the * AWS HealthOmics User Guide*.  
Type: String to [WorkflowParameter](API_WorkflowParameter.md) object map  
Map Entries: Maximum number of 2000 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [parameterTemplatePath](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-parameterTemplatePath"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [readmeMarkdown](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-readmeMarkdown"></a>
The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.  
Type: String  
Required: No

 ** [readmePath](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-readmePath"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [readmeUri](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-readmeUri"></a>
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.
Type: String  
Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))`   
Required: No

 ** [requestId](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-requestId"></a>
An idempotency token to ensure that duplicate workflows are not created when AWS HealthOmics submits retry requests.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [storageCapacity](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-storageCapacity"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.  
Required: No

 ** [storageType](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-storageType"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html) in the * AWS HealthOmics User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `STATIC | DYNAMIC`   
Required: No

 ** [tags](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-tags"></a>
Tags for this workflow version. You can define up to 50 tags for the workflow. For more information, see [Adding a tag](https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html) in the * AWS HealthOmics User Guide*.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [versionName](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-versionName"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: Yes

 ** [workflowBucketOwnerId](#API_CreateWorkflowVersion_RequestSyntax) **   <a name="omics-CreateWorkflowVersion-request-workflowBucketOwnerId"></a>
 AWS 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.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

## Response Syntax
<a name="API_CreateWorkflowVersion_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "uuid": "string",
   "versionName": "string",
   "workflowId": "string"
}
```

## Response Elements
<a name="API_CreateWorkflowVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateWorkflowVersion_ResponseSyntax) **   <a name="omics-CreateWorkflowVersion-response-arn"></a>
ARN of the workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 150.  
Pattern: `arn:.+` 

 ** [status](#API_CreateWorkflowVersion_ResponseSyntax) **   <a name="omics-CreateWorkflowVersion-response-status"></a>
The workflow version status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETED | FAILED | INACTIVE` 

 ** [tags](#API_CreateWorkflowVersion_ResponseSyntax) **   <a name="omics-CreateWorkflowVersion-response-tags"></a>
The workflow version's tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [uuid](#API_CreateWorkflowVersion_ResponseSyntax) **   <a name="omics-CreateWorkflowVersion-response-uuid"></a>
The universally unique identifier (UUID) value for this workflow version.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` 

 ** [versionName](#API_CreateWorkflowVersion_ResponseSyntax) **   <a name="omics-CreateWorkflowVersion-response-versionName"></a>
The workflow version name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*` 

 ** [workflowId](#API_CreateWorkflowVersion_ResponseSyntax) **   <a name="omics-CreateWorkflowVersion-response-workflowId"></a>
The workflow's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

## Errors
<a name="API_CreateWorkflowVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateWorkflowVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/CreateWorkflowVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CreateWorkflowVersion) 

# DeleteAnnotationStore
<a name="API_DeleteAnnotationStore"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Deletes an annotation store.

## Request Syntax
<a name="API_DeleteAnnotationStore_RequestSyntax"></a>

```
DELETE /annotationStore/name?force=force HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAnnotationStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [force](#API_DeleteAnnotationStore_RequestSyntax) **   <a name="omics-DeleteAnnotationStore-request-uri-force"></a>
Whether to force deletion.

 ** [name](#API_DeleteAnnotationStore_RequestSyntax) **   <a name="omics-DeleteAnnotationStore-request-uri-name"></a>
The store's name.  
Required: Yes

## Request Body
<a name="API_DeleteAnnotationStore_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAnnotationStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "status": "string"
}
```

## Response Elements
<a name="API_DeleteAnnotationStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [status](#API_DeleteAnnotationStore_ResponseSyntax) **   <a name="omics-DeleteAnnotationStore-response-status"></a>
The store's status.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

## Errors
<a name="API_DeleteAnnotationStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteAnnotationStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteAnnotationStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteAnnotationStore) 

# DeleteAnnotationStoreVersions
<a name="API_DeleteAnnotationStoreVersions"></a>

 Deletes one or multiple versions of an annotation store. 

## Request Syntax
<a name="API_DeleteAnnotationStoreVersions_RequestSyntax"></a>

```
POST /annotationStore/name/versions/delete?force=force HTTP/1.1
Content-type: application/json

{
   "versions": [ "string" ]
}
```

## URI Request Parameters
<a name="API_DeleteAnnotationStoreVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [force](#API_DeleteAnnotationStoreVersions_RequestSyntax) **   <a name="omics-DeleteAnnotationStoreVersions-request-uri-force"></a>
 Forces the deletion of an annotation store version when imports are in-progress.. 

 ** [name](#API_DeleteAnnotationStoreVersions_RequestSyntax) **   <a name="omics-DeleteAnnotationStoreVersions-request-uri-name"></a>
 The name of the annotation store from which versions are being deleted.   
Required: Yes

## Request Body
<a name="API_DeleteAnnotationStoreVersions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [versions](#API_DeleteAnnotationStoreVersions_RequestSyntax) **   <a name="omics-DeleteAnnotationStoreVersions-request-versions"></a>
 The versions of an annotation store to be deleted.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: Yes

## Response Syntax
<a name="API_DeleteAnnotationStoreVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "message": "string",
         "versionName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DeleteAnnotationStoreVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_DeleteAnnotationStoreVersions_ResponseSyntax) **   <a name="omics-DeleteAnnotationStoreVersions-response-errors"></a>
 Any errors that occur when attempting to delete an annotation store version.   
Type: Array of [VersionDeleteError](API_VersionDeleteError.md) objects

## Errors
<a name="API_DeleteAnnotationStoreVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteAnnotationStoreVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteAnnotationStoreVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteAnnotationStoreVersions) 

# DeleteBatch
<a name="API_DeleteBatch"></a>

Deletes a run batch resource and its associated metadata. This operation does not delete the individual workflow runs. To delete the runs, call `DeleteRunBatch` before calling `DeleteBatch`.

 `DeleteBatch` requires the batch to be in a terminal state: `PROCESSED`, `FAILED`, `CANCELLED`, or `RUNS_DELETED`. After `DeleteBatch` completes, the batch metadata is no longer accessible. You cannot call `GetBatch`, `ListRunsInBatch`, `DeleteRunBatch`, or `CancelRunBatch` on a deleted batch.

## Request Syntax
<a name="API_DeleteBatch_RequestSyntax"></a>

```
DELETE /runBatch/batchId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteBatch_RequestParameters"></a>

The request uses the following URI parameters.

 ** [batchId](#API_DeleteBatch_RequestSyntax) **   <a name="omics-DeleteBatch-request-uri-batchId"></a>
The identifier portion of the run batch ARN.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteBatch_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteBatch_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteBatch) 

# DeleteConfiguration
<a name="API_DeleteConfiguration"></a>

Delete an existing configuration.

## Request Syntax
<a name="API_DeleteConfiguration_RequestSyntax"></a>

```
DELETE /configuration/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DeleteConfiguration_RequestSyntax) **   <a name="omics-DeleteConfiguration-request-uri-name"></a>
Configuration name to delete.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: Yes

## Request Body
<a name="API_DeleteConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteConfiguration) 

# DeleteReference
<a name="API_DeleteReference"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/deleting-reference-and-sequence-stores.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_DeleteReference_RequestSyntax"></a>

```
DELETE /referencestore/referenceStoreId/reference/id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteReference_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_DeleteReference_RequestSyntax) **   <a name="omics-DeleteReference-request-uri-id"></a>
The reference's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [referenceStoreId](#API_DeleteReference_RequestSyntax) **   <a name="omics-DeleteReference-request-uri-referenceStoreId"></a>
The reference's store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteReference_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteReference_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteReference_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteReference_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteReference) 

# DeleteReferenceStore
<a name="API_DeleteReferenceStore"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/deleting-reference-and-sequence-stores.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_DeleteReferenceStore_RequestSyntax"></a>

```
DELETE /referencestore/id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteReferenceStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_DeleteReferenceStore_RequestSyntax) **   <a name="omics-DeleteReferenceStore-request-uri-id"></a>
The store's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteReferenceStore_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteReferenceStore_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteReferenceStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteReferenceStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteReferenceStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteReferenceStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteReferenceStore) 

# DeleteRun
<a name="API_DeleteRun"></a>

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.

## Request Syntax
<a name="API_DeleteRun_RequestSyntax"></a>

```
DELETE /run/id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_DeleteRun_RequestSyntax) **   <a name="omics-DeleteRun-request-uri-id"></a>
The run's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRun_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteRun) 

# DeleteRunBatch
<a name="API_DeleteRunBatch"></a>

Deletes the individual workflow runs within a batch. This operation is separate from `DeleteBatch`, which removes the batch metadata.

Delete is only allowed on batches in `PROCESSED` or `CANCELLED` state. Delete operations are non-atomic and may be partially successful. Use `GetBatch` to review `successfulDeleteSubmissionCount` and `failedDeleteSubmissionCount` in the `submissionSummary`. Only one cancel or delete operation per batch is allowed at a time.

## Request Syntax
<a name="API_DeleteRunBatch_RequestSyntax"></a>

```
POST /runBatch/delete HTTP/1.1
Content-type: application/json

{
   "batchId": "string"
}
```

## URI Request Parameters
<a name="API_DeleteRunBatch_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteRunBatch_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [batchId](#API_DeleteRunBatch_RequestSyntax) **   <a name="omics-DeleteRunBatch-request-batchId"></a>
The identifier portion of the run batch ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DeleteRunBatch_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteRunBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteRunBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteRunBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteRunBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteRunBatch) 

# DeleteRunCache
<a name="API_DeleteRunCache"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/workflow-cache-delete.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_DeleteRunCache_RequestSyntax"></a>

```
DELETE /runCache/id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRunCache_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_DeleteRunCache_RequestSyntax) **   <a name="omics-DeleteRunCache-request-uri-id"></a>
Run cache identifier for the cache you want to delete.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteRunCache_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRunCache_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteRunCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteRunCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteRunCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteRunCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteRunCache) 

# DeleteRunGroup
<a name="API_DeleteRunGroup"></a>

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.

## Request Syntax
<a name="API_DeleteRunGroup_RequestSyntax"></a>

```
DELETE /runGroup/id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRunGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_DeleteRunGroup_RequestSyntax) **   <a name="omics-DeleteRunGroup-request-uri-id"></a>
The run group's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteRunGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRunGroup_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteRunGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteRunGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteRunGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteRunGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteRunGroup) 

# DeleteS3AccessPolicy
<a name="API_DeleteS3AccessPolicy"></a>

Deletes an access policy for the specified store.

## Request Syntax
<a name="API_DeleteS3AccessPolicy_RequestSyntax"></a>

```
DELETE /s3accesspolicy/s3AccessPointArn HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteS3AccessPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [s3AccessPointArn](#API_DeleteS3AccessPolicy_RequestSyntax) **   <a name="omics-DeleteS3AccessPolicy-request-uri-s3AccessPointArn"></a>
The S3 access point ARN that has the access policy.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*`   
Required: Yes

## Request Body
<a name="API_DeleteS3AccessPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteS3AccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteS3AccessPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteS3AccessPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteS3AccessPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteS3AccessPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteS3AccessPolicy) 

# DeleteSequenceStore
<a name="API_DeleteSequenceStore"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/deleting-reference-and-sequence-stores.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_DeleteSequenceStore_RequestSyntax"></a>

```
DELETE /sequencestore/id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSequenceStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_DeleteSequenceStore_RequestSyntax) **   <a name="omics-DeleteSequenceStore-request-uri-id"></a>
The sequence store's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteSequenceStore_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSequenceStore_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteSequenceStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteSequenceStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteSequenceStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteSequenceStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteSequenceStore) 

# DeleteShare
<a name="API_DeleteShare"></a>

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.

## Request Syntax
<a name="API_DeleteShare_RequestSyntax"></a>

```
DELETE /share/shareId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteShare_RequestParameters"></a>

The request uses the following URI parameters.

 ** [shareId](#API_DeleteShare_RequestSyntax) **   <a name="omics-DeleteShare-request-uri-shareId"></a>
The ID for the resource share to be deleted.  
Required: Yes

## Request Body
<a name="API_DeleteShare_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteShare_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "status": "string"
}
```

## Response Elements
<a name="API_DeleteShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [status](#API_DeleteShare_ResponseSyntax) **   <a name="omics-DeleteShare-response-status"></a>
The status of the share being deleted.  
Type: String  
Valid Values: `PENDING | ACTIVATING | ACTIVE | DELETING | DELETED | FAILED` 

## Errors
<a name="API_DeleteShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteShare) 

# DeleteVariantStore
<a name="API_DeleteVariantStore"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Deletes a variant store.

## Request Syntax
<a name="API_DeleteVariantStore_RequestSyntax"></a>

```
DELETE /variantStore/name?force=force HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteVariantStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [force](#API_DeleteVariantStore_RequestSyntax) **   <a name="omics-DeleteVariantStore-request-uri-force"></a>
Whether to force deletion.

 ** [name](#API_DeleteVariantStore_RequestSyntax) **   <a name="omics-DeleteVariantStore-request-uri-name"></a>
The store's name.  
Required: Yes

## Request Body
<a name="API_DeleteVariantStore_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteVariantStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "status": "string"
}
```

## Response Elements
<a name="API_DeleteVariantStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [status](#API_DeleteVariantStore_ResponseSyntax) **   <a name="omics-DeleteVariantStore-response-status"></a>
The store's status.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

## Errors
<a name="API_DeleteVariantStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteVariantStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteVariantStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteVariantStore) 

# DeleteWorkflow
<a name="API_DeleteWorkflow"></a>

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.

## Request Syntax
<a name="API_DeleteWorkflow_RequestSyntax"></a>

```
DELETE /workflow/id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_DeleteWorkflow_RequestSyntax) **   <a name="omics-DeleteWorkflow-request-uri-id"></a>
The workflow's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteWorkflow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteWorkflow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteWorkflow) 

# DeleteWorkflowVersion
<a name="API_DeleteWorkflowVersion"></a>

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 AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_DeleteWorkflowVersion_RequestSyntax"></a>

```
DELETE /workflow/workflowId/version/versionName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteWorkflowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [versionName](#API_DeleteWorkflowVersion_RequestSyntax) **   <a name="omics-DeleteWorkflowVersion-request-uri-versionName"></a>
The workflow version name.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: Yes

 ** [workflowId](#API_DeleteWorkflowVersion_RequestSyntax) **   <a name="omics-DeleteWorkflowVersion-request-uri-workflowId"></a>
The workflow's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteWorkflowVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteWorkflowVersion_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteWorkflowVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteWorkflowVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteWorkflowVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/DeleteWorkflowVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DeleteWorkflowVersion) 

# GetAnnotationImportJob
<a name="API_GetAnnotationImportJob"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Gets information about an annotation import job.

## Request Syntax
<a name="API_GetAnnotationImportJob_RequestSyntax"></a>

```
GET /import/annotation/jobId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAnnotationImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobId](#API_GetAnnotationImportJob_RequestSyntax) **   <a name="omics-GetAnnotationImportJob-request-uri-jobId"></a>
The job's ID.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_GetAnnotationImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAnnotationImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "annotationFields": { 
      "string" : "string" 
   },
   "completionTime": "string",
   "creationTime": "string",
   "destinationName": "string",
   "formatOptions": { ... },
   "id": "string",
   "items": [ 
      { 
         "jobStatus": "string",
         "source": "string"
      }
   ],
   "roleArn": "string",
   "runLeftNormalization": boolean,
   "status": "string",
   "statusMessage": "string",
   "updateTime": "string",
   "versionName": "string"
}
```

## Response Elements
<a name="API_GetAnnotationImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [annotationFields](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-annotationFields"></a>
The annotation schema generated by the parsed annotation data.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 21.  
Value Length Constraints: Minimum length of 1. Maximum length of 21.

 ** [completionTime](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-completionTime"></a>
When the job completed.  
Type: Timestamp

 ** [creationTime](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [destinationName](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-destinationName"></a>
The job's destination annotation store.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

 ** [formatOptions](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-formatOptions"></a>
Formatting options for a file.  
Type: [FormatOptions](API_FormatOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [id](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-id"></a>
The job's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [items](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-items"></a>
The job's imported items.  
Type: Array of [AnnotationImportItemDetail](API_AnnotationImportItemDetail.md) objects  
Array Members: Fixed number of 1 item.

 ** [roleArn](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-roleArn"></a>
The job's service role ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` 

 ** [runLeftNormalization](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-runLeftNormalization"></a>
The job's left normalization setting.  
Type: Boolean

 ** [status](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` 

 ** [statusMessage](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-statusMessage"></a>
The job's status message.  
Type: String

 ** [updateTime](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-updateTime"></a>
When the job was updated.  
Type: Timestamp

 ** [versionName](#API_GetAnnotationImportJob_ResponseSyntax) **   <a name="omics-GetAnnotationImportJob-response-versionName"></a>
 The name of the annotation store version.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

## Errors
<a name="API_GetAnnotationImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetAnnotationImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetAnnotationImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetAnnotationImportJob) 

# GetAnnotationStore
<a name="API_GetAnnotationStore"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Gets information about an annotation store.

## Request Syntax
<a name="API_GetAnnotationStore_RequestSyntax"></a>

```
GET /annotationStore/name HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAnnotationStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_GetAnnotationStore_RequestSyntax) **   <a name="omics-GetAnnotationStore-request-uri-name"></a>
The store's name.  
Required: Yes

## Request Body
<a name="API_GetAnnotationStore_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAnnotationStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "numVersions": number,
   "reference": { ... },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "status": "string",
   "statusMessage": "string",
   "storeArn": "string",
   "storeFormat": "string",
   "storeOptions": { ... },
   "storeSizeBytes": number,
   "tags": { 
      "string" : "string" 
   },
   "updateTime": "string"
}
```

## Response Elements
<a name="API_GetAnnotationStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [description](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-description"></a>
The store's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

 ** [id](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-id"></a>
The store's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-name"></a>
The store's name.  
Type: String

 ** [numVersions](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-numVersions"></a>
 An integer indicating how many versions of an annotation store exist.   
Type: Integer

 ** [reference](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-reference"></a>
The store's genome reference.  
Type: [ReferenceItem](API_ReferenceItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [sseConfig](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-sseConfig"></a>
The store's server-side encryption (SSE) settings.  
Type: [SseConfig](API_SseConfig.md) object

 ** [status](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-status"></a>
The store's status.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

 ** [statusMessage](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-statusMessage"></a>
A status message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

 ** [storeArn](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-storeArn"></a>
The store's ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` 

 ** [storeFormat](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-storeFormat"></a>
The store's annotation file format.  
Type: String  
Valid Values: `GFF | TSV | VCF` 

 ** [storeOptions](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-storeOptions"></a>
The store's parsing options.  
Type: [StoreOptions](API_StoreOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [storeSizeBytes](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-storeSizeBytes"></a>
The store's size in bytes.  
Type: Long

 ** [tags](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-tags"></a>
The store's tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [updateTime](#API_GetAnnotationStore_ResponseSyntax) **   <a name="omics-GetAnnotationStore-response-updateTime"></a>
When the store was updated.  
Type: Timestamp

## Errors
<a name="API_GetAnnotationStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetAnnotationStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetAnnotationStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetAnnotationStore) 

# GetAnnotationStoreVersion
<a name="API_GetAnnotationStoreVersion"></a>

 Retrieves the metadata for an annotation store version. 

## Request Syntax
<a name="API_GetAnnotationStoreVersion_RequestSyntax"></a>

```
GET /annotationStore/name/version/versionName HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAnnotationStoreVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_GetAnnotationStoreVersion_RequestSyntax) **   <a name="omics-GetAnnotationStoreVersion-request-uri-name"></a>
 The name given to an annotation store version to distinguish it from others.   
Required: Yes

 ** [versionName](#API_GetAnnotationStoreVersion_RequestSyntax) **   <a name="omics-GetAnnotationStoreVersion-request-uri-versionName"></a>
 The name given to an annotation store version to distinguish it from others.   
Required: Yes

## Request Body
<a name="API_GetAnnotationStoreVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAnnotationStoreVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "statusMessage": "string",
   "storeId": "string",
   "tags": { 
      "string" : "string" 
   },
   "updateTime": "string",
   "versionArn": "string",
   "versionName": "string",
   "versionOptions": { ... },
   "versionSizeBytes": number
}
```

## Response Elements
<a name="API_GetAnnotationStoreVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-creationTime"></a>
 The time stamp for when an annotation store version was created.   
Type: Timestamp

 ** [description](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-description"></a>
 The description for an annotation store version.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

 ** [id](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-id"></a>
 The annotation store version ID.   
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-name"></a>
 The name of the annotation store.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

 ** [status](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-status"></a>
 The status of an annotation store version.   
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

 ** [statusMessage](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-statusMessage"></a>
 The status of an annotation store version.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

 ** [storeId](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-storeId"></a>
 The store ID for annotation store version.   
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [tags](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-tags"></a>
 Any tags associated with an annotation store version.   
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [updateTime](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-updateTime"></a>
 The time stamp for when an annotation store version was updated.   
Type: Timestamp

 ** [versionArn](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-versionArn"></a>
 The Arn for the annotation store.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` 

 ** [versionName](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-versionName"></a>
 The name given to an annotation store version to distinguish it from others.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

 ** [versionOptions](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-versionOptions"></a>
 The options for an annotation store version.   
Type: [VersionOptions](API_VersionOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [versionSizeBytes](#API_GetAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-GetAnnotationStoreVersion-response-versionSizeBytes"></a>
 The size of the annotation store version in Bytes.   
Type: Long

## Errors
<a name="API_GetAnnotationStoreVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetAnnotationStoreVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetAnnotationStoreVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetAnnotationStoreVersion) 

# GetBatch
<a name="API_GetBatch"></a>

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

## Request Syntax
<a name="API_GetBatch_RequestSyntax"></a>

```
GET /runBatch/batchId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBatch_RequestParameters"></a>

The request uses the following URI parameters.

 ** [batchId](#API_GetBatch_RequestSyntax) **   <a name="omics-GetBatch-request-uri-batchId"></a>
The identifier portion of the run batch ARN.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetBatch_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBatch_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "defaultRunSetting": { 
      "cacheBehavior": "string",
      "cacheId": "string",
      "logLevel": "string",
      "name": "string",
      "outputBucketOwnerId": "string",
      "outputUri": "string",
      "parameters": JSON value,
      "priority": number,
      "retentionMode": "string",
      "roleArn": "string",
      "runGroupId": "string",
      "runTags": { 
         "string" : "string" 
      },
      "storageCapacity": number,
      "storageType": "string",
      "workflowId": "string",
      "workflowOwnerId": "string",
      "workflowType": "string",
      "workflowVersionName": "string"
   },
   "failedTime": "string",
   "failureReason": "string",
   "id": "string",
   "name": "string",
   "processedTime": "string",
   "runSummary": { 
      "cancelledRunCount": number,
      "completedRunCount": number,
      "deletedRunCount": number,
      "failedRunCount": number,
      "pendingRunCount": number,
      "runningRunCount": number,
      "startingRunCount": number,
      "stoppingRunCount": number
   },
   "status": "string",
   "submissionSummary": { 
      "failedCancelSubmissionCount": number,
      "failedDeleteSubmissionCount": number,
      "failedStartSubmissionCount": number,
      "pendingStartSubmissionCount": number,
      "successfulCancelSubmissionCount": number,
      "successfulDeleteSubmissionCount": number,
      "successfulStartSubmissionCount": number
   },
   "submittedTime": "string",
   "tags": { 
      "string" : "string" 
   },
   "totalRuns": number,
   "uuid": "string"
}
```

## Response Elements
<a name="API_GetBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-arn"></a>
The unique ARN of the run batch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [creationTime](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-creationTime"></a>
The timestamp when the batch was created.  
Type: Timestamp

 ** [defaultRunSetting](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-defaultRunSetting"></a>
The shared configuration applied to all runs in the batch. See `DefaultRunSetting`.  
Type: [DefaultRunSetting](API_DefaultRunSetting.md) object

 ** [failedTime](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-failedTime"></a>
The timestamp when the batch transitioned to a `FAILED` status.  
Type: Timestamp

 ** [failureReason](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-failureReason"></a>
A description of the batch failure. Present only when status is `FAILED`.  
Type: String

 ** [id](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-id"></a>
The identifier portion of the run batch ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [name](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-name"></a>
The optional user-friendly name of the batch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [processedTime](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-processedTime"></a>
The timestamp when all run executions completed.  
Type: Timestamp

 ** [runSummary](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-runSummary"></a>
A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches `PROCESSED` status. See `RunSummary`.  
Type: [RunSummary](API_RunSummary.md) object

 ** [status](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-status"></a>
The current status of the run batch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PENDING | SUBMITTING | INPROGRESS | STOPPING | CANCELLED | FAILED | PROCESSED | RUNS_DELETING | RUNS_DELETED` 

 ** [submissionSummary](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-submissionSummary"></a>
A summary of run submission outcomes. See `SubmissionSummary`.  
Type: [SubmissionSummary](API_SubmissionSummary.md) object

 ** [submittedTime](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-submittedTime"></a>
The timestamp when all run submissions completed.  
Type: Timestamp

 ** [tags](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-tags"></a>
AWS tags associated with the run batch.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [totalRuns](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-totalRuns"></a>
The total number of runs in the batch.  
Type: Integer

 ** [uuid](#API_GetBatch_ResponseSyntax) **   <a name="omics-GetBatch-response-uuid"></a>
The universally unique identifier (UUID) for the run batch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_GetBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetBatch) 

# GetConfiguration
<a name="API_GetConfiguration"></a>

Retrieve configuration details for specified name.

## Request Syntax
<a name="API_GetConfiguration_RequestSyntax"></a>

```
GET /configuration/name HTTP/1.1
```

## URI Request Parameters
<a name="API_GetConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_GetConfiguration_RequestSyntax) **   <a name="omics-GetConfiguration-request-uri-name"></a>
Configuration name to retrieve.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: Yes

## Request Body
<a name="API_GetConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "description": "string",
   "name": "string",
   "runConfigurations": { 
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "uuid": "string"
}
```

## Response Elements
<a name="API_GetConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetConfiguration_ResponseSyntax) **   <a name="omics-GetConfiguration-response-arn"></a>
Unique resource identifier for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 190.  
Pattern: `arn:.+` 

 ** [creationTime](#API_GetConfiguration_ResponseSyntax) **   <a name="omics-GetConfiguration-response-creationTime"></a>
Configuration creation timestamp.  
Type: Timestamp

 ** [description](#API_GetConfiguration_ResponseSyntax) **   <a name="omics-GetConfiguration-response-description"></a>
Description for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [name](#API_GetConfiguration_ResponseSyntax) **   <a name="omics-GetConfiguration-response-name"></a>
User-friendly name for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*` 

 ** [runConfigurations](#API_GetConfiguration_ResponseSyntax) **   <a name="omics-GetConfiguration-response-runConfigurations"></a>
Run-specific configurations.  
Type: [RunConfigurationsResponse](API_RunConfigurationsResponse.md) object

 ** [status](#API_GetConfiguration_ResponseSyntax) **   <a name="omics-GetConfiguration-response-status"></a>
Current configuration status.  
Type: String  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | DELETED | FAILED` 

 ** [tags](#API_GetConfiguration_ResponseSyntax) **   <a name="omics-GetConfiguration-response-tags"></a>
Tags for the configuration.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [uuid](#API_GetConfiguration_ResponseSyntax) **   <a name="omics-GetConfiguration-response-uuid"></a>
Unique identifier for the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_GetConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetConfiguration) 

# GetReadSet
<a name="API_GetReadSet"></a>

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.

## Request Syntax
<a name="API_GetReadSet_RequestSyntax"></a>

```
GET /sequencestore/sequenceStoreId/readset/id?file=file&partNumber=partNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReadSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [file](#API_GetReadSet_RequestSyntax) **   <a name="omics-GetReadSet-request-uri-file"></a>
The file to retrieve.  
Valid Values: `SOURCE1 | SOURCE2 | INDEX` 

 ** [id](#API_GetReadSet_RequestSyntax) **   <a name="omics-GetReadSet-request-uri-id"></a>
The read set's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [partNumber](#API_GetReadSet_RequestSyntax) **   <a name="omics-GetReadSet-request-uri-partNumber"></a>
The part number to retrieve.  
Valid Range: Minimum value of 1. Maximum value of 10000.  
Required: Yes

 ** [sequenceStoreId](#API_GetReadSet_RequestSyntax) **   <a name="omics-GetReadSet-request-uri-sequenceStoreId"></a>
The read set's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReadSet_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReadSet_ResponseSyntax"></a>

```
HTTP/1.1 200

payload
```

## Response Elements
<a name="API_GetReadSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following as the HTTP body.

 ** [payload](#API_GetReadSet_ResponseSyntax) **   <a name="omics-GetReadSet-response-payload"></a>
The read set file payload.

## Errors
<a name="API_GetReadSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RangeNotSatisfiableException **   
The ranges specified in the request are not valid.  
HTTP Status Code: 416

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReadSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReadSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReadSet) 

# GetReadSetActivationJob
<a name="API_GetReadSetActivationJob"></a>

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

## Request Syntax
<a name="API_GetReadSetActivationJob_RequestSyntax"></a>

```
GET /sequencestore/sequenceStoreId/activationjob/id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReadSetActivationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetReadSetActivationJob_RequestSyntax) **   <a name="omics-GetReadSetActivationJob-request-uri-id"></a>
The job's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [sequenceStoreId](#API_GetReadSetActivationJob_RequestSyntax) **   <a name="omics-GetReadSetActivationJob-request-uri-sequenceStoreId"></a>
The job's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReadSetActivationJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReadSetActivationJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "completionTime": "string",
   "creationTime": "string",
   "id": "string",
   "sequenceStoreId": "string",
   "sources": [ 
      { 
         "readSetId": "string",
         "status": "string",
         "statusMessage": "string"
      }
   ],
   "status": "string",
   "statusMessage": "string"
}
```

## Response Elements
<a name="API_GetReadSetActivationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [completionTime](#API_GetReadSetActivationJob_ResponseSyntax) **   <a name="omics-GetReadSetActivationJob-response-completionTime"></a>
When the job completed.  
Type: Timestamp

 ** [creationTime](#API_GetReadSetActivationJob_ResponseSyntax) **   <a name="omics-GetReadSetActivationJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [id](#API_GetReadSetActivationJob_ResponseSyntax) **   <a name="omics-GetReadSetActivationJob-response-id"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [sequenceStoreId](#API_GetReadSetActivationJob_ResponseSyntax) **   <a name="omics-GetReadSetActivationJob-response-sequenceStoreId"></a>
The job's sequence store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [sources](#API_GetReadSetActivationJob_ResponseSyntax) **   <a name="omics-GetReadSetActivationJob-response-sources"></a>
The job's source files.  
Type: Array of [ActivateReadSetSourceItem](API_ActivateReadSetSourceItem.md) objects

 ** [status](#API_GetReadSetActivationJob_ResponseSyntax) **   <a name="omics-GetReadSetActivationJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` 

 ** [statusMessage](#API_GetReadSetActivationJob_ResponseSyntax) **   <a name="omics-GetReadSetActivationJob-response-statusMessage"></a>
The job's status message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_GetReadSetActivationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReadSetActivationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReadSetActivationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReadSetActivationJob) 

# GetReadSetExportJob
<a name="API_GetReadSetExportJob"></a>

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.

## Request Syntax
<a name="API_GetReadSetExportJob_RequestSyntax"></a>

```
GET /sequencestore/sequenceStoreId/exportjob/id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReadSetExportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetReadSetExportJob_RequestSyntax) **   <a name="omics-GetReadSetExportJob-request-uri-id"></a>
The job's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [sequenceStoreId](#API_GetReadSetExportJob_RequestSyntax) **   <a name="omics-GetReadSetExportJob-request-uri-sequenceStoreId"></a>
The job's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReadSetExportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReadSetExportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "completionTime": "string",
   "creationTime": "string",
   "destination": "string",
   "id": "string",
   "readSets": [ 
      { 
         "id": "string",
         "status": "string",
         "statusMessage": "string"
      }
   ],
   "sequenceStoreId": "string",
   "status": "string",
   "statusMessage": "string"
}
```

## Response Elements
<a name="API_GetReadSetExportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [completionTime](#API_GetReadSetExportJob_ResponseSyntax) **   <a name="omics-GetReadSetExportJob-response-completionTime"></a>
When the job completed.  
Type: Timestamp

 ** [creationTime](#API_GetReadSetExportJob_ResponseSyntax) **   <a name="omics-GetReadSetExportJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [destination](#API_GetReadSetExportJob_ResponseSyntax) **   <a name="omics-GetReadSetExportJob-response-destination"></a>
The job's destination in Amazon S3.  
Type: String  
Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?` 

 ** [id](#API_GetReadSetExportJob_ResponseSyntax) **   <a name="omics-GetReadSetExportJob-response-id"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [readSets](#API_GetReadSetExportJob_ResponseSyntax) **   <a name="omics-GetReadSetExportJob-response-readSets"></a>
The job's read sets.  
Type: Array of [ExportReadSetDetail](API_ExportReadSetDetail.md) objects

 ** [sequenceStoreId](#API_GetReadSetExportJob_ResponseSyntax) **   <a name="omics-GetReadSetExportJob-response-sequenceStoreId"></a>
The job's sequence store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [status](#API_GetReadSetExportJob_ResponseSyntax) **   <a name="omics-GetReadSetExportJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` 

 ** [statusMessage](#API_GetReadSetExportJob_ResponseSyntax) **   <a name="omics-GetReadSetExportJob-response-statusMessage"></a>
The job's status message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_GetReadSetExportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReadSetExportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReadSetExportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReadSetExportJob) 

# GetReadSetImportJob
<a name="API_GetReadSetImportJob"></a>

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

## Request Syntax
<a name="API_GetReadSetImportJob_RequestSyntax"></a>

```
GET /sequencestore/sequenceStoreId/importjob/id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReadSetImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetReadSetImportJob_RequestSyntax) **   <a name="omics-GetReadSetImportJob-request-uri-id"></a>
The job's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [sequenceStoreId](#API_GetReadSetImportJob_RequestSyntax) **   <a name="omics-GetReadSetImportJob-request-uri-sequenceStoreId"></a>
The job's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReadSetImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReadSetImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "completionTime": "string",
   "creationTime": "string",
   "id": "string",
   "roleArn": "string",
   "sequenceStoreId": "string",
   "sources": [ 
      { 
         "description": "string",
         "generatedFrom": "string",
         "name": "string",
         "readSetId": "string",
         "referenceArn": "string",
         "sampleId": "string",
         "sourceFiles": { 
            "source1": "string",
            "source2": "string"
         },
         "sourceFileType": "string",
         "status": "string",
         "statusMessage": "string",
         "subjectId": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "status": "string",
   "statusMessage": "string"
}
```

## Response Elements
<a name="API_GetReadSetImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [completionTime](#API_GetReadSetImportJob_ResponseSyntax) **   <a name="omics-GetReadSetImportJob-response-completionTime"></a>
When the job completed.  
Type: Timestamp

 ** [creationTime](#API_GetReadSetImportJob_ResponseSyntax) **   <a name="omics-GetReadSetImportJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [id](#API_GetReadSetImportJob_ResponseSyntax) **   <a name="omics-GetReadSetImportJob-response-id"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [roleArn](#API_GetReadSetImportJob_ResponseSyntax) **   <a name="omics-GetReadSetImportJob-response-roleArn"></a>
The job's service role ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*` 

 ** [sequenceStoreId](#API_GetReadSetImportJob_ResponseSyntax) **   <a name="omics-GetReadSetImportJob-response-sequenceStoreId"></a>
The job's sequence store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [sources](#API_GetReadSetImportJob_ResponseSyntax) **   <a name="omics-GetReadSetImportJob-response-sources"></a>
The job's source files.  
Type: Array of [ImportReadSetSourceItem](API_ImportReadSetSourceItem.md) objects

 ** [status](#API_GetReadSetImportJob_ResponseSyntax) **   <a name="omics-GetReadSetImportJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` 

 ** [statusMessage](#API_GetReadSetImportJob_ResponseSyntax) **   <a name="omics-GetReadSetImportJob-response-statusMessage"></a>
The job's status message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_GetReadSetImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReadSetImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReadSetImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReadSetImportJob) 

# GetReadSetMetadata
<a name="API_GetReadSetMetadata"></a>

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.

## Request Syntax
<a name="API_GetReadSetMetadata_RequestSyntax"></a>

```
GET /sequencestore/sequenceStoreId/readset/id/metadata HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReadSetMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetReadSetMetadata_RequestSyntax) **   <a name="omics-GetReadSetMetadata-request-uri-id"></a>
The read set's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [sequenceStoreId](#API_GetReadSetMetadata_RequestSyntax) **   <a name="omics-GetReadSetMetadata-request-uri-sequenceStoreId"></a>
The read set's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReadSetMetadata_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReadSetMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationJobId": "string",
   "creationTime": "string",
   "creationType": "string",
   "description": "string",
   "etag": { 
      "algorithm": "string",
      "source1": "string",
      "source2": "string"
   },
   "files": { 
      "index": { 
         "contentLength": number,
         "partSize": number,
         "s3Access": { 
            "s3Uri": "string"
         },
         "totalParts": number
      },
      "source1": { 
         "contentLength": number,
         "partSize": number,
         "s3Access": { 
            "s3Uri": "string"
         },
         "totalParts": number
      },
      "source2": { 
         "contentLength": number,
         "partSize": number,
         "s3Access": { 
            "s3Uri": "string"
         },
         "totalParts": number
      }
   },
   "fileType": "string",
   "id": "string",
   "name": "string",
   "referenceArn": "string",
   "sampleId": "string",
   "sequenceInformation": { 
      "alignment": "string",
      "generatedFrom": "string",
      "totalBaseCount": number,
      "totalReadCount": number
   },
   "sequenceStoreId": "string",
   "status": "string",
   "statusMessage": "string",
   "subjectId": "string"
}
```

## Response Elements
<a name="API_GetReadSetMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-arn"></a>
The read set's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [creationJobId](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-creationJobId"></a>
The read set's creation job ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-zA-Z0-9]+` 

 ** [creationTime](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-creationTime"></a>
When the read set was created.  
Type: Timestamp

 ** [creationType](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-creationType"></a>
 The creation type of the read set.   
Type: String  
Valid Values: `IMPORT | UPLOAD` 

 ** [description](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-description"></a>
The read set's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [etag](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-etag"></a>
The entity tag (ETag) is a hash of the object meant to represent its semantic content.  
Type: [ETag](API_ETag.md) object

 ** [files](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-files"></a>
The read set's files.  
Type: [ReadSetFiles](API_ReadSetFiles.md) object

 ** [fileType](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-fileType"></a>
The read set's file type.  
Type: String  
Valid Values: `FASTQ | BAM | CRAM | UBAM` 

 ** [id](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-id"></a>
The read set's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [name](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-name"></a>
The read set's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [referenceArn](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-referenceArn"></a>
The read set's genome reference ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [sampleId](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-sampleId"></a>
The read set's sample ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceInformation](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-sequenceInformation"></a>
The read set's sequence information.  
Type: [SequenceInformation](API_SequenceInformation.md) object

 ** [sequenceStoreId](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-sequenceStoreId"></a>
The read set's sequence store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [status](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-status"></a>
The read set's status.  
Type: String  
Valid Values: `ARCHIVED | ACTIVATING | ACTIVE | DELETING | DELETED | PROCESSING_UPLOAD | UPLOAD_FAILED` 

 ** [statusMessage](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-statusMessage"></a>
The status message for a read set. It provides more detail as to why the read set has a status.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [subjectId](#API_GetReadSetMetadata_ResponseSyntax) **   <a name="omics-GetReadSetMetadata-response-subjectId"></a>
The read set's subject ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_GetReadSetMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReadSetMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReadSetMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReadSetMetadata) 

# GetReference
<a name="API_GetReference"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_GetReference_RequestSyntax"></a>

```
GET /referencestore/referenceStoreId/reference/id?file=file&partNumber=partNumber HTTP/1.1
Range: range
```

## URI Request Parameters
<a name="API_GetReference_RequestParameters"></a>

The request uses the following URI parameters.

 ** [file](#API_GetReference_RequestSyntax) **   <a name="omics-GetReference-request-uri-file"></a>
The file to retrieve.  
Valid Values: `SOURCE | INDEX` 

 ** [id](#API_GetReference_RequestSyntax) **   <a name="omics-GetReference-request-uri-id"></a>
The reference's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [partNumber](#API_GetReference_RequestSyntax) **   <a name="omics-GetReference-request-uri-partNumber"></a>
The part number to retrieve.  
Valid Range: Minimum value of 1. Maximum value of 10000.  
Required: Yes

 ** [range](#API_GetReference_RequestSyntax) **   <a name="omics-GetReference-request-range"></a>
The range to retrieve.  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{N}||\p{P}]+` 

 ** [referenceStoreId](#API_GetReference_RequestSyntax) **   <a name="omics-GetReference-request-uri-referenceStoreId"></a>
The reference's store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReference_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReference_ResponseSyntax"></a>

```
HTTP/1.1 200

payload
```

## Response Elements
<a name="API_GetReference_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following as the HTTP body.

 ** [payload](#API_GetReference_ResponseSyntax) **   <a name="omics-GetReference-response-payload"></a>
The reference file payload.

## Errors
<a name="API_GetReference_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RangeNotSatisfiableException **   
The ranges specified in the request are not valid.  
HTTP Status Code: 416

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReference) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReference) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReference) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReference) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReference) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReference) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReference) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReference) 

# GetReferenceImportJob
<a name="API_GetReferenceImportJob"></a>

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

## Request Syntax
<a name="API_GetReferenceImportJob_RequestSyntax"></a>

```
GET /referencestore/referenceStoreId/importjob/id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReferenceImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetReferenceImportJob_RequestSyntax) **   <a name="omics-GetReferenceImportJob-request-uri-id"></a>
The job's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [referenceStoreId](#API_GetReferenceImportJob_RequestSyntax) **   <a name="omics-GetReferenceImportJob-request-uri-referenceStoreId"></a>
The job's reference store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReferenceImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReferenceImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "completionTime": "string",
   "creationTime": "string",
   "id": "string",
   "referenceStoreId": "string",
   "roleArn": "string",
   "sources": [ 
      { 
         "description": "string",
         "name": "string",
         "referenceId": "string",
         "sourceFile": "string",
         "status": "string",
         "statusMessage": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "status": "string",
   "statusMessage": "string"
}
```

## Response Elements
<a name="API_GetReferenceImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [completionTime](#API_GetReferenceImportJob_ResponseSyntax) **   <a name="omics-GetReferenceImportJob-response-completionTime"></a>
When the job completed.  
Type: Timestamp

 ** [creationTime](#API_GetReferenceImportJob_ResponseSyntax) **   <a name="omics-GetReferenceImportJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [id](#API_GetReferenceImportJob_ResponseSyntax) **   <a name="omics-GetReferenceImportJob-response-id"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [referenceStoreId](#API_GetReferenceImportJob_ResponseSyntax) **   <a name="omics-GetReferenceImportJob-response-referenceStoreId"></a>
The job's reference store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [roleArn](#API_GetReferenceImportJob_ResponseSyntax) **   <a name="omics-GetReferenceImportJob-response-roleArn"></a>
The job's service role ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*` 

 ** [sources](#API_GetReferenceImportJob_ResponseSyntax) **   <a name="omics-GetReferenceImportJob-response-sources"></a>
The job's source files.  
Type: Array of [ImportReferenceSourceItem](API_ImportReferenceSourceItem.md) objects

 ** [status](#API_GetReferenceImportJob_ResponseSyntax) **   <a name="omics-GetReferenceImportJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` 

 ** [statusMessage](#API_GetReferenceImportJob_ResponseSyntax) **   <a name="omics-GetReferenceImportJob-response-statusMessage"></a>
The job's status message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_GetReferenceImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReferenceImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReferenceImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReferenceImportJob) 

# GetReferenceMetadata
<a name="API_GetReferenceMetadata"></a>

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.

## Request Syntax
<a name="API_GetReferenceMetadata_RequestSyntax"></a>

```
GET /referencestore/referenceStoreId/reference/id/metadata HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReferenceMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetReferenceMetadata_RequestSyntax) **   <a name="omics-GetReferenceMetadata-request-uri-id"></a>
The reference's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [referenceStoreId](#API_GetReferenceMetadata_RequestSyntax) **   <a name="omics-GetReferenceMetadata-request-uri-referenceStoreId"></a>
The reference's reference store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReferenceMetadata_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReferenceMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationJobId": "string",
   "creationTime": "string",
   "creationType": "string",
   "description": "string",
   "files": { 
      "index": { 
         "contentLength": number,
         "partSize": number,
         "s3Access": { 
            "s3Uri": "string"
         },
         "totalParts": number
      },
      "source": { 
         "contentLength": number,
         "partSize": number,
         "s3Access": { 
            "s3Uri": "string"
         },
         "totalParts": number
      }
   },
   "id": "string",
   "md5": "string",
   "name": "string",
   "referenceStoreId": "string",
   "status": "string",
   "updateTime": "string"
}
```

## Response Elements
<a name="API_GetReferenceMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-arn"></a>
The reference's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [creationJobId](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-creationJobId"></a>
The reference's creation job ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[a-zA-Z0-9]+` 

 ** [creationTime](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-creationTime"></a>
When the reference was created.  
Type: Timestamp

 ** [creationType](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-creationType"></a>
The reference's creation type.  
Type: String  
Valid Values: `IMPORT` 

 ** [description](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-description"></a>
The reference's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [files](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-files"></a>
The reference's files.  
Type: [ReferenceFiles](API_ReferenceFiles.md) object

 ** [id](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-id"></a>
The reference's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [md5](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-md5"></a>
The reference's MD5 checksum.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{N}]+` 

 ** [name](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-name"></a>
The reference's name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [referenceStoreId](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-referenceStoreId"></a>
The reference's reference store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [status](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-status"></a>
The reference's status.  
Type: String  
Valid Values: `ACTIVE | DELETING | DELETED` 

 ** [updateTime](#API_GetReferenceMetadata_ResponseSyntax) **   <a name="omics-GetReferenceMetadata-response-updateTime"></a>
When the reference was updated.  
Type: Timestamp

## Errors
<a name="API_GetReferenceMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReferenceMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReferenceMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReferenceMetadata) 

# GetReferenceStore
<a name="API_GetReferenceStore"></a>

Gets information about a reference store.

## Request Syntax
<a name="API_GetReferenceStore_RequestSyntax"></a>

```
GET /referencestore/id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReferenceStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetReferenceStore_RequestSyntax) **   <a name="omics-GetReferenceStore-request-uri-id"></a>
The store's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetReferenceStore_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReferenceStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   }
}
```

## Response Elements
<a name="API_GetReferenceStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetReferenceStore_ResponseSyntax) **   <a name="omics-GetReferenceStore-response-arn"></a>
The store's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [creationTime](#API_GetReferenceStore_ResponseSyntax) **   <a name="omics-GetReferenceStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [description](#API_GetReferenceStore_ResponseSyntax) **   <a name="omics-GetReferenceStore-response-description"></a>
The store's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [id](#API_GetReferenceStore_ResponseSyntax) **   <a name="omics-GetReferenceStore-response-id"></a>
The store's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [name](#API_GetReferenceStore_ResponseSyntax) **   <a name="omics-GetReferenceStore-response-name"></a>
The store's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sseConfig](#API_GetReferenceStore_ResponseSyntax) **   <a name="omics-GetReferenceStore-response-sseConfig"></a>
The store's server-side encryption (SSE) settings.  
Type: [SseConfig](API_SseConfig.md) object

## Errors
<a name="API_GetReferenceStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetReferenceStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetReferenceStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetReferenceStore) 

# GetRun
<a name="API_GetRun"></a>

Gets detailed information about a specific run using its ID.

 AWS 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](https://docs.aws.amazon.com/omics/latest/dev/monitoring-cloudwatch-logs.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_GetRun_RequestSyntax"></a>

```
GET /run/id?export=export HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [export](#API_GetRun_RequestSyntax) **   <a name="omics-GetRun-request-uri-export"></a>
The run's export format.  
Array Members: Minimum number of 0 items. Maximum number of 32 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `DEFINITION` 

 ** [id](#API_GetRun_RequestSyntax) **   <a name="omics-GetRun-request-uri-id"></a>
The run's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRun_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accelerators": "string",
   "arn": "string",
   "batchId": "string",
   "cacheBehavior": "string",
   "cacheId": "string",
   "configuration": { 
      "arn": "string",
      "name": "string",
      "uuid": "string"
   },
   "creationTime": "string",
   "definition": "string",
   "digest": "string",
   "engineVersion": "string",
   "failureReason": "string",
   "id": "string",
   "logLevel": "string",
   "logLocation": { 
      "engineLogStream": "string",
      "runLogStream": "string"
   },
   "name": "string",
   "networkingMode": "string",
   "outputUri": "string",
   "parameters": JSON value,
   "priority": number,
   "resourceDigests": { 
      "string" : "string" 
   },
   "retentionMode": "string",
   "roleArn": "string",
   "runGroupId": "string",
   "runId": "string",
   "runOutputUri": "string",
   "startedBy": "string",
   "startTime": "string",
   "status": "string",
   "statusMessage": "string",
   "stopTime": "string",
   "storageCapacity": number,
   "storageType": "string",
   "tags": { 
      "string" : "string" 
   },
   "uuid": "string",
   "vpcConfig": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ],
      "vpcId": "string"
   },
   "workflowId": "string",
   "workflowOwnerId": "string",
   "workflowType": "string",
   "workflowUuid": "string",
   "workflowVersionName": "string"
}
```

## Response Elements
<a name="API_GetRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accelerators](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-accelerators"></a>
The computational accelerator used to run the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `GPU` 

 ** [arn](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-arn"></a>
The run's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [batchId](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-batchId"></a>
The run's batch ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [cacheBehavior](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-cacheBehavior"></a>
The run cache behavior for the run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CACHE_ON_FAILURE | CACHE_ALWAYS` 

 ** [cacheId](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-cacheId"></a>
The run cache associated with the run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [configuration](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-configuration"></a>
Configuration details for the workflow run.  
Type: [ConfigurationDetails](API_ConfigurationDetails.md) object

 ** [creationTime](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-creationTime"></a>
When the run was created.  
Type: Timestamp

 ** [definition](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-definition"></a>
The run's definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [digest](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-digest"></a>
The run's digest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [engineVersion](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-engineVersion"></a>
The actual Nextflow engine version that AWS HealthOmics used for the run. The other workflow definition languages don't provide a value for this field.  
Type: String  
Pattern: `[0-9]{2}.[0-9]{2}.[0-9]` 

 ** [failureReason](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-failureReason"></a>
The reason a run has failed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [id](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-id"></a>
The run's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [logLevel](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-logLevel"></a>
The run's log level.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `OFF | FATAL | ERROR | ALL` 

 ** [logLocation](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-logLocation"></a>
The location of the run log.  
Type: [RunLogLocation](API_RunLogLocation.md) object

 ** [name](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-name"></a>
The run's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [networkingMode](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-networkingMode"></a>
Configuration for run networking behavior. If absent, this will default to RESTRICTED.  
Type: String  
Valid Values: `RESTRICTED | VPC` 

 ** [outputUri](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-outputUri"></a>
The run's output URI.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 750.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [parameters](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-parameters"></a>
The run's parameters.  
Type: JSON value

 ** [priority](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-priority"></a>
The run's priority.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.

 ** [resourceDigests](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-resourceDigests"></a>
The run's resource digests.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 256.  
Key Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 64.  
Value Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [retentionMode](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-retentionMode"></a>
The run's retention mode.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `RETAIN | REMOVE` 

 ** [roleArn](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-roleArn"></a>
The run's service role ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [runGroupId](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-runGroupId"></a>
The run's group ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [runId](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-runId"></a>
The run's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [runOutputUri](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-runOutputUri"></a>
The destination for workflow outputs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 750.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [startedBy](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-startedBy"></a>
Who started the run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [startTime](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-startTime"></a>
When the run started.  
Type: Timestamp

 ** [status](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-status"></a>
The run's status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PENDING | STARTING | RUNNING | STOPPING | COMPLETED | DELETED | CANCELLED | FAILED` 

 ** [statusMessage](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-statusMessage"></a>
The run's status message.  
Type: String  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [stopTime](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-stopTime"></a>
The run's stop time.  
Type: Timestamp

 ** [storageCapacity](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-storageCapacity"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.

 ** [storageType](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-storageType"></a>
The run's storage type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `STATIC | DYNAMIC` 

 ** [tags](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-tags"></a>
The run's tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [uuid](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-uuid"></a>
The universally unique identifier for a run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [vpcConfig](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-vpcConfig"></a>
VPC configuration for the workflow run.  
Type: [VpcConfigResponse](API_VpcConfigResponse.md) object

 ** [workflowId](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-workflowId"></a>
The run's workflow ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [workflowOwnerId](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-workflowOwnerId"></a>
The ID of the workflow owner.  
Type: String  
Pattern: `[0-9]{12}` 

 ** [workflowType](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-workflowType"></a>
The run's workflow type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PRIVATE | READY2RUN` 

 ** [workflowUuid](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-workflowUuid"></a>
The universally unique identifier (UUID) value for the workflow.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` 

 ** [workflowVersionName](#API_GetRun_ResponseSyntax) **   <a name="omics-GetRun-response-workflowVersionName"></a>
The workflow version name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*` 

## Errors
<a name="API_GetRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetRun) 

# GetRunCache
<a name="API_GetRunCache"></a>

Retrieves detailed information about the specified run cache using its ID.

For more information, see [Call caching for AWS HealthOmics runs](https://docs.aws.amazon.com/omics/latest/dev/workflows-call-caching.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_GetRunCache_RequestSyntax"></a>

```
GET /runCache/id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRunCache_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetRunCache_RequestSyntax) **   <a name="omics-GetRunCache-request-uri-id"></a>
The identifier of the run cache to retrieve.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetRunCache_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRunCache_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "cacheBehavior": "string",
   "cacheBucketOwnerId": "string",
   "cacheS3Uri": "string",
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetRunCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-arn"></a>
Unique resource identifier for the run cache.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [cacheBehavior](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-cacheBehavior"></a>
The default cache behavior for runs using this cache.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CACHE_ON_FAILURE | CACHE_ALWAYS` 

 ** [cacheBucketOwnerId](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-cacheBucketOwnerId"></a>
The identifier of the bucket owner.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]+` 

 ** [cacheS3Uri](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-cacheS3Uri"></a>
The S3 URI where the cache data is stored.  
Type: String  
Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?` 

 ** [creationTime](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-creationTime"></a>
Creation time of the run cache (an ISO 8601 formatted string).  
Type: Timestamp

 ** [description](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-description"></a>
The run cache description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [id](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-id"></a>
The run cache ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [name](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-name"></a>
The run cache name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [status](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-status"></a>
The run cache status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `ACTIVE | DELETED | FAILED` 

 ** [tags](#API_GetRunCache_ResponseSyntax) **   <a name="omics-GetRunCache-response-tags"></a>
The tags associated with the run cache.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_GetRunCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetRunCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetRunCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetRunCache) 

# GetRunGroup
<a name="API_GetRunGroup"></a>

Gets information about a run group and returns its metadata.

## Request Syntax
<a name="API_GetRunGroup_RequestSyntax"></a>

```
GET /runGroup/id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRunGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetRunGroup_RequestSyntax) **   <a name="omics-GetRunGroup-request-uri-id"></a>
The group's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetRunGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRunGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "id": "string",
   "maxCpus": number,
   "maxDuration": number,
   "maxGpus": number,
   "maxRuns": number,
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetRunGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-arn"></a>
The group's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [creationTime](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-creationTime"></a>
When the group was created.  
Type: Timestamp

 ** [id](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-id"></a>
The group's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [maxCpus](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-maxCpus"></a>
The group's maximum number of CPUs to use.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.

 ** [maxDuration](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-maxDuration"></a>
The group's maximum run time in minutes.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.

 ** [maxGpus](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-maxGpus"></a>
The maximum GPUs that can be used by a run group.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.

 ** [maxRuns](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-maxRuns"></a>
The maximum number of concurrent runs for the group.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.

 ** [name](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-name"></a>
The group's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [tags](#API_GetRunGroup_ResponseSyntax) **   <a name="omics-GetRunGroup-response-tags"></a>
The group's tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_GetRunGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetRunGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetRunGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetRunGroup) 

# GetRunTask
<a name="API_GetRunTask"></a>

Gets detailed information about a run task using its ID.

## Request Syntax
<a name="API_GetRunTask_RequestSyntax"></a>

```
GET /run/id/task/taskId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRunTask_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetRunTask_RequestSyntax) **   <a name="omics-GetRunTask-request-uri-id"></a>
The workflow run ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

 ** [taskId](#API_GetRunTask_RequestSyntax) **   <a name="omics-GetRunTask-request-uri-taskId"></a>
The task's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetRunTask_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRunTask_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cacheHit": boolean,
   "cacheS3Uri": "string",
   "cpus": number,
   "creationTime": "string",
   "failureReason": "string",
   "gpus": number,
   "imageDetails": { 
      "image": "string",
      "imageDigest": "string",
      "sourceImage": "string"
   },
   "instanceType": "string",
   "logStream": "string",
   "memory": number,
   "name": "string",
   "startTime": "string",
   "status": "string",
   "statusMessage": "string",
   "stopTime": "string",
   "taskId": "string"
}
```

## Response Elements
<a name="API_GetRunTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cacheHit](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-cacheHit"></a>
Set to true if AWS HealthOmics found a matching entry in the run cache for this task.  
Type: Boolean

 ** [cacheS3Uri](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-cacheS3Uri"></a>
The S3 URI of the cache location.  
Type: String  
Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?` 

 ** [cpus](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-cpus"></a>
The task's CPU usage.  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [creationTime](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-creationTime"></a>
When the task was created.  
Type: Timestamp

 ** [failureReason](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-failureReason"></a>
The reason a task has failed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [gpus](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-gpus"></a>
The number of Graphics Processing Units (GPU) specified in the task.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [imageDetails](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-imageDetails"></a>
Details about the container image that this task uses.  
Type: [ImageDetails](API_ImageDetails.md) object

 ** [instanceType](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-instanceType"></a>
The instance type for a task.  
Type: String  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [logStream](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-logStream"></a>
The task's log stream.  
Type: String  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [memory](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-memory"></a>
The task's memory use in gigabytes.  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [name](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-name"></a>
The task's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [startTime](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-startTime"></a>
The task's start time.  
Type: Timestamp

 ** [status](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-status"></a>
The task's status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PENDING | STARTING | RUNNING | STOPPING | COMPLETED | CANCELLED | FAILED` 

 ** [statusMessage](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-statusMessage"></a>
The task's status message.  
Type: String  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [stopTime](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-stopTime"></a>
The task's stop time.  
Type: Timestamp

 ** [taskId](#API_GetRunTask_ResponseSyntax) **   <a name="omics-GetRunTask-response-taskId"></a>
The task's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

## Errors
<a name="API_GetRunTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetRunTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetRunTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetRunTask) 

# GetS3AccessPolicy
<a name="API_GetS3AccessPolicy"></a>

Retrieves details about an access policy on a given store.

## Request Syntax
<a name="API_GetS3AccessPolicy_RequestSyntax"></a>

```
GET /s3accesspolicy/s3AccessPointArn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetS3AccessPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [s3AccessPointArn](#API_GetS3AccessPolicy_RequestSyntax) **   <a name="omics-GetS3AccessPolicy-request-uri-s3AccessPointArn"></a>
The S3 access point ARN that has the access policy.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*`   
Required: Yes

## Request Body
<a name="API_GetS3AccessPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetS3AccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "s3AccessPointArn": "string",
   "s3AccessPolicy": "string",
   "storeId": "string",
   "storeType": "string",
   "updateTime": "string"
}
```

## Response Elements
<a name="API_GetS3AccessPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [s3AccessPointArn](#API_GetS3AccessPolicy_ResponseSyntax) **   <a name="omics-GetS3AccessPolicy-response-s3AccessPointArn"></a>
The S3 access point ARN that has the access policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*` 

 ** [s3AccessPolicy](#API_GetS3AccessPolicy_ResponseSyntax) **   <a name="omics-GetS3AccessPolicy-response-s3AccessPolicy"></a>
The current resource policy that controls S3 access on the store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.

 ** [storeId](#API_GetS3AccessPolicy_ResponseSyntax) **   <a name="omics-GetS3AccessPolicy-response-storeId"></a>
The AWS-generated Sequence Store or Reference Store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [storeType](#API_GetS3AccessPolicy_ResponseSyntax) **   <a name="omics-GetS3AccessPolicy-response-storeType"></a>
The type of store associated with the access point.  
Type: String  
Valid Values: `SEQUENCE_STORE | REFERENCE_STORE` 

 ** [updateTime](#API_GetS3AccessPolicy_ResponseSyntax) **   <a name="omics-GetS3AccessPolicy-response-updateTime"></a>
The time when the policy was last updated.  
Type: Timestamp

## Errors
<a name="API_GetS3AccessPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetS3AccessPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetS3AccessPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetS3AccessPolicy) 

# GetSequenceStore
<a name="API_GetSequenceStore"></a>

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

## Request Syntax
<a name="API_GetSequenceStore_RequestSyntax"></a>

```
GET /sequencestore/id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSequenceStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_GetSequenceStore_RequestSyntax) **   <a name="omics-GetSequenceStore-request-uri-id"></a>
The store's ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_GetSequenceStore_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSequenceStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "description": "string",
   "eTagAlgorithmFamily": "string",
   "fallbackLocation": "string",
   "id": "string",
   "name": "string",
   "propagatedSetLevelTags": [ "string" ],
   "s3Access": { 
      "accessLogLocation": "string",
      "s3AccessPointArn": "string",
      "s3Uri": "string"
   },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "status": "string",
   "statusMessage": "string",
   "updateTime": "string"
}
```

## Response Elements
<a name="API_GetSequenceStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-arn"></a>
The store's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [creationTime](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [description](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-description"></a>
The store's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [eTagAlgorithmFamily](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-eTagAlgorithmFamily"></a>
The algorithm family of the ETag.  
Type: String  
Valid Values: `MD5up | SHA256up | SHA512up` 

 ** [fallbackLocation](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-fallbackLocation"></a>
An S3 location that is used to store files that have failed a direct upload.  
Type: String  
Pattern: `$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?` 

 ** [id](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-id"></a>
The store's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [name](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-name"></a>
The store's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [propagatedSetLevelTags](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-propagatedSetLevelTags"></a>
The tags keys to propagate to the S3 objects associated with read sets in the sequence store.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [s3Access](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-s3Access"></a>
The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.  
Type: [SequenceStoreS3Access](API_SequenceStoreS3Access.md) object

 ** [sseConfig](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-sseConfig"></a>
The store's server-side encryption (SSE) settings.  
Type: [SseConfig](API_SseConfig.md) object

 ** [status](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-status"></a>
The status of the sequence store.  
Type: String  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | FAILED` 

 ** [statusMessage](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-statusMessage"></a>
The status message of the sequence store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [updateTime](#API_GetSequenceStore_ResponseSyntax) **   <a name="omics-GetSequenceStore-response-updateTime"></a>
The last-updated time of the sequence store.  
Type: Timestamp

## Errors
<a name="API_GetSequenceStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetSequenceStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetSequenceStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetSequenceStore) 

# GetShare
<a name="API_GetShare"></a>

Retrieves the metadata for the specified resource share.

## Request Syntax
<a name="API_GetShare_RequestSyntax"></a>

```
GET /share/shareId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetShare_RequestParameters"></a>

The request uses the following URI parameters.

 ** [shareId](#API_GetShare_RequestSyntax) **   <a name="omics-GetShare-request-uri-shareId"></a>
The ID of the share.  
Required: Yes

## Request Body
<a name="API_GetShare_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetShare_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "share": { 
      "creationTime": "string",
      "ownerId": "string",
      "principalSubscriber": "string",
      "resourceArn": "string",
      "resourceId": "string",
      "shareId": "string",
      "shareName": "string",
      "status": "string",
      "statusMessage": "string",
      "updateTime": "string"
   }
}
```

## Response Elements
<a name="API_GetShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [share](#API_GetShare_ResponseSyntax) **   <a name="omics-GetShare-response-share"></a>
A resource share details object. The object includes the status, the resourceArn, and ownerId.  
Type: [ShareDetails](API_ShareDetails.md) object

## Errors
<a name="API_GetShare_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetShare) 

# GetVariantImportJob
<a name="API_GetVariantImportJob"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Gets information about a variant import job.

## Request Syntax
<a name="API_GetVariantImportJob_RequestSyntax"></a>

```
GET /import/variant/jobId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetVariantImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobId](#API_GetVariantImportJob_RequestSyntax) **   <a name="omics-GetVariantImportJob-request-uri-jobId"></a>
The job's ID.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_GetVariantImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetVariantImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "annotationFields": { 
      "string" : "string" 
   },
   "completionTime": "string",
   "creationTime": "string",
   "destinationName": "string",
   "id": "string",
   "items": [ 
      { 
         "jobStatus": "string",
         "source": "string",
         "statusMessage": "string"
      }
   ],
   "roleArn": "string",
   "runLeftNormalization": boolean,
   "status": "string",
   "statusMessage": "string",
   "updateTime": "string"
}
```

## Response Elements
<a name="API_GetVariantImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [annotationFields](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-annotationFields"></a>
The annotation schema generated by the parsed annotation data.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 21.  
Value Length Constraints: Minimum length of 1. Maximum length of 21.

 ** [completionTime](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-completionTime"></a>
When the job completed.  
Type: Timestamp

 ** [creationTime](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [destinationName](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-destinationName"></a>
The job's destination variant store.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

 ** [id](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-id"></a>
The job's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [items](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-items"></a>
The job's items.  
Type: Array of [VariantImportItemDetail](API_VariantImportItemDetail.md) objects  
Array Members: Minimum number of 1 item.

 ** [roleArn](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-roleArn"></a>
The job's service role ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` 

 ** [runLeftNormalization](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-runLeftNormalization"></a>
The job's left normalization setting.  
Type: Boolean

 ** [status](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` 

 ** [statusMessage](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-statusMessage"></a>
The job's status message.  
Type: String

 ** [updateTime](#API_GetVariantImportJob_ResponseSyntax) **   <a name="omics-GetVariantImportJob-response-updateTime"></a>
When the job was updated.  
Type: Timestamp

## Errors
<a name="API_GetVariantImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetVariantImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetVariantImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetVariantImportJob) 

# GetVariantStore
<a name="API_GetVariantStore"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Gets information about a variant store.

## Request Syntax
<a name="API_GetVariantStore_RequestSyntax"></a>

```
GET /variantStore/name HTTP/1.1
```

## URI Request Parameters
<a name="API_GetVariantStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_GetVariantStore_RequestSyntax) **   <a name="omics-GetVariantStore-request-uri-name"></a>
The store's name.  
Required: Yes

## Request Body
<a name="API_GetVariantStore_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetVariantStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "reference": { ... },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "status": "string",
   "statusMessage": "string",
   "storeArn": "string",
   "storeSizeBytes": number,
   "tags": { 
      "string" : "string" 
   },
   "updateTime": "string"
}
```

## Response Elements
<a name="API_GetVariantStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [description](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-description"></a>
The store's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

 ** [id](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-id"></a>
The store's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-name"></a>
The store's name.  
Type: String

 ** [reference](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-reference"></a>
The store's genome reference.  
Type: [ReferenceItem](API_ReferenceItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [sseConfig](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-sseConfig"></a>
The store's server-side encryption (SSE) settings.  
Type: [SseConfig](API_SseConfig.md) object

 ** [status](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-status"></a>
The store's status.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

 ** [statusMessage](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-statusMessage"></a>
The store's status message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

 ** [storeArn](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-storeArn"></a>
The store's ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` 

 ** [storeSizeBytes](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-storeSizeBytes"></a>
The store's size in bytes.  
Type: Long

 ** [tags](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-tags"></a>
The store's tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [updateTime](#API_GetVariantStore_ResponseSyntax) **   <a name="omics-GetVariantStore-response-updateTime"></a>
When the store was updated.  
Type: Timestamp

## Errors
<a name="API_GetVariantStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetVariantStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetVariantStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetVariantStore) 

# GetWorkflow
<a name="API_GetWorkflow"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/using-get-workflow.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_GetWorkflow_RequestSyntax"></a>

```
GET /workflow/id?export=export&type=type&workflowOwnerId=workflowOwnerId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [export](#API_GetWorkflow_RequestSyntax) **   <a name="omics-GetWorkflow-request-uri-export"></a>
The export format for the workflow.  
Array Members: Minimum number of 0 items. Maximum number of 32 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `DEFINITION | README` 

 ** [id](#API_GetWorkflow_RequestSyntax) **   <a name="omics-GetWorkflow-request-uri-id"></a>
The workflow's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

 ** [type](#API_GetWorkflow_RequestSyntax) **   <a name="omics-GetWorkflow-request-uri-type"></a>
The workflow's type.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PRIVATE | READY2RUN` 

 ** [workflowOwnerId](#API_GetWorkflow_RequestSyntax) **   <a name="omics-GetWorkflow-request-uri-workflowOwnerId"></a>
The ID of the workflow owner.  
Pattern: `[0-9]{12}` 

## Request Body
<a name="API_GetWorkflow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accelerators": "string",
   "arn": "string",
   "containerRegistryMap": { 
      "imageMappings": [ 
         { 
            "destinationImage": "string",
            "sourceImage": "string"
         }
      ],
      "registryMappings": [ 
         { 
            "ecrAccountId": "string",
            "ecrRepositoryPrefix": "string",
            "upstreamRegistryUrl": "string",
            "upstreamRepositoryPrefix": "string"
         }
      ]
   },
   "creationTime": "string",
   "definition": "string",
   "definitionRepositoryDetails": { 
      "connectionArn": "string",
      "fullRepositoryId": "string",
      "providerEndpoint": "string",
      "providerType": "string",
      "sourceReference": { 
         "type": "string",
         "value": "string"
      }
   },
   "description": "string",
   "digest": "string",
   "engine": "string",
   "id": "string",
   "main": "string",
   "metadata": { 
      "string" : "string" 
   },
   "name": "string",
   "parameterTemplate": { 
      "string" : { 
         "description": "string",
         "optional": boolean
      }
   },
   "readme": "string",
   "readmePath": "string",
   "status": "string",
   "statusMessage": "string",
   "storageCapacity": number,
   "storageType": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string",
   "uuid": "string"
}
```

## Response Elements
<a name="API_GetWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accelerators](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-accelerators"></a>
The computational accelerator specified to run the workflow.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `GPU` 

 ** [arn](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-arn"></a>
The workflow's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [containerRegistryMap](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-containerRegistryMap"></a>
The registry map that this workflow is using.  
Type: [ContainerRegistryMap](API_ContainerRegistryMap.md) object

 ** [creationTime](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-creationTime"></a>
When the workflow was created.  
Type: Timestamp

 ** [definition](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-definition"></a>
The workflow's definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [definitionRepositoryDetails](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-definitionRepositoryDetails"></a>
Details about the source code repository that hosts the workflow definition files.  
Type: [DefinitionRepositoryDetails](API_DefinitionRepositoryDetails.md) object

 ** [description](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-description"></a>
The workflow's description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [digest](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-digest"></a>
The workflow's digest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [engine](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-engine"></a>
The workflow's engine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `WDL | NEXTFLOW | CWL | WDL_LENIENT` 

 ** [id](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-id"></a>
The workflow's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [main](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-main"></a>
The path of the main definition file for the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [metadata](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-metadata"></a>
Gets metadata for the workflow.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [name](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-name"></a>
The workflow's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [parameterTemplate](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-parameterTemplate"></a>
The workflow's parameter template.  
Type: String to [WorkflowParameter](API_WorkflowParameter.md) object map  
Map Entries: Maximum number of 2000 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [readme](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-readme"></a>
The README content for the workflow, providing documentation and usage information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [readmePath](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-readmePath"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [status](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-status"></a>
The workflow's status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETED | FAILED | INACTIVE` 

 ** [statusMessage](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-statusMessage"></a>
The workflow's status message.  
Type: String  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [storageCapacity](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-storageCapacity"></a>
The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.

 ** [storageType](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-storageType"></a>
The default storage type for runs using this workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `STATIC | DYNAMIC` 

 ** [tags](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-tags"></a>
The workflow's tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [type](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-type"></a>
The workflow's type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PRIVATE | READY2RUN` 

 ** [uuid](#API_GetWorkflow_ResponseSyntax) **   <a name="omics-GetWorkflow-response-uuid"></a>
The universally unique identifier (UUID) value for this workflow.  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` 

## Errors
<a name="API_GetWorkflow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetWorkflow) 

# GetWorkflowVersion
<a name="API_GetWorkflowVersion"></a>

Gets information about a workflow version. For more information, see [Workflow versioning in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_GetWorkflowVersion_RequestSyntax"></a>

```
GET /workflow/workflowId/version/versionName?export=export&type=type&workflowOwnerId=workflowOwnerId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetWorkflowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [export](#API_GetWorkflowVersion_RequestSyntax) **   <a name="omics-GetWorkflowVersion-request-uri-export"></a>
The export format for the workflow.  
Array Members: Minimum number of 0 items. Maximum number of 32 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `DEFINITION | README` 

 ** [type](#API_GetWorkflowVersion_RequestSyntax) **   <a name="omics-GetWorkflowVersion-request-uri-type"></a>
The workflow's type.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PRIVATE | READY2RUN` 

 ** [versionName](#API_GetWorkflowVersion_RequestSyntax) **   <a name="omics-GetWorkflowVersion-request-uri-versionName"></a>
The workflow version name.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: Yes

 ** [workflowId](#API_GetWorkflowVersion_RequestSyntax) **   <a name="omics-GetWorkflowVersion-request-uri-workflowId"></a>
The workflow's ID. The `workflowId` is not the UUID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

 ** [workflowOwnerId](#API_GetWorkflowVersion_RequestSyntax) **   <a name="omics-GetWorkflowVersion-request-uri-workflowOwnerId"></a>
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.  
Pattern: `[0-9]{12}` 

## Request Body
<a name="API_GetWorkflowVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetWorkflowVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accelerators": "string",
   "arn": "string",
   "containerRegistryMap": { 
      "imageMappings": [ 
         { 
            "destinationImage": "string",
            "sourceImage": "string"
         }
      ],
      "registryMappings": [ 
         { 
            "ecrAccountId": "string",
            "ecrRepositoryPrefix": "string",
            "upstreamRegistryUrl": "string",
            "upstreamRepositoryPrefix": "string"
         }
      ]
   },
   "creationTime": "string",
   "definition": "string",
   "definitionRepositoryDetails": { 
      "connectionArn": "string",
      "fullRepositoryId": "string",
      "providerEndpoint": "string",
      "providerType": "string",
      "sourceReference": { 
         "type": "string",
         "value": "string"
      }
   },
   "description": "string",
   "digest": "string",
   "engine": "string",
   "main": "string",
   "metadata": { 
      "string" : "string" 
   },
   "parameterTemplate": { 
      "string" : { 
         "description": "string",
         "optional": boolean
      }
   },
   "readme": "string",
   "readmePath": "string",
   "status": "string",
   "statusMessage": "string",
   "storageCapacity": number,
   "storageType": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string",
   "uuid": "string",
   "versionName": "string",
   "workflowBucketOwnerId": "string",
   "workflowId": "string"
}
```

## Response Elements
<a name="API_GetWorkflowVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accelerators](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-accelerators"></a>
The accelerator for this workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `GPU` 

 ** [arn](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-arn"></a>
ARN of the workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 150.  
Pattern: `arn:.+` 

 ** [containerRegistryMap](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-containerRegistryMap"></a>
The registry map that this workflow version uses.  
Type: [ContainerRegistryMap](API_ContainerRegistryMap.md) object

 ** [creationTime](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-creationTime"></a>
When the workflow version was created.  
Type: Timestamp

 ** [definition](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-definition"></a>
Definition of the workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [definitionRepositoryDetails](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-definitionRepositoryDetails"></a>
Details about the source code repository that hosts the workflow version definition files.  
Type: [DefinitionRepositoryDetails](API_DefinitionRepositoryDetails.md) object

 ** [description](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-description"></a>
Description of the workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [digest](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-digest"></a>
The workflow version's digest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [engine](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-engine"></a>
The workflow engine for this workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `WDL | NEXTFLOW | CWL | WDL_LENIENT` 

 ** [main](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-main"></a>
The path of the main definition file for the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [metadata](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-metadata"></a>
The metadata for the workflow version.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [parameterTemplate](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-parameterTemplate"></a>
The parameter template for the workflow version.  
Type: String to [WorkflowParameter](API_WorkflowParameter.md) object map  
Map Entries: Maximum number of 2000 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [readme](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-readme"></a>
The README content for the workflow version, providing documentation and usage information specific to this version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [readmePath](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-readmePath"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [status](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-status"></a>
The workflow version status  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETED | FAILED | INACTIVE` 

 ** [statusMessage](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-statusMessage"></a>
The workflow version status message  
Type: String  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [storageCapacity](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-storageCapacity"></a>
The default run storage capacity for static storage.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.

 ** [storageType](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-storageType"></a>
The default storage type for the run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `STATIC | DYNAMIC` 

 ** [tags](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-tags"></a>
The workflow version tags  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [type](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-type"></a>
The workflow version type  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PRIVATE | READY2RUN` 

 ** [uuid](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-uuid"></a>
The universally unique identifier (UUID) value for this workflow version  
Type: String  
Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` 

 ** [versionName](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-versionName"></a>
The workflow version name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*` 

 ** [workflowBucketOwnerId](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-workflowBucketOwnerId"></a>
 AWS Id of the owner of the bucket.  
Type: String  
Pattern: `[0-9]{12}` 

 ** [workflowId](#API_GetWorkflowVersion_ResponseSyntax) **   <a name="omics-GetWorkflowVersion-response-workflowId"></a>
The workflow's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

## Errors
<a name="API_GetWorkflowVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetWorkflowVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/GetWorkflowVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/GetWorkflowVersion) 

# ListAnnotationImportJobs
<a name="API_ListAnnotationImportJobs"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Retrieves a list of annotation import jobs.

## Request Syntax
<a name="API_ListAnnotationImportJobs_RequestSyntax"></a>

```
POST /import/annotations?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "status": "string",
      "storeName": "string"
   },
   "ids": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListAnnotationImportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListAnnotationImportJobs_RequestSyntax) **   <a name="omics-ListAnnotationImportJobs-request-uri-maxResults"></a>
The maximum number of jobs to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListAnnotationImportJobs_RequestSyntax) **   <a name="omics-ListAnnotationImportJobs-request-uri-nextToken"></a>
Specifies the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 10000.

## Request Body
<a name="API_ListAnnotationImportJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListAnnotationImportJobs_RequestSyntax) **   <a name="omics-ListAnnotationImportJobs-request-filter"></a>
A filter to apply to the list.  
Type: [ListAnnotationImportJobsFilter](API_ListAnnotationImportJobsFilter.md) object  
Required: No

 ** [ids](#API_ListAnnotationImportJobs_RequestSyntax) **   <a name="omics-ListAnnotationImportJobs-request-ids"></a>
IDs of annotation import jobs to retrieve.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

## Response Syntax
<a name="API_ListAnnotationImportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "annotationImportJobs": [ 
      { 
         "annotationFields": { 
            "string" : "string" 
         },
         "completionTime": "string",
         "creationTime": "string",
         "destinationName": "string",
         "id": "string",
         "roleArn": "string",
         "runLeftNormalization": boolean,
         "status": "string",
         "updateTime": "string",
         "versionName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAnnotationImportJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [annotationImportJobs](#API_ListAnnotationImportJobs_ResponseSyntax) **   <a name="omics-ListAnnotationImportJobs-response-annotationImportJobs"></a>
A list of jobs.  
Type: Array of [AnnotationImportJobItem](API_AnnotationImportJobItem.md) objects

 ** [nextToken](#API_ListAnnotationImportJobs_ResponseSyntax) **   <a name="omics-ListAnnotationImportJobs-response-nextToken"></a>
Specifies the pagination token from a previous request to retrieve the next page of results.  
Type: String

## Errors
<a name="API_ListAnnotationImportJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListAnnotationImportJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListAnnotationImportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListAnnotationImportJobs) 

# ListAnnotationStores
<a name="API_ListAnnotationStores"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Retrieves a list of annotation stores.

## Request Syntax
<a name="API_ListAnnotationStores_RequestSyntax"></a>

```
POST /annotationStores?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "status": "string"
   },
   "ids": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListAnnotationStores_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListAnnotationStores_RequestSyntax) **   <a name="omics-ListAnnotationStores-request-uri-maxResults"></a>
The maximum number of stores to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListAnnotationStores_RequestSyntax) **   <a name="omics-ListAnnotationStores-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 10000.

## Request Body
<a name="API_ListAnnotationStores_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListAnnotationStores_RequestSyntax) **   <a name="omics-ListAnnotationStores-request-filter"></a>
A filter to apply to the list.  
Type: [ListAnnotationStoresFilter](API_ListAnnotationStoresFilter.md) object  
Required: No

 ** [ids](#API_ListAnnotationStores_RequestSyntax) **   <a name="omics-ListAnnotationStores-request-ids"></a>
IDs of stores to list.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

## Response Syntax
<a name="API_ListAnnotationStores_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "annotationStores": [ 
      { 
         "creationTime": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "reference": { ... },
         "sseConfig": { 
            "keyArn": "string",
            "type": "string"
         },
         "status": "string",
         "statusMessage": "string",
         "storeArn": "string",
         "storeFormat": "string",
         "storeSizeBytes": number,
         "updateTime": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAnnotationStores_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [annotationStores](#API_ListAnnotationStores_ResponseSyntax) **   <a name="omics-ListAnnotationStores-response-annotationStores"></a>
A list of stores.  
Type: Array of [AnnotationStoreItem](API_AnnotationStoreItem.md) objects

 ** [nextToken](#API_ListAnnotationStores_ResponseSyntax) **   <a name="omics-ListAnnotationStores-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String

## Errors
<a name="API_ListAnnotationStores_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListAnnotationStores_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListAnnotationStores) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListAnnotationStores) 

# ListAnnotationStoreVersions
<a name="API_ListAnnotationStoreVersions"></a>

 Lists the versions of an annotation store. 

## Request Syntax
<a name="API_ListAnnotationStoreVersions_RequestSyntax"></a>

```
POST /annotationStore/name/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "status": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListAnnotationStoreVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListAnnotationStoreVersions_RequestSyntax) **   <a name="omics-ListAnnotationStoreVersions-request-uri-maxResults"></a>
 The maximum number of annotation store versions to return in one page of results.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [name](#API_ListAnnotationStoreVersions_RequestSyntax) **   <a name="omics-ListAnnotationStoreVersions-request-uri-name"></a>
 The name of an annotation store.   
Required: Yes

 ** [nextToken](#API_ListAnnotationStoreVersions_RequestSyntax) **   <a name="omics-ListAnnotationStoreVersions-request-uri-nextToken"></a>
 Specifies the pagination token from a previous request to retrieve the next page of results.   
Length Constraints: Minimum length of 1. Maximum length of 10000.

## Request Body
<a name="API_ListAnnotationStoreVersions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListAnnotationStoreVersions_RequestSyntax) **   <a name="omics-ListAnnotationStoreVersions-request-filter"></a>
 A filter to apply to the list of annotation store versions.   
Type: [ListAnnotationStoreVersionsFilter](API_ListAnnotationStoreVersionsFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListAnnotationStoreVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "annotationStoreVersions": [ 
      { 
         "creationTime": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "status": "string",
         "statusMessage": "string",
         "storeId": "string",
         "updateTime": "string",
         "versionArn": "string",
         "versionName": "string",
         "versionSizeBytes": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAnnotationStoreVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [annotationStoreVersions](#API_ListAnnotationStoreVersions_ResponseSyntax) **   <a name="omics-ListAnnotationStoreVersions-response-annotationStoreVersions"></a>
 Lists all versions of an annotation store.   
Type: Array of [AnnotationStoreVersionItem](API_AnnotationStoreVersionItem.md) objects

 ** [nextToken](#API_ListAnnotationStoreVersions_ResponseSyntax) **   <a name="omics-ListAnnotationStoreVersions-response-nextToken"></a>
 Specifies the pagination token from a previous request to retrieve the next page of results.   
Type: String

## Errors
<a name="API_ListAnnotationStoreVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListAnnotationStoreVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListAnnotationStoreVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListAnnotationStoreVersions) 

# ListBatch
<a name="API_ListBatch"></a>

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

## Request Syntax
<a name="API_ListBatch_RequestSyntax"></a>

```
GET /runBatch?maxItems=maxItems&name=name&runGroupId=runGroupId&startingToken=startingToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListBatch_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxItems](#API_ListBatch_RequestSyntax) **   <a name="omics-ListBatch-request-uri-maxItems"></a>
The maximum number of batches to return. If not specified, defaults to 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [name](#API_ListBatch_RequestSyntax) **   <a name="omics-ListBatch-request-uri-name"></a>
Filter batches by name.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [runGroupId](#API_ListBatch_RequestSyntax) **   <a name="omics-ListBatch-request-uri-runGroupId"></a>
Filter batches by run group ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [startingToken](#API_ListBatch_RequestSyntax) **   <a name="omics-ListBatch-request-uri-startingToken"></a>
A pagination token returned from a prior `ListBatch` call.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [status](#API_ListBatch_RequestSyntax) **   <a name="omics-ListBatch-request-uri-status"></a>
Filter batches by status.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PENDING | SUBMITTING | INPROGRESS | STOPPING | CANCELLED | FAILED | PROCESSED | RUNS_DELETING | RUNS_DELETED` 

## Request Body
<a name="API_ListBatch_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListBatch_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "id": "string",
         "name": "string",
         "status": "string",
         "totalRuns": number,
         "workflowId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListBatch_ResponseSyntax) **   <a name="omics-ListBatch-response-items"></a>
A list of batch summary objects. See `BatchListItem`.  
Type: Array of [BatchListItem](API_BatchListItem.md) objects

 ** [nextToken](#API_ListBatch_ResponseSyntax) **   <a name="omics-ListBatch-response-nextToken"></a>
A pagination token to retrieve the next page of results. Absent when no further results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListBatch) 

# ListConfigurations
<a name="API_ListConfigurations"></a>

List all configurations for the account.

## Request Syntax
<a name="API_ListConfigurations_RequestSyntax"></a>

```
GET /configuration?maxResults=maxResults&startingToken=startingToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListConfigurations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListConfigurations_RequestSyntax) **   <a name="omics-ListConfigurations-request-uri-maxResults"></a>
Maximum number of results to return.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [startingToken](#API_ListConfigurations_RequestSyntax) **   <a name="omics-ListConfigurations-request-uri-startingToken"></a>
Pagination token for retrieving next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Request Body
<a name="API_ListConfigurations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListConfigurations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "description": "string",
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListConfigurations_ResponseSyntax) **   <a name="omics-ListConfigurations-response-items"></a>
List of configuration items.  
Type: Array of [ConfigurationListItem](API_ConfigurationListItem.md) objects

 ** [nextToken](#API_ListConfigurations_ResponseSyntax) **   <a name="omics-ListConfigurations-response-nextToken"></a>
Token for retrieving next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListConfigurations) 

# ListMultipartReadSetUploads
<a name="API_ListMultipartReadSetUploads"></a>

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. 

## Request Syntax
<a name="API_ListMultipartReadSetUploads_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/uploads?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListMultipartReadSetUploads_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListMultipartReadSetUploads_RequestSyntax) **   <a name="omics-ListMultipartReadSetUploads-request-uri-maxResults"></a>
The maximum number of multipart uploads returned in a page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListMultipartReadSetUploads_RequestSyntax) **   <a name="omics-ListMultipartReadSetUploads-request-uri-nextToken"></a>
Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceStoreId](#API_ListMultipartReadSetUploads_RequestSyntax) **   <a name="omics-ListMultipartReadSetUploads-request-uri-sequenceStoreId"></a>
The Sequence Store ID used for the multipart uploads.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_ListMultipartReadSetUploads_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListMultipartReadSetUploads_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "uploads": [ 
      { 
         "creationTime": "string",
         "description": "string",
         "generatedFrom": "string",
         "name": "string",
         "referenceArn": "string",
         "sampleId": "string",
         "sequenceStoreId": "string",
         "sourceFileType": "string",
         "subjectId": "string",
         "tags": { 
            "string" : "string" 
         },
         "uploadId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListMultipartReadSetUploads_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListMultipartReadSetUploads_ResponseSyntax) **   <a name="omics-ListMultipartReadSetUploads-response-nextToken"></a>
Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [uploads](#API_ListMultipartReadSetUploads_ResponseSyntax) **   <a name="omics-ListMultipartReadSetUploads-response-uploads"></a>
An array of multipart uploads.  
Type: Array of [MultipartReadSetUploadListItem](API_MultipartReadSetUploadListItem.md) objects

## Errors
<a name="API_ListMultipartReadSetUploads_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListMultipartReadSetUploads_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListMultipartReadSetUploads) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListMultipartReadSetUploads) 

# ListReadSetActivationJobs
<a name="API_ListReadSetActivationJobs"></a>

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.

## Request Syntax
<a name="API_ListReadSetActivationJobs_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/activationjobs?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string",
      "status": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListReadSetActivationJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListReadSetActivationJobs_RequestSyntax) **   <a name="omics-ListReadSetActivationJobs-request-uri-maxResults"></a>
The maximum number of read set activation jobs to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListReadSetActivationJobs_RequestSyntax) **   <a name="omics-ListReadSetActivationJobs-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceStoreId](#API_ListReadSetActivationJobs_RequestSyntax) **   <a name="omics-ListReadSetActivationJobs-request-uri-sequenceStoreId"></a>
The read set's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_ListReadSetActivationJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListReadSetActivationJobs_RequestSyntax) **   <a name="omics-ListReadSetActivationJobs-request-filter"></a>
A filter to apply to the list.  
Type: [ActivateReadSetFilter](API_ActivateReadSetFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListReadSetActivationJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "activationJobs": [ 
      { 
         "completionTime": "string",
         "creationTime": "string",
         "id": "string",
         "sequenceStoreId": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListReadSetActivationJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [activationJobs](#API_ListReadSetActivationJobs_ResponseSyntax) **   <a name="omics-ListReadSetActivationJobs-response-activationJobs"></a>
A list of jobs.  
Type: Array of [ActivateReadSetJobItem](API_ActivateReadSetJobItem.md) objects

 ** [nextToken](#API_ListReadSetActivationJobs_ResponseSyntax) **   <a name="omics-ListReadSetActivationJobs-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListReadSetActivationJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReadSetActivationJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListReadSetActivationJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListReadSetActivationJobs) 

# ListReadSetExportJobs
<a name="API_ListReadSetExportJobs"></a>

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.

## Request Syntax
<a name="API_ListReadSetExportJobs_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/exportjobs?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string",
      "status": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListReadSetExportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListReadSetExportJobs_RequestSyntax) **   <a name="omics-ListReadSetExportJobs-request-uri-maxResults"></a>
The maximum number of jobs to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListReadSetExportJobs_RequestSyntax) **   <a name="omics-ListReadSetExportJobs-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceStoreId](#API_ListReadSetExportJobs_RequestSyntax) **   <a name="omics-ListReadSetExportJobs-request-uri-sequenceStoreId"></a>
The jobs' sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_ListReadSetExportJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListReadSetExportJobs_RequestSyntax) **   <a name="omics-ListReadSetExportJobs-request-filter"></a>
A filter to apply to the list.  
Type: [ExportReadSetFilter](API_ExportReadSetFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListReadSetExportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "exportJobs": [ 
      { 
         "completionTime": "string",
         "creationTime": "string",
         "destination": "string",
         "id": "string",
         "sequenceStoreId": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListReadSetExportJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [exportJobs](#API_ListReadSetExportJobs_ResponseSyntax) **   <a name="omics-ListReadSetExportJobs-response-exportJobs"></a>
A list of jobs.  
Type: Array of [ExportReadSetJobDetail](API_ExportReadSetJobDetail.md) objects

 ** [nextToken](#API_ListReadSetExportJobs_ResponseSyntax) **   <a name="omics-ListReadSetExportJobs-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListReadSetExportJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReadSetExportJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListReadSetExportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListReadSetExportJobs) 

# ListReadSetImportJobs
<a name="API_ListReadSetImportJobs"></a>

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

## Request Syntax
<a name="API_ListReadSetImportJobs_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/importjobs?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string",
      "status": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListReadSetImportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListReadSetImportJobs_RequestSyntax) **   <a name="omics-ListReadSetImportJobs-request-uri-maxResults"></a>
The maximum number of jobs to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListReadSetImportJobs_RequestSyntax) **   <a name="omics-ListReadSetImportJobs-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceStoreId](#API_ListReadSetImportJobs_RequestSyntax) **   <a name="omics-ListReadSetImportJobs-request-uri-sequenceStoreId"></a>
The jobs' sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_ListReadSetImportJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListReadSetImportJobs_RequestSyntax) **   <a name="omics-ListReadSetImportJobs-request-filter"></a>
A filter to apply to the list.  
Type: [ImportReadSetFilter](API_ImportReadSetFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListReadSetImportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "importJobs": [ 
      { 
         "completionTime": "string",
         "creationTime": "string",
         "id": "string",
         "roleArn": "string",
         "sequenceStoreId": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListReadSetImportJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [importJobs](#API_ListReadSetImportJobs_ResponseSyntax) **   <a name="omics-ListReadSetImportJobs-response-importJobs"></a>
A list of jobs.  
Type: Array of [ImportReadSetJobItem](API_ImportReadSetJobItem.md) objects

 ** [nextToken](#API_ListReadSetImportJobs_ResponseSyntax) **   <a name="omics-ListReadSetImportJobs-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListReadSetImportJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReadSetImportJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListReadSetImportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListReadSetImportJobs) 

# ListReadSets
<a name="API_ListReadSets"></a>

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

## Request Syntax
<a name="API_ListReadSets_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/readsets?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string",
      "creationType": "string",
      "generatedFrom": "string",
      "name": "string",
      "referenceArn": "string",
      "sampleId": "string",
      "status": "string",
      "subjectId": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListReadSets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListReadSets_RequestSyntax) **   <a name="omics-ListReadSets-request-uri-maxResults"></a>
The maximum number of read sets to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListReadSets_RequestSyntax) **   <a name="omics-ListReadSets-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceStoreId](#API_ListReadSets_RequestSyntax) **   <a name="omics-ListReadSets-request-uri-sequenceStoreId"></a>
The jobs' sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_ListReadSets_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListReadSets_RequestSyntax) **   <a name="omics-ListReadSets-request-filter"></a>
A filter to apply to the list.  
Type: [ReadSetFilter](API_ReadSetFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListReadSets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "readSets": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "creationType": "string",
         "description": "string",
         "etag": { 
            "algorithm": "string",
            "source1": "string",
            "source2": "string"
         },
         "fileType": "string",
         "id": "string",
         "name": "string",
         "referenceArn": "string",
         "sampleId": "string",
         "sequenceInformation": { 
            "alignment": "string",
            "generatedFrom": "string",
            "totalBaseCount": number,
            "totalReadCount": number
         },
         "sequenceStoreId": "string",
         "status": "string",
         "statusMessage": "string",
         "subjectId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListReadSets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListReadSets_ResponseSyntax) **   <a name="omics-ListReadSets-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [readSets](#API_ListReadSets_ResponseSyntax) **   <a name="omics-ListReadSets-response-readSets"></a>
A list of read sets.  
Type: Array of [ReadSetListItem](API_ReadSetListItem.md) objects

## Errors
<a name="API_ListReadSets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReadSets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListReadSets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListReadSets) 

# ListReadSetUploadParts
<a name="API_ListReadSetUploadParts"></a>

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

## Request Syntax
<a name="API_ListReadSetUploadParts_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/upload/uploadId/parts?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string"
   },
   "partSource": "string"
}
```

## URI Request Parameters
<a name="API_ListReadSetUploadParts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListReadSetUploadParts_RequestSyntax) **   <a name="omics-ListReadSetUploadParts-request-uri-maxResults"></a>
The maximum number of read set upload parts returned in a page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListReadSetUploadParts_RequestSyntax) **   <a name="omics-ListReadSetUploadParts-request-uri-nextToken"></a>
Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceStoreId](#API_ListReadSetUploadParts_RequestSyntax) **   <a name="omics-ListReadSetUploadParts-request-uri-sequenceStoreId"></a>
The Sequence Store ID used for the multipart uploads.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [uploadId](#API_ListReadSetUploadParts_RequestSyntax) **   <a name="omics-ListReadSetUploadParts-request-uri-uploadId"></a>
The ID for the initiated multipart upload.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_ListReadSetUploadParts_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListReadSetUploadParts_RequestSyntax) **   <a name="omics-ListReadSetUploadParts-request-filter"></a>
Attributes used to filter for a specific subset of read set part uploads.  
Type: [ReadSetUploadPartListFilter](API_ReadSetUploadPartListFilter.md) object  
Required: No

 ** [partSource](#API_ListReadSetUploadParts_RequestSyntax) **   <a name="omics-ListReadSetUploadParts-request-partSource"></a>
The source file for the upload part.  
Type: String  
Valid Values: `SOURCE1 | SOURCE2`   
Required: Yes

## Response Syntax
<a name="API_ListReadSetUploadParts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "parts": [ 
      { 
         "checksum": "string",
         "creationTime": "string",
         "lastUpdatedTime": "string",
         "partNumber": number,
         "partSize": number,
         "partSource": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListReadSetUploadParts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListReadSetUploadParts_ResponseSyntax) **   <a name="omics-ListReadSetUploadParts-response-nextToken"></a>
Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [parts](#API_ListReadSetUploadParts_ResponseSyntax) **   <a name="omics-ListReadSetUploadParts-response-parts"></a>
An array of upload parts.  
Type: Array of [ReadSetUploadPartListItem](API_ReadSetUploadPartListItem.md) objects

## Errors
<a name="API_ListReadSetUploadParts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReadSetUploadParts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListReadSetUploadParts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListReadSetUploadParts) 

# ListReferenceImportJobs
<a name="API_ListReferenceImportJobs"></a>

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

## Request Syntax
<a name="API_ListReferenceImportJobs_RequestSyntax"></a>

```
POST /referencestore/referenceStoreId/importjobs?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string",
      "status": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListReferenceImportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListReferenceImportJobs_RequestSyntax) **   <a name="omics-ListReferenceImportJobs-request-uri-maxResults"></a>
The maximum number of jobs to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListReferenceImportJobs_RequestSyntax) **   <a name="omics-ListReferenceImportJobs-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [referenceStoreId](#API_ListReferenceImportJobs_RequestSyntax) **   <a name="omics-ListReferenceImportJobs-request-uri-referenceStoreId"></a>
The job's reference store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_ListReferenceImportJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListReferenceImportJobs_RequestSyntax) **   <a name="omics-ListReferenceImportJobs-request-filter"></a>
A filter to apply to the list.  
Type: [ImportReferenceFilter](API_ImportReferenceFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListReferenceImportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "importJobs": [ 
      { 
         "completionTime": "string",
         "creationTime": "string",
         "id": "string",
         "referenceStoreId": "string",
         "roleArn": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListReferenceImportJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [importJobs](#API_ListReferenceImportJobs_ResponseSyntax) **   <a name="omics-ListReferenceImportJobs-response-importJobs"></a>
A lis of jobs.  
Type: Array of [ImportReferenceJobItem](API_ImportReferenceJobItem.md) objects

 ** [nextToken](#API_ListReferenceImportJobs_ResponseSyntax) **   <a name="omics-ListReferenceImportJobs-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListReferenceImportJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReferenceImportJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListReferenceImportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListReferenceImportJobs) 

# ListReferences
<a name="API_ListReferences"></a>

Retrieves the metadata of one or more reference genomes in a reference store.

For more information, see [Creating a reference store](https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_ListReferences_RequestSyntax"></a>

```
POST /referencestore/referenceStoreId/references?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string",
      "md5": "string",
      "name": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListReferences_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListReferences_RequestSyntax) **   <a name="omics-ListReferences-request-uri-maxResults"></a>
The maximum number of references to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListReferences_RequestSyntax) **   <a name="omics-ListReferences-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [referenceStoreId](#API_ListReferences_RequestSyntax) **   <a name="omics-ListReferences-request-uri-referenceStoreId"></a>
The references' reference store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_ListReferences_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListReferences_RequestSyntax) **   <a name="omics-ListReferences-request-filter"></a>
A filter to apply to the list.  
Type: [ReferenceFilter](API_ReferenceFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListReferences_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "references": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "description": "string",
         "id": "string",
         "md5": "string",
         "name": "string",
         "referenceStoreId": "string",
         "status": "string",
         "updateTime": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListReferences_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListReferences_ResponseSyntax) **   <a name="omics-ListReferences-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [references](#API_ListReferences_ResponseSyntax) **   <a name="omics-ListReferences-response-references"></a>
A list of references.  
Type: Array of [ReferenceListItem](API_ReferenceListItem.md) objects

## Errors
<a name="API_ListReferences_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReferences_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListReferences) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListReferences) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListReferences) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListReferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListReferences) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListReferences) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListReferences) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListReferences) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListReferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListReferences) 

# ListReferenceStores
<a name="API_ListReferenceStores"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_ListReferenceStores_RequestSyntax"></a>

```
POST /referencestores?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string",
      "name": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListReferenceStores_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListReferenceStores_RequestSyntax) **   <a name="omics-ListReferenceStores-request-uri-maxResults"></a>
The maximum number of stores to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListReferenceStores_RequestSyntax) **   <a name="omics-ListReferenceStores-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Request Body
<a name="API_ListReferenceStores_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListReferenceStores_RequestSyntax) **   <a name="omics-ListReferenceStores-request-filter"></a>
A filter to apply to the list.  
Type: [ReferenceStoreFilter](API_ReferenceStoreFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListReferenceStores_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "referenceStores": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "sseConfig": { 
            "keyArn": "string",
            "type": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListReferenceStores_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListReferenceStores_ResponseSyntax) **   <a name="omics-ListReferenceStores-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [referenceStores](#API_ListReferenceStores_ResponseSyntax) **   <a name="omics-ListReferenceStores-response-referenceStores"></a>
A list of reference stores.  
Type: Array of [ReferenceStoreDetail](API_ReferenceStoreDetail.md) objects

## Errors
<a name="API_ListReferenceStores_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListReferenceStores_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListReferenceStores) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListReferenceStores) 

# ListRunCaches
<a name="API_ListRunCaches"></a>

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

## Request Syntax
<a name="API_ListRunCaches_RequestSyntax"></a>

```
GET /runCache?maxResults=maxResults&startingToken=startingToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRunCaches_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListRunCaches_RequestSyntax) **   <a name="omics-ListRunCaches-request-uri-maxResults"></a>
The maximum number of results to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [startingToken](#API_ListRunCaches_RequestSyntax) **   <a name="omics-ListRunCaches-request-uri-startingToken"></a>
Optional pagination token returned from a prior call to the `ListRunCaches` API operation.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Request Body
<a name="API_ListRunCaches_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRunCaches_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "cacheBehavior": "string",
         "cacheS3Uri": "string",
         "creationTime": "string",
         "id": "string",
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListRunCaches_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListRunCaches_ResponseSyntax) **   <a name="omics-ListRunCaches-response-items"></a>
Details about each run cache in the response.  
Type: Array of [RunCacheListItem](API_RunCacheListItem.md) objects

 ** [nextToken](#API_ListRunCaches_ResponseSyntax) **   <a name="omics-ListRunCaches-response-nextToken"></a>
Pagination token to retrieve additional run caches. If the response does not have a `nextToken`value, you have reached to the end of the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListRunCaches_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListRunCaches_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListRunCaches) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListRunCaches) 

# ListRunGroups
<a name="API_ListRunGroups"></a>

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

## Request Syntax
<a name="API_ListRunGroups_RequestSyntax"></a>

```
GET /runGroup?maxResults=maxResults&name=name&startingToken=startingToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRunGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListRunGroups_RequestSyntax) **   <a name="omics-ListRunGroups-request-uri-maxResults"></a>
The maximum number of run groups to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [name](#API_ListRunGroups_RequestSyntax) **   <a name="omics-ListRunGroups-request-uri-name"></a>
The run groups' name.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [startingToken](#API_ListRunGroups_RequestSyntax) **   <a name="omics-ListRunGroups-request-uri-startingToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Request Body
<a name="API_ListRunGroups_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRunGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "id": "string",
         "maxCpus": number,
         "maxDuration": number,
         "maxGpus": number,
         "maxRuns": number,
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListRunGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListRunGroups_ResponseSyntax) **   <a name="omics-ListRunGroups-response-items"></a>
A list of groups.  
Type: Array of [RunGroupListItem](API_RunGroupListItem.md) objects

 ** [nextToken](#API_ListRunGroups_ResponseSyntax) **   <a name="omics-ListRunGroups-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListRunGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListRunGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListRunGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListRunGroups) 

# ListRuns
<a name="API_ListRuns"></a>

Retrieves a list of runs and returns each run's metadata and status.

 AWS 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](https://docs.aws.amazon.com/omics/latest/dev/monitoring-cloudwatch-logs.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_ListRuns_RequestSyntax"></a>

```
GET /run?batchId=batchId&maxResults=maxResults&name=name&runGroupId=runGroupId&startingToken=startingToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRuns_RequestParameters"></a>

The request uses the following URI parameters.

 ** [batchId](#API_ListRuns_RequestSyntax) **   <a name="omics-ListRuns-request-uri-batchId"></a>
Filter by batch ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [maxResults](#API_ListRuns_RequestSyntax) **   <a name="omics-ListRuns-request-uri-maxResults"></a>
The maximum number of runs to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [name](#API_ListRuns_RequestSyntax) **   <a name="omics-ListRuns-request-uri-name"></a>
Filter the list by run name.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [runGroupId](#API_ListRuns_RequestSyntax) **   <a name="omics-ListRuns-request-uri-runGroupId"></a>
Filter the list by run group ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [startingToken](#API_ListRuns_RequestSyntax) **   <a name="omics-ListRuns-request-uri-startingToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [status](#API_ListRuns_RequestSyntax) **   <a name="omics-ListRuns-request-uri-status"></a>
The status of a run.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PENDING | STARTING | RUNNING | STOPPING | COMPLETED | DELETED | CANCELLED | FAILED` 

## Request Body
<a name="API_ListRuns_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRuns_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "batchId": "string",
         "creationTime": "string",
         "id": "string",
         "name": "string",
         "priority": number,
         "startTime": "string",
         "status": "string",
         "stopTime": "string",
         "storageCapacity": number,
         "storageType": "string",
         "workflowId": "string",
         "workflowVersionName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListRuns_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListRuns_ResponseSyntax) **   <a name="omics-ListRuns-response-items"></a>
A list of runs.  
Type: Array of [RunListItem](API_RunListItem.md) objects

 ** [nextToken](#API_ListRuns_ResponseSyntax) **   <a name="omics-ListRuns-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListRuns_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListRuns_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListRuns) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListRuns) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListRuns) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListRuns) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListRuns) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListRuns) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListRuns) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListRuns) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListRuns) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListRuns) 

# ListRunsInBatch
<a name="API_ListRunsInBatch"></a>

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

## Request Syntax
<a name="API_ListRunsInBatch_RequestSyntax"></a>

```
GET /runBatch/batchId/run?maxItems=maxItems&runId=runId&runSettingId=runSettingId&startingToken=startingToken&submissionStatus=submissionStatus HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRunsInBatch_RequestParameters"></a>

The request uses the following URI parameters.

 ** [batchId](#API_ListRunsInBatch_RequestSyntax) **   <a name="omics-ListRunsInBatch-request-uri-batchId"></a>
The identifier portion of the run batch ARN.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

 ** [maxItems](#API_ListRunsInBatch_RequestSyntax) **   <a name="omics-ListRunsInBatch-request-uri-maxItems"></a>
The maximum number of runs to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [runId](#API_ListRunsInBatch_RequestSyntax) **   <a name="omics-ListRunsInBatch-request-uri-runId"></a>
Filter runs by the HealthOmics-generated run ID.

 ** [runSettingId](#API_ListRunsInBatch_RequestSyntax) **   <a name="omics-ListRunsInBatch-request-uri-runSettingId"></a>
Filter runs by the customer-provided run setting ID.

 ** [startingToken](#API_ListRunsInBatch_RequestSyntax) **   <a name="omics-ListRunsInBatch-request-uri-startingToken"></a>
A pagination token returned from a prior `ListRunsInBatch` call.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [submissionStatus](#API_ListRunsInBatch_RequestSyntax) **   <a name="omics-ListRunsInBatch-request-uri-submissionStatus"></a>
Filter runs by submission status.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `SUCCESS | FAILED | CANCEL_SUCCESS | CANCEL_FAILED | DELETE_SUCCESS | DELETE_FAILED` 

## Request Body
<a name="API_ListRunsInBatch_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRunsInBatch_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "runs": [ 
      { 
         "runArn": "string",
         "runId": "string",
         "runInternalUuid": "string",
         "runSettingId": "string",
         "submissionFailureMessage": "string",
         "submissionFailureReason": "string",
         "submissionStatus": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRunsInBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListRunsInBatch_ResponseSyntax) **   <a name="omics-ListRunsInBatch-response-nextToken"></a>
A pagination token to retrieve the next page of results. Absent when the last run has been returned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [runs](#API_ListRunsInBatch_ResponseSyntax) **   <a name="omics-ListRunsInBatch-response-runs"></a>
A list of run entries in the batch. See `RunBatchListItem`.  
Type: Array of [RunBatchListItem](API_RunBatchListItem.md) objects

## Errors
<a name="API_ListRunsInBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListRunsInBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListRunsInBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListRunsInBatch) 

# ListRunTasks
<a name="API_ListRunTasks"></a>

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.

## Request Syntax
<a name="API_ListRunTasks_RequestSyntax"></a>

```
GET /run/id/task?maxResults=maxResults&startingToken=startingToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRunTasks_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_ListRunTasks_RequestSyntax) **   <a name="omics-ListRunTasks-request-uri-id"></a>
The run's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

 ** [maxResults](#API_ListRunTasks_RequestSyntax) **   <a name="omics-ListRunTasks-request-uri-maxResults"></a>
The maximum number of run tasks to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [startingToken](#API_ListRunTasks_RequestSyntax) **   <a name="omics-ListRunTasks-request-uri-startingToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [status](#API_ListRunTasks_RequestSyntax) **   <a name="omics-ListRunTasks-request-uri-status"></a>
Filter the list by status.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PENDING | STARTING | RUNNING | STOPPING | COMPLETED | CANCELLED | FAILED` 

## Request Body
<a name="API_ListRunTasks_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRunTasks_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "cacheHit": boolean,
         "cacheS3Uri": "string",
         "cpus": number,
         "creationTime": "string",
         "gpus": number,
         "instanceType": "string",
         "memory": number,
         "name": "string",
         "startTime": "string",
         "status": "string",
         "stopTime": "string",
         "taskId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListRunTasks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListRunTasks_ResponseSyntax) **   <a name="omics-ListRunTasks-response-items"></a>
A list of tasks.  
Type: Array of [TaskListItem](API_TaskListItem.md) objects

 ** [nextToken](#API_ListRunTasks_ResponseSyntax) **   <a name="omics-ListRunTasks-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListRunTasks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListRunTasks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListRunTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListRunTasks) 

# ListSequenceStores
<a name="API_ListSequenceStores"></a>

Retrieves a list of sequence stores and returns each sequence store's metadata.

For more information, see [Creating a HealthOmics sequence store](https://docs.aws.amazon.com/omics/latest/dev/create-sequence-store.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_ListSequenceStores_RequestSyntax"></a>

```
POST /sequencestores?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "createdAfter": "string",
      "createdBefore": "string",
      "name": "string",
      "status": "string",
      "updatedAfter": "string",
      "updatedBefore": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListSequenceStores_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListSequenceStores_RequestSyntax) **   <a name="omics-ListSequenceStores-request-uri-maxResults"></a>
The maximum number of stores to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListSequenceStores_RequestSyntax) **   <a name="omics-ListSequenceStores-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Request Body
<a name="API_ListSequenceStores_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListSequenceStores_RequestSyntax) **   <a name="omics-ListSequenceStores-request-filter"></a>
A filter to apply to the list.  
Type: [SequenceStoreFilter](API_SequenceStoreFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListSequenceStores_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "sequenceStores": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "description": "string",
         "eTagAlgorithmFamily": "string",
         "fallbackLocation": "string",
         "id": "string",
         "name": "string",
         "sseConfig": { 
            "keyArn": "string",
            "type": "string"
         },
         "status": "string",
         "statusMessage": "string",
         "updateTime": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSequenceStores_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListSequenceStores_ResponseSyntax) **   <a name="omics-ListSequenceStores-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [sequenceStores](#API_ListSequenceStores_ResponseSyntax) **   <a name="omics-ListSequenceStores-response-sequenceStores"></a>
A list of sequence stores.  
Type: Array of [SequenceStoreDetail](API_SequenceStoreDetail.md) objects

## Errors
<a name="API_ListSequenceStores_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListSequenceStores_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListSequenceStores) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListSequenceStores) 

# ListShares
<a name="API_ListShares"></a>

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

## Request Syntax
<a name="API_ListShares_RequestSyntax"></a>

```
POST /shares?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "resourceArns": [ "string" ],
      "status": [ "string" ],
      "type": [ "string" ]
   },
   "resourceOwner": "string"
}
```

## URI Request Parameters
<a name="API_ListShares_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListShares_RequestSyntax) **   <a name="omics-ListShares-request-uri-maxResults"></a>
The maximum number of shares to return in one page of results.

 ** [nextToken](#API_ListShares_RequestSyntax) **   <a name="omics-ListShares-request-uri-nextToken"></a>
Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

## Request Body
<a name="API_ListShares_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListShares_RequestSyntax) **   <a name="omics-ListShares-request-filter"></a>
Attributes that you use to filter for a specific subset of resource shares.  
Type: [Filter](API_Filter.md) object  
Required: No

 ** [resourceOwner](#API_ListShares_RequestSyntax) **   <a name="omics-ListShares-request-resourceOwner"></a>
The account that owns the resource shares.  
Type: String  
Valid Values: `SELF | OTHER`   
Required: Yes

## Response Syntax
<a name="API_ListShares_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "shares": [ 
      { 
         "creationTime": "string",
         "ownerId": "string",
         "principalSubscriber": "string",
         "resourceArn": "string",
         "resourceId": "string",
         "shareId": "string",
         "shareName": "string",
         "status": "string",
         "statusMessage": "string",
         "updateTime": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListShares_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListShares_ResponseSyntax) **   <a name="omics-ListShares-response-nextToken"></a>
 Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.   
Type: String

 ** [shares](#API_ListShares_ResponseSyntax) **   <a name="omics-ListShares-response-shares"></a>
The shares available and their metadata details.  
Type: Array of [ShareDetails](API_ShareDetails.md) objects

## Errors
<a name="API_ListShares_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListShares_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListShares) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListShares) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListShares) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListShares) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListShares) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListShares) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListShares) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListShares) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListShares) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListShares) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Retrieves a list of tags for a resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="omics-ListTagsForResource-request-uri-resourceArn"></a>
The resource's ARN.  
Length Constraints: Minimum length of 1. Maximum length of 150.  
Pattern: `arn:.+`   
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="omics-ListTagsForResource-response-tags"></a>
A list of tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListTagsForResource) 

# ListVariantImportJobs
<a name="API_ListVariantImportJobs"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Retrieves a list of variant import jobs.

## Request Syntax
<a name="API_ListVariantImportJobs_RequestSyntax"></a>

```
POST /import/variants?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "status": "string",
      "storeName": "string"
   },
   "ids": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListVariantImportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListVariantImportJobs_RequestSyntax) **   <a name="omics-ListVariantImportJobs-request-uri-maxResults"></a>
The maximum number of import jobs to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListVariantImportJobs_RequestSyntax) **   <a name="omics-ListVariantImportJobs-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 10000.

## Request Body
<a name="API_ListVariantImportJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListVariantImportJobs_RequestSyntax) **   <a name="omics-ListVariantImportJobs-request-filter"></a>
A filter to apply to the list.  
Type: [ListVariantImportJobsFilter](API_ListVariantImportJobsFilter.md) object  
Required: No

 ** [ids](#API_ListVariantImportJobs_RequestSyntax) **   <a name="omics-ListVariantImportJobs-request-ids"></a>
A list of job IDs.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

## Response Syntax
<a name="API_ListVariantImportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "variantImportJobs": [ 
      { 
         "annotationFields": { 
            "string" : "string" 
         },
         "completionTime": "string",
         "creationTime": "string",
         "destinationName": "string",
         "id": "string",
         "roleArn": "string",
         "runLeftNormalization": boolean,
         "status": "string",
         "updateTime": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListVariantImportJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListVariantImportJobs_ResponseSyntax) **   <a name="omics-ListVariantImportJobs-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String

 ** [variantImportJobs](#API_ListVariantImportJobs_ResponseSyntax) **   <a name="omics-ListVariantImportJobs-response-variantImportJobs"></a>
A list of jobs.  
Type: Array of [VariantImportJobItem](API_VariantImportJobItem.md) objects

## Errors
<a name="API_ListVariantImportJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListVariantImportJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListVariantImportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListVariantImportJobs) 

# ListVariantStores
<a name="API_ListVariantStores"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Retrieves a list of variant stores.

## Request Syntax
<a name="API_ListVariantStores_RequestSyntax"></a>

```
POST /variantStores?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "status": "string"
   },
   "ids": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListVariantStores_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListVariantStores_RequestSyntax) **   <a name="omics-ListVariantStores-request-uri-maxResults"></a>
The maximum number of stores to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListVariantStores_RequestSyntax) **   <a name="omics-ListVariantStores-request-uri-nextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 10000.

## Request Body
<a name="API_ListVariantStores_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filter](#API_ListVariantStores_RequestSyntax) **   <a name="omics-ListVariantStores-request-filter"></a>
A filter to apply to the list.  
Type: [ListVariantStoresFilter](API_ListVariantStoresFilter.md) object  
Required: No

 ** [ids](#API_ListVariantStores_RequestSyntax) **   <a name="omics-ListVariantStores-request-ids"></a>
A list of store IDs.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

## Response Syntax
<a name="API_ListVariantStores_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "variantStores": [ 
      { 
         "creationTime": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "reference": { ... },
         "sseConfig": { 
            "keyArn": "string",
            "type": "string"
         },
         "status": "string",
         "statusMessage": "string",
         "storeArn": "string",
         "storeSizeBytes": number,
         "updateTime": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListVariantStores_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListVariantStores_ResponseSyntax) **   <a name="omics-ListVariantStores-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String

 ** [variantStores](#API_ListVariantStores_ResponseSyntax) **   <a name="omics-ListVariantStores-response-variantStores"></a>
A list of variant stores.  
Type: Array of [VariantStoreItem](API_VariantStoreItem.md) objects

## Errors
<a name="API_ListVariantStores_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListVariantStores_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListVariantStores) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListVariantStores) 

# ListWorkflows
<a name="API_ListWorkflows"></a>

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.

## Request Syntax
<a name="API_ListWorkflows_RequestSyntax"></a>

```
GET /workflow?maxResults=maxResults&name=name&startingToken=startingToken&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_ListWorkflows_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListWorkflows_RequestSyntax) **   <a name="omics-ListWorkflows-request-uri-maxResults"></a>
The maximum number of workflows to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [name](#API_ListWorkflows_RequestSyntax) **   <a name="omics-ListWorkflows-request-uri-name"></a>
Filter the list by workflow name.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [startingToken](#API_ListWorkflows_RequestSyntax) **   <a name="omics-ListWorkflows-request-uri-startingToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [type](#API_ListWorkflows_RequestSyntax) **   <a name="omics-ListWorkflows-request-uri-type"></a>
Filter the list by workflow type.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PRIVATE | READY2RUN` 

## Request Body
<a name="API_ListWorkflows_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListWorkflows_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "digest": "string",
         "id": "string",
         "metadata": { 
            "string" : "string" 
         },
         "name": "string",
         "status": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListWorkflows_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListWorkflows_ResponseSyntax) **   <a name="omics-ListWorkflows-response-items"></a>
A list of workflow items.  
Type: Array of [WorkflowListItem](API_WorkflowListItem.md) objects

 ** [nextToken](#API_ListWorkflows_ResponseSyntax) **   <a name="omics-ListWorkflows-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListWorkflows_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListWorkflows_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListWorkflows) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListWorkflows) 

# ListWorkflowVersions
<a name="API_ListWorkflowVersions"></a>

Lists the workflow versions for the specified workflow. For more information, see [Workflow versioning in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_ListWorkflowVersions_RequestSyntax"></a>

```
GET /workflow/workflowId/version?maxResults=maxResults&startingToken=startingToken&type=type&workflowOwnerId=workflowOwnerId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListWorkflowVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListWorkflowVersions_RequestSyntax) **   <a name="omics-ListWorkflowVersions-request-uri-maxResults"></a>
The maximum number of workflows to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [startingToken](#API_ListWorkflowVersions_RequestSyntax) **   <a name="omics-ListWorkflowVersions-request-uri-startingToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [type](#API_ListWorkflowVersions_RequestSyntax) **   <a name="omics-ListWorkflowVersions-request-uri-type"></a>
The workflow type.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PRIVATE | READY2RUN` 

 ** [workflowId](#API_ListWorkflowVersions_RequestSyntax) **   <a name="omics-ListWorkflowVersions-request-uri-workflowId"></a>
The workflow's ID. The `workflowId` is not the UUID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

 ** [workflowOwnerId](#API_ListWorkflowVersions_RequestSyntax) **   <a name="omics-ListWorkflowVersions-request-uri-workflowOwnerId"></a>
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.  
Pattern: `[0-9]{12}` 

## Request Body
<a name="API_ListWorkflowVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListWorkflowVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "description": "string",
         "digest": "string",
         "metadata": { 
            "string" : "string" 
         },
         "status": "string",
         "type": "string",
         "versionName": "string",
         "workflowId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListWorkflowVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListWorkflowVersions_ResponseSyntax) **   <a name="omics-ListWorkflowVersions-response-items"></a>
A list of workflow version items.  
Type: Array of [WorkflowVersionListItem](API_WorkflowVersionListItem.md) objects

 ** [nextToken](#API_ListWorkflowVersions_ResponseSyntax) **   <a name="omics-ListWorkflowVersions-response-nextToken"></a>
A pagination token that's included if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_ListWorkflowVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListWorkflowVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/ListWorkflowVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListWorkflowVersions) 

# PutS3AccessPolicy
<a name="API_PutS3AccessPolicy"></a>

Adds an access policy to the specified store.

## Request Syntax
<a name="API_PutS3AccessPolicy_RequestSyntax"></a>

```
PUT /s3accesspolicy/s3AccessPointArn HTTP/1.1
Content-type: application/json

{
   "s3AccessPolicy": "string"
}
```

## URI Request Parameters
<a name="API_PutS3AccessPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [s3AccessPointArn](#API_PutS3AccessPolicy_RequestSyntax) **   <a name="omics-PutS3AccessPolicy-request-uri-s3AccessPointArn"></a>
The S3 access point ARN where you want to put the access policy.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*`   
Required: Yes

## Request Body
<a name="API_PutS3AccessPolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [s3AccessPolicy](#API_PutS3AccessPolicy_RequestSyntax) **   <a name="omics-PutS3AccessPolicy-request-s3AccessPolicy"></a>
The resource policy that controls S3 access to the store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.  
Required: Yes

## Response Syntax
<a name="API_PutS3AccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "s3AccessPointArn": "string",
   "storeId": "string",
   "storeType": "string"
}
```

## Response Elements
<a name="API_PutS3AccessPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [s3AccessPointArn](#API_PutS3AccessPolicy_ResponseSyntax) **   <a name="omics-PutS3AccessPolicy-response-s3AccessPointArn"></a>
The S3 access point ARN that now has the access policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*` 

 ** [storeId](#API_PutS3AccessPolicy_ResponseSyntax) **   <a name="omics-PutS3AccessPolicy-response-storeId"></a>
The AWS-generated Sequence Store or Reference Store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [storeType](#API_PutS3AccessPolicy_ResponseSyntax) **   <a name="omics-PutS3AccessPolicy-response-storeType"></a>
The type of store associated with the access point.  
Type: String  
Valid Values: `SEQUENCE_STORE | REFERENCE_STORE` 

## Errors
<a name="API_PutS3AccessPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_PutS3AccessPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/PutS3AccessPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/PutS3AccessPolicy) 

# StartAnnotationImportJob
<a name="API_StartAnnotationImportJob"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Starts an annotation import job.

## Request Syntax
<a name="API_StartAnnotationImportJob_RequestSyntax"></a>

```
POST /import/annotation HTTP/1.1
Content-type: application/json

{
   "annotationFields": { 
      "string" : "string" 
   },
   "destinationName": "string",
   "formatOptions": { ... },
   "items": [ 
      { 
         "source": "string"
      }
   ],
   "roleArn": "string",
   "runLeftNormalization": boolean,
   "versionName": "string"
}
```

## URI Request Parameters
<a name="API_StartAnnotationImportJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartAnnotationImportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [annotationFields](#API_StartAnnotationImportJob_RequestSyntax) **   <a name="omics-StartAnnotationImportJob-request-annotationFields"></a>
The annotation schema generated by the parsed annotation data.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 21.  
Value Length Constraints: Minimum length of 1. Maximum length of 21.  
Required: No

 ** [destinationName](#API_StartAnnotationImportJob_RequestSyntax) **   <a name="omics-StartAnnotationImportJob-request-destinationName"></a>
A destination annotation store for the job.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: Yes

 ** [formatOptions](#API_StartAnnotationImportJob_RequestSyntax) **   <a name="omics-StartAnnotationImportJob-request-formatOptions"></a>
Formatting options for the annotation file.  
Type: [FormatOptions](API_FormatOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [items](#API_StartAnnotationImportJob_RequestSyntax) **   <a name="omics-StartAnnotationImportJob-request-items"></a>
Items to import.  
Type: Array of [AnnotationImportItemSource](API_AnnotationImportItemSource.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** [roleArn](#API_StartAnnotationImportJob_RequestSyntax) **   <a name="omics-StartAnnotationImportJob-request-roleArn"></a>
A service role for the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)`   
Required: Yes

 ** [runLeftNormalization](#API_StartAnnotationImportJob_RequestSyntax) **   <a name="omics-StartAnnotationImportJob-request-runLeftNormalization"></a>
The job's left normalization setting.  
Type: Boolean  
Required: No

 ** [versionName](#API_StartAnnotationImportJob_RequestSyntax) **   <a name="omics-StartAnnotationImportJob-request-versionName"></a>
 The name of the annotation store version.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: No

## Response Syntax
<a name="API_StartAnnotationImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "jobId": "string"
}
```

## Response Elements
<a name="API_StartAnnotationImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [jobId](#API_StartAnnotationImportJob_ResponseSyntax) **   <a name="omics-StartAnnotationImportJob-response-jobId"></a>
The job's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_StartAnnotationImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartAnnotationImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/StartAnnotationImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartAnnotationImportJob) 

# StartReadSetActivationJob
<a name="API_StartReadSetActivationJob"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/activating-read-sets.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_StartReadSetActivationJob_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/activationjob HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "sources": [ 
      { 
         "readSetId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_StartReadSetActivationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sequenceStoreId](#API_StartReadSetActivationJob_RequestSyntax) **   <a name="omics-StartReadSetActivationJob-request-uri-sequenceStoreId"></a>
The read set's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_StartReadSetActivationJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_StartReadSetActivationJob_RequestSyntax) **   <a name="omics-StartReadSetActivationJob-request-clientToken"></a>
To ensure that jobs don't run multiple times, specify a unique token for each job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [sources](#API_StartReadSetActivationJob_RequestSyntax) **   <a name="omics-StartReadSetActivationJob-request-sources"></a>
The job's source files.  
Type: Array of [StartReadSetActivationJobSourceItem](API_StartReadSetActivationJobSourceItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: Yes

## Response Syntax
<a name="API_StartReadSetActivationJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "sequenceStoreId": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_StartReadSetActivationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_StartReadSetActivationJob_ResponseSyntax) **   <a name="omics-StartReadSetActivationJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [id](#API_StartReadSetActivationJob_ResponseSyntax) **   <a name="omics-StartReadSetActivationJob-response-id"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [sequenceStoreId](#API_StartReadSetActivationJob_ResponseSyntax) **   <a name="omics-StartReadSetActivationJob-response-sequenceStoreId"></a>
The read set's sequence store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [status](#API_StartReadSetActivationJob_ResponseSyntax) **   <a name="omics-StartReadSetActivationJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` 

## Errors
<a name="API_StartReadSetActivationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartReadSetActivationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/StartReadSetActivationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartReadSetActivationJob) 

# StartReadSetExportJob
<a name="API_StartReadSetExportJob"></a>

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. 

## Request Syntax
<a name="API_StartReadSetExportJob_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/exportjob HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "destination": "string",
   "roleArn": "string",
   "sources": [ 
      { 
         "readSetId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_StartReadSetExportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sequenceStoreId](#API_StartReadSetExportJob_RequestSyntax) **   <a name="omics-StartReadSetExportJob-request-uri-sequenceStoreId"></a>
The read set's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_StartReadSetExportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_StartReadSetExportJob_RequestSyntax) **   <a name="omics-StartReadSetExportJob-request-clientToken"></a>
To ensure that jobs don't run multiple times, specify a unique token for each job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [destination](#API_StartReadSetExportJob_RequestSyntax) **   <a name="omics-StartReadSetExportJob-request-destination"></a>
A location for exported files in Amazon S3.  
Type: String  
Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?`   
Required: Yes

 ** [roleArn](#API_StartReadSetExportJob_RequestSyntax) **   <a name="omics-StartReadSetExportJob-request-roleArn"></a>
A service role for the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** [sources](#API_StartReadSetExportJob_RequestSyntax) **   <a name="omics-StartReadSetExportJob-request-sources"></a>
The job's source files.  
Type: Array of [ExportReadSet](API_ExportReadSet.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

## Response Syntax
<a name="API_StartReadSetExportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "destination": "string",
   "id": "string",
   "sequenceStoreId": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_StartReadSetExportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_StartReadSetExportJob_ResponseSyntax) **   <a name="omics-StartReadSetExportJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [destination](#API_StartReadSetExportJob_ResponseSyntax) **   <a name="omics-StartReadSetExportJob-response-destination"></a>
The job's output location.  
Type: String  
Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?` 

 ** [id](#API_StartReadSetExportJob_ResponseSyntax) **   <a name="omics-StartReadSetExportJob-response-id"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [sequenceStoreId](#API_StartReadSetExportJob_ResponseSyntax) **   <a name="omics-StartReadSetExportJob-response-sequenceStoreId"></a>
The read set's sequence store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [status](#API_StartReadSetExportJob_ResponseSyntax) **   <a name="omics-StartReadSetExportJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` 

## Errors
<a name="API_StartReadSetExportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartReadSetExportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/StartReadSetExportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartReadSetExportJob) 

# StartReadSetImportJob
<a name="API_StartReadSetImportJob"></a>

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.

## Request Syntax
<a name="API_StartReadSetImportJob_RequestSyntax"></a>

```
POST /sequencestore/sequenceStoreId/importjob HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "roleArn": "string",
   "sources": [ 
      { 
         "description": "string",
         "generatedFrom": "string",
         "name": "string",
         "referenceArn": "string",
         "sampleId": "string",
         "sourceFiles": { 
            "source1": "string",
            "source2": "string"
         },
         "sourceFileType": "string",
         "subjectId": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_StartReadSetImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sequenceStoreId](#API_StartReadSetImportJob_RequestSyntax) **   <a name="omics-StartReadSetImportJob-request-uri-sequenceStoreId"></a>
The read set's sequence store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_StartReadSetImportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_StartReadSetImportJob_RequestSyntax) **   <a name="omics-StartReadSetImportJob-request-clientToken"></a>
To ensure that jobs don't run multiple times, specify a unique token for each job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [roleArn](#API_StartReadSetImportJob_RequestSyntax) **   <a name="omics-StartReadSetImportJob-request-roleArn"></a>
A service role for the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** [sources](#API_StartReadSetImportJob_RequestSyntax) **   <a name="omics-StartReadSetImportJob-request-sources"></a>
The job's source files.  
Type: Array of [StartReadSetImportJobSourceItem](API_StartReadSetImportJobSourceItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

## Response Syntax
<a name="API_StartReadSetImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "roleArn": "string",
   "sequenceStoreId": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_StartReadSetImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_StartReadSetImportJob_ResponseSyntax) **   <a name="omics-StartReadSetImportJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [id](#API_StartReadSetImportJob_ResponseSyntax) **   <a name="omics-StartReadSetImportJob-response-id"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [roleArn](#API_StartReadSetImportJob_ResponseSyntax) **   <a name="omics-StartReadSetImportJob-response-roleArn"></a>
The job's service role ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*` 

 ** [sequenceStoreId](#API_StartReadSetImportJob_ResponseSyntax) **   <a name="omics-StartReadSetImportJob-response-sequenceStoreId"></a>
The read set's sequence store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [status](#API_StartReadSetImportJob_ResponseSyntax) **   <a name="omics-StartReadSetImportJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` 

## Errors
<a name="API_StartReadSetImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartReadSetImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/StartReadSetImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartReadSetImportJob) 

# StartReferenceImportJob
<a name="API_StartReferenceImportJob"></a>

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.

## Request Syntax
<a name="API_StartReferenceImportJob_RequestSyntax"></a>

```
POST /referencestore/referenceStoreId/importjob HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "roleArn": "string",
   "sources": [ 
      { 
         "description": "string",
         "name": "string",
         "sourceFile": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_StartReferenceImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [referenceStoreId](#API_StartReferenceImportJob_RequestSyntax) **   <a name="omics-StartReferenceImportJob-request-uri-referenceStoreId"></a>
The job's reference store ID.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_StartReferenceImportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_StartReferenceImportJob_RequestSyntax) **   <a name="omics-StartReferenceImportJob-request-clientToken"></a>
To ensure that jobs don't run multiple times, specify a unique token for each job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [roleArn](#API_StartReferenceImportJob_RequestSyntax) **   <a name="omics-StartReferenceImportJob-request-roleArn"></a>
A service role for the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*`   
Required: Yes

 ** [sources](#API_StartReferenceImportJob_RequestSyntax) **   <a name="omics-StartReferenceImportJob-request-sources"></a>
The job's source files.  
Type: Array of [StartReferenceImportJobSourceItem](API_StartReferenceImportJobSourceItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

## Response Syntax
<a name="API_StartReferenceImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "referenceStoreId": "string",
   "roleArn": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_StartReferenceImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_StartReferenceImportJob_ResponseSyntax) **   <a name="omics-StartReferenceImportJob-response-creationTime"></a>
When the job was created.  
Type: Timestamp

 ** [id](#API_StartReferenceImportJob_ResponseSyntax) **   <a name="omics-StartReferenceImportJob-response-id"></a>
The job's ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [referenceStoreId](#API_StartReferenceImportJob_ResponseSyntax) **   <a name="omics-StartReferenceImportJob-response-referenceStoreId"></a>
The job's reference store ID.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [roleArn](#API_StartReferenceImportJob_ResponseSyntax) **   <a name="omics-StartReferenceImportJob-response-roleArn"></a>
The job's service role ARN.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:.*` 

 ** [status](#API_StartReferenceImportJob_ResponseSyntax) **   <a name="omics-StartReferenceImportJob-response-status"></a>
The job's status.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` 

## Errors
<a name="API_StartReferenceImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartReferenceImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/StartReferenceImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartReferenceImportJob) 

# StartRun
<a name="API_StartRun"></a>

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, AWS 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](https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html) in the * AWS 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](https://docs.aws.amazon.com/omics/latest/dev/run-retention.html) in the * AWS HealthOmics User Guide*.

You can use Amazon Q CLI to analyze run logs and make performance optimization recommendations. To get started, see the [AWS HealthOmics MCP server](https://github.com/awslabs/mcp/tree/main/src/aws-healthomics-mcp-server) on GitHub.

## Request Syntax
<a name="API_StartRun_RequestSyntax"></a>

```
POST /run HTTP/1.1
Content-type: application/json

{
   "cacheBehavior": "string",
   "cacheId": "string",
   "configurationName": "string",
   "logLevel": "string",
   "name": "string",
   "networkingMode": "string",
   "outputUri": "string",
   "parameters": JSON value,
   "priority": number,
   "requestId": "string",
   "retentionMode": "string",
   "roleArn": "string",
   "runGroupId": "string",
   "runId": "string",
   "storageCapacity": number,
   "storageType": "string",
   "tags": { 
      "string" : "string" 
   },
   "workflowId": "string",
   "workflowOwnerId": "string",
   "workflowType": "string",
   "workflowVersionName": "string"
}
```

## URI Request Parameters
<a name="API_StartRun_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartRun_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [cacheBehavior](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-cacheBehavior"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior) in the * AWS HealthOmics User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CACHE_ON_FAILURE | CACHE_ALWAYS`   
Required: No

 ** [cacheId](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-cacheId"></a>
Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: No

 ** [configurationName](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-configurationName"></a>
Optional configuration name to use for the workflow run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: No

 ** [logLevel](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-logLevel"></a>
A log level for the run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `OFF | FATAL | ERROR | ALL`   
Required: No

 ** [name](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-name"></a>
A name for the run. This is recommended to view and organize runs in the AWS HealthOmics console and CloudWatch logs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [networkingMode](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-networkingMode"></a>
Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.  
Type: String  
Valid Values: `RESTRICTED | VPC`   
Required: No

 ** [outputUri](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-outputUri"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 750.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [parameters](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-parameters"></a>
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.  
Type: JSON value  
Required: No

 ** [priority](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-priority"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html#run-priority) in the * AWS HealthOmics User Guide*.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.  
Required: No

 ** [requestId](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-requestId"></a>
An idempotency token used to dedupe retry requests so that duplicate runs are not created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [retentionMode](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-retentionMode"></a>
The retention mode for the run. The default value is `RETAIN`.   
 AWS 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`, AWS 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](https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html) in the * AWS HealthOmics User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `RETAIN | REMOVE`   
Required: No

 ** [roleArn](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-roleArn"></a>
A service role for the run. The `roleArn` requires access to AWS 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`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+`   
Required: Yes

 ** [runGroupId](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-runGroupId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: No

 ** [runId](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-runId"></a>
The ID of a run to duplicate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: No

 ** [storageCapacity](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-storageCapacity"></a>
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).  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.  
Required: No

 ** [storageType](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-storageType"></a>
The storage type for the run. If you set the storage type to `DYNAMIC`, AWS 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](https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html) in the * AWS HealthOmics User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `STATIC | DYNAMIC`   
Required: No

 ** [tags](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-tags"></a>
Tags for the run. You can add up to 50 tags per run. For more information, see [Adding a tag](https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html) in the * AWS HealthOmics User Guide*.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [workflowId](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-workflowId"></a>
The run's workflow ID. The `workflowId` is not the UUID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: No

 ** [workflowOwnerId](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-workflowOwnerId"></a>
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.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** [workflowType](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-workflowType"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PRIVATE | READY2RUN`   
Required: No

 ** [workflowVersionName](#API_StartRun_RequestSyntax) **   <a name="omics-StartRun-request-workflowVersionName"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the * AWS HealthOmics User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: No

## Response Syntax
<a name="API_StartRun_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "configuration": { 
      "arn": "string",
      "name": "string",
      "uuid": "string"
   },
   "id": "string",
   "networkingMode": "string",
   "runOutputUri": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "uuid": "string"
}
```

## Response Elements
<a name="API_StartRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_StartRun_ResponseSyntax) **   <a name="omics-StartRun-response-arn"></a>
Unique resource identifier for the run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [configuration](#API_StartRun_ResponseSyntax) **   <a name="omics-StartRun-response-configuration"></a>
Configuration details for the workflow run.  
Type: [ConfigurationDetails](API_ConfigurationDetails.md) object

 ** [id](#API_StartRun_ResponseSyntax) **   <a name="omics-StartRun-response-id"></a>
The run's ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [networkingMode](#API_StartRun_ResponseSyntax) **   <a name="omics-StartRun-response-networkingMode"></a>
Networking mode for the workflow run.  
Type: String

 ** [runOutputUri](#API_StartRun_ResponseSyntax) **   <a name="omics-StartRun-response-runOutputUri"></a>
The destination for workflow outputs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 750.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [status](#API_StartRun_ResponseSyntax) **   <a name="omics-StartRun-response-status"></a>
The run's status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PENDING | STARTING | RUNNING | STOPPING | COMPLETED | DELETED | CANCELLED | FAILED` 

 ** [tags](#API_StartRun_ResponseSyntax) **   <a name="omics-StartRun-response-tags"></a>
The run's tags.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [uuid](#API_StartRun_ResponseSyntax) **   <a name="omics-StartRun-response-uuid"></a>
The universally unique identifier for a run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_StartRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/StartRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/StartRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/StartRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/StartRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/StartRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/StartRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/StartRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartRun) 

# StartRunBatch
<a name="API_StartRunBatch"></a>

Starts a batch of workflow runs. You can group up to 100,000 runs into a single batch that share a common configuration defined in `defaultRunSetting`. Per-run overrides can be provided either inline via `inlineSettings` (up to 100 runs) or via a JSON file stored in Amazon S3 via `s3UriSettings` (up to 100,000 runs).

 `StartRunBatch` validates common fields synchronously and returns immediately with a batch ID and status `PENDING`. Runs are submitted gradually and asynchronously at a rate governed by your `StartRun` throughput quota.

## Request Syntax
<a name="API_StartRunBatch_RequestSyntax"></a>

```
POST /runBatch HTTP/1.1
Content-type: application/json

{
   "batchName": "string",
   "batchRunSettings": { ... },
   "defaultRunSetting": { 
      "cacheBehavior": "string",
      "cacheId": "string",
      "logLevel": "string",
      "name": "string",
      "outputBucketOwnerId": "string",
      "outputUri": "string",
      "parameters": JSON value,
      "priority": number,
      "retentionMode": "string",
      "roleArn": "string",
      "runGroupId": "string",
      "runTags": { 
         "string" : "string" 
      },
      "storageCapacity": number,
      "storageType": "string",
      "workflowId": "string",
      "workflowOwnerId": "string",
      "workflowType": "string",
      "workflowVersionName": "string"
   },
   "requestId": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_StartRunBatch_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartRunBatch_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [batchName](#API_StartRunBatch_RequestSyntax) **   <a name="omics-StartRunBatch-request-batchName"></a>
An optional user-friendly name for the run batch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [batchRunSettings](#API_StartRunBatch_RequestSyntax) **   <a name="omics-StartRunBatch-request-batchRunSettings"></a>
The individual run configurations. Specify exactly one of `inlineSettings` or `s3UriSettings`. See `BatchRunSettings`.  
Type: [BatchRunSettings](API_BatchRunSettings.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [defaultRunSetting](#API_StartRunBatch_RequestSyntax) **   <a name="omics-StartRunBatch-request-defaultRunSetting"></a>
Shared configuration applied to all runs in the batch. See `DefaultRunSetting`.  
Type: [DefaultRunSetting](API_DefaultRunSetting.md) object  
Required: Yes

 ** [requestId](#API_StartRunBatch_RequestSyntax) **   <a name="omics-StartRunBatch-request-requestId"></a>
A client token used to deduplicate retry requests and prevent duplicate batches from being created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: Yes

 ** [tags](#API_StartRunBatch_RequestSyntax) **   <a name="omics-StartRunBatch-request-tags"></a>
AWS tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use `defaultRunSetting.runTags`.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_StartRunBatch_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "uuid": "string"
}
```

## Response Elements
<a name="API_StartRunBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_StartRunBatch_ResponseSyntax) **   <a name="omics-StartRunBatch-response-arn"></a>
The unique ARN of the run batch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `arn:.+` 

 ** [id](#API_StartRunBatch_ResponseSyntax) **   <a name="omics-StartRunBatch-response-id"></a>
The identifier portion of the run batch ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+` 

 ** [status](#API_StartRunBatch_ResponseSyntax) **   <a name="omics-StartRunBatch-response-status"></a>
The initial status of the run batch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `PENDING | SUBMITTING | INPROGRESS | STOPPING | CANCELLED | FAILED | PROCESSED | RUNS_DELETING | RUNS_DELETED` 

 ** [tags](#API_StartRunBatch_ResponseSyntax) **   <a name="omics-StartRunBatch-response-tags"></a>
AWS tags associated with the run batch.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [uuid](#API_StartRunBatch_ResponseSyntax) **   <a name="omics-StartRunBatch-response-uuid"></a>
The universally unique identifier (UUID) for the run batch.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

## Errors
<a name="API_StartRunBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartRunBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/StartRunBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartRunBatch) 

# StartVariantImportJob
<a name="API_StartVariantImportJob"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Starts a variant import job.

## Request Syntax
<a name="API_StartVariantImportJob_RequestSyntax"></a>

```
POST /import/variant HTTP/1.1
Content-type: application/json

{
   "annotationFields": { 
      "string" : "string" 
   },
   "destinationName": "string",
   "items": [ 
      { 
         "source": "string"
      }
   ],
   "roleArn": "string",
   "runLeftNormalization": boolean
}
```

## URI Request Parameters
<a name="API_StartVariantImportJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartVariantImportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [annotationFields](#API_StartVariantImportJob_RequestSyntax) **   <a name="omics-StartVariantImportJob-request-annotationFields"></a>
The annotation schema generated by the parsed annotation data.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 21.  
Value Length Constraints: Minimum length of 1. Maximum length of 21.  
Required: No

 ** [destinationName](#API_StartVariantImportJob_RequestSyntax) **   <a name="omics-StartVariantImportJob-request-destinationName"></a>
The destination variant store for the job.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}`   
Required: Yes

 ** [items](#API_StartVariantImportJob_RequestSyntax) **   <a name="omics-StartVariantImportJob-request-items"></a>
Items to import.  
Type: Array of [VariantImportItemSource](API_VariantImportItemSource.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** [roleArn](#API_StartVariantImportJob_RequestSyntax) **   <a name="omics-StartVariantImportJob-request-roleArn"></a>
A service role for the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)`   
Required: Yes

 ** [runLeftNormalization](#API_StartVariantImportJob_RequestSyntax) **   <a name="omics-StartVariantImportJob-request-runLeftNormalization"></a>
The job's left normalization setting.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_StartVariantImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "jobId": "string"
}
```

## Response Elements
<a name="API_StartVariantImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [jobId](#API_StartVariantImportJob_ResponseSyntax) **   <a name="omics-StartVariantImportJob-response-jobId"></a>
The job's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_StartVariantImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartVariantImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/StartVariantImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartVariantImportJob) 

# TagResource
<a name="API_TagResource"></a>

Tags a resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="omics-TagResource-request-uri-resourceArn"></a>
The resource's ARN.  
Length Constraints: Minimum length of 1. Maximum length of 150.  
Pattern: `arn:.+`   
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="omics-TagResource-request-tags"></a>
Tags for the resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes tags from a resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="omics-UntagResource-request-uri-resourceArn"></a>
The resource's ARN.  
Length Constraints: Minimum length of 1. Maximum length of 150.  
Pattern: `arn:.+`   
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="omics-UntagResource-request-uri-tagKeys"></a>
Keys of tags to remove.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UntagResource) 

# UpdateAnnotationStore
<a name="API_UpdateAnnotationStore"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Updates an annotation store.

## Request Syntax
<a name="API_UpdateAnnotationStore_RequestSyntax"></a>

```
POST /annotationStore/name HTTP/1.1
Content-type: application/json

{
   "description": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAnnotationStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateAnnotationStore_RequestSyntax) **   <a name="omics-UpdateAnnotationStore-request-uri-name"></a>
A name for the store.  
Required: Yes

## Request Body
<a name="API_UpdateAnnotationStore_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateAnnotationStore_RequestSyntax) **   <a name="omics-UpdateAnnotationStore-request-description"></a>
A description for the store.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_UpdateAnnotationStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "reference": { ... },
   "status": "string",
   "storeFormat": "string",
   "storeOptions": { ... },
   "updateTime": "string"
}
```

## Response Elements
<a name="API_UpdateAnnotationStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [description](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-description"></a>
The store's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

 ** [id](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-id"></a>
The store's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-name"></a>
The store's name.  
Type: String

 ** [reference](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-reference"></a>
The store's genome reference.  
Type: [ReferenceItem](API_ReferenceItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-status"></a>
The store's status.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

 ** [storeFormat](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-storeFormat"></a>
The annotation file format of the store.  
Type: String  
Valid Values: `GFF | TSV | VCF` 

 ** [storeOptions](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-storeOptions"></a>
Parsing options for the store.  
Type: [StoreOptions](API_StoreOptions.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [updateTime](#API_UpdateAnnotationStore_ResponseSyntax) **   <a name="omics-UpdateAnnotationStore-response-updateTime"></a>
When the store was updated.  
Type: Timestamp

## Errors
<a name="API_UpdateAnnotationStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateAnnotationStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UpdateAnnotationStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UpdateAnnotationStore) 

# UpdateAnnotationStoreVersion
<a name="API_UpdateAnnotationStoreVersion"></a>

 Updates the description of an annotation store version. 

## Request Syntax
<a name="API_UpdateAnnotationStoreVersion_RequestSyntax"></a>

```
POST /annotationStore/name/version/versionName HTTP/1.1
Content-type: application/json

{
   "description": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAnnotationStoreVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateAnnotationStoreVersion_RequestSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-request-uri-name"></a>
 The name of an annotation store.   
Required: Yes

 ** [versionName](#API_UpdateAnnotationStoreVersion_RequestSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-request-uri-versionName"></a>
 The name of an annotation store version.   
Required: Yes

## Request Body
<a name="API_UpdateAnnotationStoreVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateAnnotationStoreVersion_RequestSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-request-description"></a>
 The description of an annotation store.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_UpdateAnnotationStoreVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "storeId": "string",
   "updateTime": "string",
   "versionName": "string"
}
```

## Response Elements
<a name="API_UpdateAnnotationStoreVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_UpdateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-response-creationTime"></a>
 The time stamp for when an annotation store version was created.   
Type: Timestamp

 ** [description](#API_UpdateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-response-description"></a>
 The description of an annotation store version.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

 ** [id](#API_UpdateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-response-id"></a>
 The annotation store version ID.   
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_UpdateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-response-name"></a>
 The name of an annotation store.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

 ** [status](#API_UpdateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-response-status"></a>
 The status of an annotation store version.   
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

 ** [storeId](#API_UpdateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-response-storeId"></a>
 The annotation store ID.   
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [updateTime](#API_UpdateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-response-updateTime"></a>
 The time stamp for when an annotation store version was updated.   
Type: Timestamp

 ** [versionName](#API_UpdateAnnotationStoreVersion_ResponseSyntax) **   <a name="omics-UpdateAnnotationStoreVersion-response-versionName"></a>
 The name of an annotation store version.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `([a-z]){1}([a-z0-9_]){2,254}` 

## Errors
<a name="API_UpdateAnnotationStoreVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateAnnotationStoreVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UpdateAnnotationStoreVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UpdateAnnotationStoreVersion) 

# UpdateRunCache
<a name="API_UpdateRunCache"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_UpdateRunCache_RequestSyntax"></a>

```
POST /runCache/id HTTP/1.1
Content-type: application/json

{
   "cacheBehavior": "string",
   "description": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRunCache_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_UpdateRunCache_RequestSyntax) **   <a name="omics-UpdateRunCache-request-uri-id"></a>
The identifier of the run cache you want to update.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_UpdateRunCache_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [cacheBehavior](#API_UpdateRunCache_RequestSyntax) **   <a name="omics-UpdateRunCache-request-cacheBehavior"></a>
Update the default run cache behavior.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `CACHE_ON_FAILURE | CACHE_ALWAYS`   
Required: No

 ** [description](#API_UpdateRunCache_RequestSyntax) **   <a name="omics-UpdateRunCache-request-description"></a>
Update the run cache description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [name](#API_UpdateRunCache_RequestSyntax) **   <a name="omics-UpdateRunCache-request-name"></a>
Update the name of the run cache.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

## Response Syntax
<a name="API_UpdateRunCache_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_UpdateRunCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_UpdateRunCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateRunCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UpdateRunCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UpdateRunCache) 

# UpdateRunGroup
<a name="API_UpdateRunGroup"></a>

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.

## Request Syntax
<a name="API_UpdateRunGroup_RequestSyntax"></a>

```
POST /runGroup/id HTTP/1.1
Content-type: application/json

{
   "maxCpus": number,
   "maxDuration": number,
   "maxGpus": number,
   "maxRuns": number,
   "name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRunGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_UpdateRunGroup_RequestSyntax) **   <a name="omics-UpdateRunGroup-request-uri-id"></a>
The group's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_UpdateRunGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxCpus](#API_UpdateRunGroup_RequestSyntax) **   <a name="omics-UpdateRunGroup-request-maxCpus"></a>
The maximum number of CPUs to use.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** [maxDuration](#API_UpdateRunGroup_RequestSyntax) **   <a name="omics-UpdateRunGroup-request-maxDuration"></a>
A maximum run time for the group in minutes.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** [maxGpus](#API_UpdateRunGroup_RequestSyntax) **   <a name="omics-UpdateRunGroup-request-maxGpus"></a>
The maximum GPUs that can be used by a run group.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** [maxRuns](#API_UpdateRunGroup_RequestSyntax) **   <a name="omics-UpdateRunGroup-request-maxRuns"></a>
The maximum number of concurrent runs for the group.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** [name](#API_UpdateRunGroup_RequestSyntax) **   <a name="omics-UpdateRunGroup-request-name"></a>
A name for the group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

## Response Syntax
<a name="API_UpdateRunGroup_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_UpdateRunGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_UpdateRunGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateRunGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UpdateRunGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UpdateRunGroup) 

# UpdateSequenceStore
<a name="API_UpdateSequenceStore"></a>

Update one or more parameters for the sequence store.

## Request Syntax
<a name="API_UpdateSequenceStore_RequestSyntax"></a>

```
PATCH /sequencestore/id HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "fallbackLocation": "string",
   "name": "string",
   "propagatedSetLevelTags": [ "string" ],
   "s3AccessConfig": { 
      "accessLogLocation": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateSequenceStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_UpdateSequenceStore_RequestSyntax) **   <a name="omics-UpdateSequenceStore-request-uri-id"></a>
The ID of the sequence store.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_UpdateSequenceStore_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateSequenceStore_RequestSyntax) **   <a name="omics-UpdateSequenceStore-request-clientToken"></a>
To ensure that requests don't run multiple times, specify a unique token for each request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [description](#API_UpdateSequenceStore_RequestSyntax) **   <a name="omics-UpdateSequenceStore-request-description"></a>
A description for the sequence store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [fallbackLocation](#API_UpdateSequenceStore_RequestSyntax) **   <a name="omics-UpdateSequenceStore-request-fallbackLocation"></a>
The S3 URI of a bucket and folder to store Read Sets that fail to upload.  
Type: String  
Pattern: `$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?`   
Required: No

 ** [name](#API_UpdateSequenceStore_RequestSyntax) **   <a name="omics-UpdateSequenceStore-request-name"></a>
A name for the sequence store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [propagatedSetLevelTags](#API_UpdateSequenceStore_RequestSyntax) **   <a name="omics-UpdateSequenceStore-request-propagatedSetLevelTags"></a>
The tags keys to propagate to the S3 objects associated with read sets in the sequence store.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [s3AccessConfig](#API_UpdateSequenceStore_RequestSyntax) **   <a name="omics-UpdateSequenceStore-request-s3AccessConfig"></a>
S3 access configuration parameters.  
Type: [S3AccessConfig](API_S3AccessConfig.md) object  
Required: No

## Response Syntax
<a name="API_UpdateSequenceStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "description": "string",
   "eTagAlgorithmFamily": "string",
   "fallbackLocation": "string",
   "id": "string",
   "name": "string",
   "propagatedSetLevelTags": [ "string" ],
   "s3Access": { 
      "accessLogLocation": "string",
      "s3AccessPointArn": "string",
      "s3Uri": "string"
   },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "status": "string",
   "statusMessage": "string",
   "updateTime": "string"
}
```

## Response Elements
<a name="API_UpdateSequenceStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-arn"></a>
The ARN of the sequence store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `arn:.+` 

 ** [creationTime](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-creationTime"></a>
The time when the store was created.  
Type: Timestamp

 ** [description](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-description"></a>
Description of the sequence store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [eTagAlgorithmFamily](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-eTagAlgorithmFamily"></a>
The ETag algorithm family to use on ingested read sets.  
Type: String  
Valid Values: `MD5up | SHA256up | SHA512up` 

 ** [fallbackLocation](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-fallbackLocation"></a>
The S3 URI of a bucket and folder to store Read Sets that fail to upload.  
Type: String  
Pattern: `$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?` 

 ** [id](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-id"></a>
The ID of the sequence store.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+` 

 ** [name](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-name"></a>
The name of the sequence store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [propagatedSetLevelTags](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-propagatedSetLevelTags"></a>
The tags keys to propagate to the S3 objects associated with read sets in the sequence store.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [s3Access](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-s3Access"></a>
The S3 access metadata of the sequence store.  
Type: [SequenceStoreS3Access](API_SequenceStoreS3Access.md) object

 ** [sseConfig](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-sseConfig"></a>
Server-side encryption (SSE) settings for a store.  
Type: [SseConfig](API_SseConfig.md) object

 ** [status](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-status"></a>
The status of the sequence store.  
Type: String  
Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | FAILED` 

 ** [statusMessage](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-statusMessage"></a>
The status message of the sequence store.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` 

 ** [updateTime](#API_UpdateSequenceStore_ResponseSyntax) **   <a name="omics-UpdateSequenceStore-response-updateTime"></a>
The last-updated time of the Sequence Store.  
Type: Timestamp

## Errors
<a name="API_UpdateSequenceStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSequenceStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UpdateSequenceStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UpdateSequenceStore) 

# UpdateVariantStore
<a name="API_UpdateVariantStore"></a>

**Important**  
 AWS HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS HealthOmics variant store and annotation store availability change](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Updates a variant store.

## Request Syntax
<a name="API_UpdateVariantStore_RequestSyntax"></a>

```
POST /variantStore/name HTTP/1.1
Content-type: application/json

{
   "description": "string"
}
```

## URI Request Parameters
<a name="API_UpdateVariantStore_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_UpdateVariantStore_RequestSyntax) **   <a name="omics-UpdateVariantStore-request-uri-name"></a>
A name for the store.  
Required: Yes

## Request Body
<a name="API_UpdateVariantStore_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateVariantStore_RequestSyntax) **   <a name="omics-UpdateVariantStore-request-description"></a>
A description for the store.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_UpdateVariantStore_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "reference": { ... },
   "status": "string",
   "updateTime": "string"
}
```

## Response Elements
<a name="API_UpdateVariantStore_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_UpdateVariantStore_ResponseSyntax) **   <a name="omics-UpdateVariantStore-response-creationTime"></a>
When the store was created.  
Type: Timestamp

 ** [description](#API_UpdateVariantStore_ResponseSyntax) **   <a name="omics-UpdateVariantStore-response-description"></a>
The store's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.

 ** [id](#API_UpdateVariantStore_ResponseSyntax) **   <a name="omics-UpdateVariantStore-response-id"></a>
The store's ID.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_UpdateVariantStore_ResponseSyntax) **   <a name="omics-UpdateVariantStore-response-name"></a>
The store's name.  
Type: String

 ** [reference](#API_UpdateVariantStore_ResponseSyntax) **   <a name="omics-UpdateVariantStore-response-reference"></a>
The store's genome reference.  
Type: [ReferenceItem](API_ReferenceItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_UpdateVariantStore_ResponseSyntax) **   <a name="omics-UpdateVariantStore-response-status"></a>
The store's status.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` 

 ** [updateTime](#API_UpdateVariantStore_ResponseSyntax) **   <a name="omics-UpdateVariantStore-response-updateTime"></a>
When the store was updated.  
Type: Timestamp

## Errors
<a name="API_UpdateVariantStore_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateVariantStore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UpdateVariantStore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UpdateVariantStore) 

# UpdateWorkflow
<a name="API_UpdateWorkflow"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/update-private-workflow.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_UpdateWorkflow_RequestSyntax"></a>

```
POST /workflow/id HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "readmeMarkdown": "string",
   "storageCapacity": number,
   "storageType": "string"
}
```

## URI Request Parameters
<a name="API_UpdateWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_UpdateWorkflow_RequestSyntax) **   <a name="omics-UpdateWorkflow-request-uri-id"></a>
The workflow's ID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_UpdateWorkflow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateWorkflow_RequestSyntax) **   <a name="omics-UpdateWorkflow-request-description"></a>
A description for the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [name](#API_UpdateWorkflow_RequestSyntax) **   <a name="omics-UpdateWorkflow-request-name"></a>
A name for the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [readmeMarkdown](#API_UpdateWorkflow_RequestSyntax) **   <a name="omics-UpdateWorkflow-request-readmeMarkdown"></a>
The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.  
Type: String  
Required: No

 ** [storageCapacity](#API_UpdateWorkflow_RequestSyntax) **   <a name="omics-UpdateWorkflow-request-storageCapacity"></a>
The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.   
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.  
Required: No

 ** [storageType](#API_UpdateWorkflow_RequestSyntax) **   <a name="omics-UpdateWorkflow-request-storageType"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html) in the * AWS HealthOmics User Guide*.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `STATIC | DYNAMIC`   
Required: No

## Response Syntax
<a name="API_UpdateWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_UpdateWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_UpdateWorkflow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UpdateWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UpdateWorkflow) 

# UpdateWorkflowVersion
<a name="API_UpdateWorkflowVersion"></a>

Updates information about the workflow version. For more information, see [Workflow versioning in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_UpdateWorkflowVersion_RequestSyntax"></a>

```
POST /workflow/workflowId/version/versionName HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "readmeMarkdown": "string",
   "storageCapacity": number,
   "storageType": "string"
}
```

## URI Request Parameters
<a name="API_UpdateWorkflowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [versionName](#API_UpdateWorkflowVersion_RequestSyntax) **   <a name="omics-UpdateWorkflowVersion-request-uri-versionName"></a>
The name of the workflow version.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`   
Required: Yes

 ** [workflowId](#API_UpdateWorkflowVersion_RequestSyntax) **   <a name="omics-UpdateWorkflowVersion-request-uri-workflowId"></a>
The workflow's ID. The `workflowId` is not the UUID.  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_UpdateWorkflowVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateWorkflowVersion_RequestSyntax) **   <a name="omics-UpdateWorkflowVersion-request-description"></a>
Description of the workflow version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`   
Required: No

 ** [readmeMarkdown](#API_UpdateWorkflowVersion_RequestSyntax) **   <a name="omics-UpdateWorkflowVersion-request-readmeMarkdown"></a>
The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.  
Type: String  
Required: No

 ** [storageCapacity](#API_UpdateWorkflowVersion_RequestSyntax) **   <a name="omics-UpdateWorkflowVersion-request-storageCapacity"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100000.  
Required: No

 ** [storageType](#API_UpdateWorkflowVersion_RequestSyntax) **   <a name="omics-UpdateWorkflowVersion-request-storageType"></a>
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](https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html) in the *in the * AWS HealthOmics User Guide* *.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Valid Values: `STATIC | DYNAMIC`   
Required: No

## Response Syntax
<a name="API_UpdateWorkflowVersion_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_UpdateWorkflowVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_UpdateWorkflowVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request cannot be applied to the target resource in its current state.  
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateWorkflowVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UpdateWorkflowVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UpdateWorkflowVersion) 

# UploadReadSetPart
<a name="API_UploadReadSetPart"></a>

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](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html) in the * AWS HealthOmics User Guide*.

## Request Syntax
<a name="API_UploadReadSetPart_RequestSyntax"></a>

```
PUT /sequencestore/sequenceStoreId/upload/uploadId/part?partNumber=partNumber&partSource=partSource HTTP/1.1

payload
```

## URI Request Parameters
<a name="API_UploadReadSetPart_RequestParameters"></a>

The request uses the following URI parameters.

 ** [partNumber](#API_UploadReadSetPart_RequestSyntax) **   <a name="omics-UploadReadSetPart-request-uri-partNumber"></a>
The number of the part being uploaded.  
Valid Range: Minimum value of 1. Maximum value of 10000.  
Required: Yes

 ** [partSource](#API_UploadReadSetPart_RequestSyntax) **   <a name="omics-UploadReadSetPart-request-uri-partSource"></a>
The source file for an upload part.  
Valid Values: `SOURCE1 | SOURCE2`   
Required: Yes

 ** [sequenceStoreId](#API_UploadReadSetPart_RequestSyntax) **   <a name="omics-UploadReadSetPart-request-uri-sequenceStoreId"></a>
The Sequence Store ID used for the multipart upload.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

 ** [uploadId](#API_UploadReadSetPart_RequestSyntax) **   <a name="omics-UploadReadSetPart-request-uri-uploadId"></a>
The ID for the initiated multipart upload.  
Length Constraints: Minimum length of 10. Maximum length of 36.  
Pattern: `[0-9]+`   
Required: Yes

## Request Body
<a name="API_UploadReadSetPart_RequestBody"></a>

The request accepts the following binary data.

 ** [payload](#API_UploadReadSetPart_RequestSyntax) **   <a name="omics-UploadReadSetPart-request-payload"></a>
The read set data to upload for a part.  
Required: Yes

## Response Syntax
<a name="API_UploadReadSetPart_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "checksum": "string"
}
```

## Response Elements
<a name="API_UploadReadSetPart_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [checksum](#API_UploadReadSetPart_ResponseSyntax) **   <a name="omics-UploadReadSetPart-response-checksum"></a>
An identifier used to confirm that parts are being added to the intended upload.  
Type: String

## Errors
<a name="API_UploadReadSetPart_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
An unexpected error occurred. Try the request again.  
HTTP Status Code: 500

 ** NotSupportedOperationException **   
 The operation is not supported by Amazon Omics, or the API does not exist.   
HTTP Status Code: 405

 ** RequestTimeoutException **   
The request timed out.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The target resource was not found in the current Region.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request exceeds a service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UploadReadSetPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/omics-2022-11-28/UploadReadSetPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/UploadReadSetPart)