# Data Types The following data types are supported: + [ActivateReadSetFilter](API_ActivateReadSetFilter.md) + [ActivateReadSetJobItem](API_ActivateReadSetJobItem.md) + [ActivateReadSetSourceItem](API_ActivateReadSetSourceItem.md) + [AnnotationImportItemDetail](API_AnnotationImportItemDetail.md) + [AnnotationImportItemSource](API_AnnotationImportItemSource.md) + [AnnotationImportJobItem](API_AnnotationImportJobItem.md) + [AnnotationStoreItem](API_AnnotationStoreItem.md) + [AnnotationStoreVersionItem](API_AnnotationStoreVersionItem.md) + [BatchListItem](API_BatchListItem.md) + [BatchRunSettings](API_BatchRunSettings.md) + [CompleteReadSetUploadPartListItem](API_CompleteReadSetUploadPartListItem.md) + [ConfigurationDetails](API_ConfigurationDetails.md) + [ConfigurationListItem](API_ConfigurationListItem.md) + [ContainerRegistryMap](API_ContainerRegistryMap.md) + [DefaultRunSetting](API_DefaultRunSetting.md) + [DefinitionRepository](API_DefinitionRepository.md) + [DefinitionRepositoryDetails](API_DefinitionRepositoryDetails.md) + [ETag](API_ETag.md) + [ExportReadSet](API_ExportReadSet.md) + [ExportReadSetDetail](API_ExportReadSetDetail.md) + [ExportReadSetFilter](API_ExportReadSetFilter.md) + [ExportReadSetJobDetail](API_ExportReadSetJobDetail.md) + [FileInformation](API_FileInformation.md) + [Filter](API_Filter.md) + [FormatOptions](API_FormatOptions.md) + [ImageDetails](API_ImageDetails.md) + [ImageMapping](API_ImageMapping.md) + [ImportReadSetFilter](API_ImportReadSetFilter.md) + [ImportReadSetJobItem](API_ImportReadSetJobItem.md) + [ImportReadSetSourceItem](API_ImportReadSetSourceItem.md) + [ImportReferenceFilter](API_ImportReferenceFilter.md) + [ImportReferenceJobItem](API_ImportReferenceJobItem.md) + [ImportReferenceSourceItem](API_ImportReferenceSourceItem.md) + [InlineSetting](API_InlineSetting.md) + [ListAnnotationImportJobsFilter](API_ListAnnotationImportJobsFilter.md) + [ListAnnotationStoresFilter](API_ListAnnotationStoresFilter.md) + [ListAnnotationStoreVersionsFilter](API_ListAnnotationStoreVersionsFilter.md) + [ListVariantImportJobsFilter](API_ListVariantImportJobsFilter.md) + [ListVariantStoresFilter](API_ListVariantStoresFilter.md) + [MultipartReadSetUploadListItem](API_MultipartReadSetUploadListItem.md) + [ReadOptions](API_ReadOptions.md) + [ReadSetBatchError](API_ReadSetBatchError.md) + [ReadSetFiles](API_ReadSetFiles.md) + [ReadSetFilter](API_ReadSetFilter.md) + [ReadSetListItem](API_ReadSetListItem.md) + [ReadSetS3Access](API_ReadSetS3Access.md) + [ReadSetUploadPartListFilter](API_ReadSetUploadPartListFilter.md) + [ReadSetUploadPartListItem](API_ReadSetUploadPartListItem.md) + [ReferenceFiles](API_ReferenceFiles.md) + [ReferenceFilter](API_ReferenceFilter.md) + [ReferenceItem](API_ReferenceItem.md) + [ReferenceListItem](API_ReferenceListItem.md) + [ReferenceStoreDetail](API_ReferenceStoreDetail.md) + [ReferenceStoreFilter](API_ReferenceStoreFilter.md) + [RegistryMapping](API_RegistryMapping.md) + [RunBatchListItem](API_RunBatchListItem.md) + [RunCacheListItem](API_RunCacheListItem.md) + [RunConfigurations](API_RunConfigurations.md) + [RunConfigurationsResponse](API_RunConfigurationsResponse.md) + [RunGroupListItem](API_RunGroupListItem.md) + [RunListItem](API_RunListItem.md) + [RunLogLocation](API_RunLogLocation.md) + [RunSummary](API_RunSummary.md) + [S3AccessConfig](API_S3AccessConfig.md) + [SequenceInformation](API_SequenceInformation.md) + [SequenceStoreDetail](API_SequenceStoreDetail.md) + [SequenceStoreFilter](API_SequenceStoreFilter.md) + [SequenceStoreS3Access](API_SequenceStoreS3Access.md) + [ShareDetails](API_ShareDetails.md) + [SourceFiles](API_SourceFiles.md) + [SourceReference](API_SourceReference.md) + [SseConfig](API_SseConfig.md) + [StartReadSetActivationJobSourceItem](API_StartReadSetActivationJobSourceItem.md) + [StartReadSetImportJobSourceItem](API_StartReadSetImportJobSourceItem.md) + [StartReferenceImportJobSourceItem](API_StartReferenceImportJobSourceItem.md) + [StoreOptions](API_StoreOptions.md) + [SubmissionSummary](API_SubmissionSummary.md) + [TaskListItem](API_TaskListItem.md) + [TsvOptions](API_TsvOptions.md) + [TsvStoreOptions](API_TsvStoreOptions.md) + [TsvVersionOptions](API_TsvVersionOptions.md) + [VariantImportItemDetail](API_VariantImportItemDetail.md) + [VariantImportItemSource](API_VariantImportItemSource.md) + [VariantImportJobItem](API_VariantImportJobItem.md) + [VariantStoreItem](API_VariantStoreItem.md) + [VcfOptions](API_VcfOptions.md) + [VersionDeleteError](API_VersionDeleteError.md) + [VersionOptions](API_VersionOptions.md) + [VpcConfig](API_VpcConfig.md) + [VpcConfigResponse](API_VpcConfigResponse.md) + [WorkflowListItem](API_WorkflowListItem.md) + [WorkflowParameter](API_WorkflowParameter.md) + [WorkflowVersionListItem](API_WorkflowVersionListItem.md) # ActivateReadSetFilter A read set activation job filter. ## Contents ** createdAfter ** The filter's start date. Type: Timestamp Required: No ** createdBefore ** The filter's end date. Type: Timestamp Required: No ** status ** The filter's status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ActivateReadSetFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ActivateReadSetFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ActivateReadSetFilter) # ActivateReadSetJobItem A read set activation job. ## Contents ** creationTime ** When the job was created. Type: Timestamp Required: Yes ** id ** The job's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** sequenceStoreId ** The job's sequence store ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** status ** The job's status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` Required: Yes ** completionTime ** When the job completed. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ActivateReadSetJobItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ActivateReadSetJobItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ActivateReadSetJobItem) # ActivateReadSetSourceItem A source for a read set activation job. ## Contents ** readSetId ** The source's read set ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** status ** The source's status. Type: String Valid Values: `NOT_STARTED | IN_PROGRESS | FINISHED | FAILED` Required: Yes ** statusMessage ** The source'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}]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ActivateReadSetSourceItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ActivateReadSetSourceItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ActivateReadSetSourceItem) # AnnotationImportItemDetail Details about an imported annotation item. ## Contents ** jobStatus ** The item's job status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` Required: Yes ** source ** The source file's location in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/AnnotationImportItemDetail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/AnnotationImportItemDetail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/AnnotationImportItemDetail) # AnnotationImportItemSource A source for an annotation import job. ## Contents ** source ** The source file's location in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/AnnotationImportItemSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/AnnotationImportItemSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/AnnotationImportItemSource) # AnnotationImportJobItem An annotation import job. ## Contents ** creationTime ** When the job was created. Type: Timestamp Required: Yes ** destinationName ** The job's destination annotation store. Type: String Required: Yes ** id ** The job's ID. Type: String Required: Yes ** roleArn ** The job's service role ARN. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` Required: Yes ** status ** The job's status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` Required: Yes ** updateTime ** When the job was updated. Type: Timestamp Required: Yes ** versionName ** 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: Yes ** annotationFields ** 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 ** completionTime ** When the job completed. Type: Timestamp Required: No ** runLeftNormalization ** The job's left normalization setting. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/AnnotationImportJobItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/AnnotationImportJobItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/AnnotationImportJobItem) # AnnotationStoreItem An annotation store. ## Contents ** creationTime ** The store's creation time. Type: Timestamp Required: Yes ** description ** The store's description. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: Yes ** id ** 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}` Required: Yes ** name ** The store's name. Type: String Required: Yes ** reference ** 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. Required: Yes ** sseConfig ** The store's server-side encryption (SSE) settings. Type: [SseConfig](API_SseConfig.md) object Required: Yes ** status ** The store's status. Type: String Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` Required: Yes ** statusMessage ** The store's status message. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: Yes ** storeArn ** The store's ARN. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` Required: Yes ** storeFormat ** The store's file format. Type: String Valid Values: `GFF | TSV | VCF` Required: Yes ** storeSizeBytes ** The store's size in bytes. Type: Long Required: Yes ** updateTime ** When the store was updated. Type: Timestamp Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/AnnotationStoreItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/AnnotationStoreItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/AnnotationStoreItem) # AnnotationStoreVersionItem Annotation store versions. ## Contents ** creationTime ** The time stamp for when an annotation store version was created. Type: Timestamp Required: Yes ** description ** The description of an annotation store version. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: Yes ** id ** 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}` Required: Yes ** name ** A 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}` Required: Yes ** status ** The status of an annotation store version. Type: String Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` Required: Yes ** statusMessage ** The status of an annotation store version. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: Yes ** storeId ** The store ID for an 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}` Required: Yes ** updateTime ** The time stamp for when an annotation store version was updated. Type: Timestamp Required: Yes ** versionArn ** The Arn for an annotation store version. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` Required: Yes ** versionName ** 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}` Required: Yes ** versionSizeBytes ** The size of an annotation store version in Bytes. Type: Long Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/AnnotationStoreVersionItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/AnnotationStoreVersionItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/AnnotationStoreVersionItem) # BatchListItem A summary of a batch returned by `ListBatch`. ## Contents ** createdAt ** The timestamp when the batch was created. Type: Timestamp Required: No ** id ** The batch identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** name ** The batch name. 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 ** status ** The current batch status. 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` Required: No ** totalRuns ** The total number of runs in the batch. Type: Integer Required: No ** workflowId ** The identifier of the workflow used for the batch. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/BatchListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/BatchListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/BatchListItem) # BatchRunSettings A union type representing per-run configurations for the batch. Specify exactly one of the following members. ## Contents **Important** This data type is a UNION, so only one of the following members can be specified when used or returned. ** inlineSettings ** A list of per-run configurations provided inline in the request. Each entry must include a unique `runSettingId`. Supports up to 100 entries. For batches with more than 100 runs, use `s3UriSettings`. Type: Array of [InlineSetting](API_InlineSetting.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No ** s3UriSettings ** An Amazon S3 URI pointing to a JSON file containing per-run configurations. The file must be a JSON array in the same format as `inlineSettings`. Supports up to 100,000 run configurations. The maximum file size is 6 GB. The IAM service role in `roleArn` must have read access to this S3 object. HealthOmics validates access to the file during the synchronous API call and records the file's ETag. If the file is modified after submission, the batch fails. 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/BatchRunSettings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/BatchRunSettings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/BatchRunSettings) # CompleteReadSetUploadPartListItem Part of the response to the CompleteReadSetUpload API, including metadata. ## Contents ** checksum ** A unique identifier used to confirm that parts are being added to the correct upload. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` Required: Yes ** partNumber ** A number identifying the part in a read set upload. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. Required: Yes ** partSource ** The source file of the part being uploaded. Type: String Valid Values: `SOURCE1 | SOURCE2` Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/CompleteReadSetUploadPartListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/CompleteReadSetUploadPartListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/CompleteReadSetUploadPartListItem) # ConfigurationDetails Minimal details for a configuration resource. ## Contents ** arn ** Unique resource identifier for the configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 190. Pattern: `arn:.+` Required: No ** name ** 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: No ** uuid ** 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}]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ConfigurationDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ConfigurationDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ConfigurationDetails) # ConfigurationListItem Configuration list item with summary information. ## Contents ** arn ** Unique resource identifier for the configuration. Type: String Length Constraints: Minimum length of 1. Maximum length of 190. Pattern: `arn:.+` Required: No ** creationTime ** Configuration creation timestamp. Type: Timestamp Required: No ** description ** 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 ** 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: No ** status ** Current configuration status. Type: String Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | DELETED | FAILED` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ConfigurationListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ConfigurationListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ConfigurationListItem) # ContainerRegistryMap 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*. ## Contents ** imageMappings ** Image mappings specify path mappings between the ECR private repository and their corresponding external repositories. Type: Array of [ImageMapping](API_ImageMapping.md) objects Required: No ** registryMappings ** Mapping that provides the ECR repository path where upstream container images are pulled and synchronized. Type: Array of [RegistryMapping](API_RegistryMapping.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ContainerRegistryMap) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ContainerRegistryMap) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ContainerRegistryMap) # DefaultRunSetting Shared configuration applied to all runs in a batch. Fields specified in a per-run `InlineSetting` entry override the corresponding fields in this object for that run. The `parameters` and `runTags` fields are merged rather than replaced — run-specific values take precedence when keys overlap. ## Contents ** roleArn ** The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual `StartRun` calls. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:.+` Required: Yes ** workflowId ** The identifier of the workflow to run. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: Yes ** cacheBehavior ** The cache behavior for the runs. Requires `cacheId` to be set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `CACHE_ON_FAILURE | CACHE_ALWAYS` Required: No ** cacheId ** The identifier of the run cache to associate with the runs. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** logLevel ** The verbosity level for CloudWatch Logs emitted during each run. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `OFF | FATAL | ERROR | ALL` Required: No ** name ** An optional user-friendly name applied to each workflow run. Can be overridden per 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}]+` Required: No ** outputBucketOwnerId ** The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run. Type: String Length Constraints: Fixed length of 12. Pattern: `[0-9]+` Required: No ** outputUri ** The destination S3 URI for workflow outputs. Must begin with `s3://`. The `roleArn` must grant write permissions to this bucket. Can be overridden per run. 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 ** parameters ** Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run. Type: JSON value Required: No ** priority ** An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100000. Required: No ** retentionMode ** The retention behavior for runs after completion. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `RETAIN | REMOVE` Required: No ** runGroupId ** The ID of the run group to contain all workflow runs in the batch. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** runTags ** AWS tags to associate with each workflow run. Merged with per-run `runTags`; run-specific values take precedence when keys overlap. 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 ** storageCapacity ** The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100000. Required: No ** storageType ** The storage type for the workflow runs. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `STATIC | DYNAMIC` Required: No ** workflowOwnerId ** The AWS account ID of the workflow owner, used for cross-account workflow sharing. Type: String Pattern: `[0-9]{12}` Required: No ** workflowType ** The type of the originating workflow. Batch runs are not supported with `READY2RUN` workflows. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `PRIVATE | READY2RUN` Required: No ** workflowVersionName ** The version name of the specified workflow. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DefaultRunSetting) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DefaultRunSetting) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DefaultRunSetting) # DefinitionRepository Contains information about a source code repository that hosts the workflow definition files. ## Contents ** connectionArn ** The Amazon Resource Name (ARN) of the connection to the source code repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+` Required: Yes ** fullRepositoryId ** The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'. Type: String Pattern: `.+/.+` Required: Yes ** excludeFilePatterns ** A list of file patterns to exclude when retrieving the workflow definition from the repository. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ** sourceReference ** The source reference for the repository, such as a branch name, tag, or commit ID. Type: [SourceReference](API_SourceReference.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DefinitionRepository) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DefinitionRepository) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DefinitionRepository) # DefinitionRepositoryDetails Contains detailed information about the source code repository that hosts the workflow definition files. ## Contents ** connectionArn ** The Amazon Resource Name (ARN) of the connection to the source code repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+` Required: No ** fullRepositoryId ** The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'. Type: String Pattern: `.+/.+` Required: No ** providerEndpoint ** The endpoint URL of the source code repository provider. Type: String Required: No ** providerType ** The provider type of the source code repository, such as Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, and GitLabSelfManaged. Type: String Required: No ** sourceReference ** The source reference for the repository, such as a branch name, tag, or commit ID. Type: [SourceReference](API_SourceReference.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/DefinitionRepositoryDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/DefinitionRepositoryDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/DefinitionRepositoryDetails) # ETag The entity tag (ETag) is a hash of the object representing its semantic content. ## Contents ** algorithm ** The algorithm used to calculate the read set’s ETag(s). Type: String Valid Values: `FASTQ_MD5up | BAM_MD5up | CRAM_MD5up | FASTQ_SHA256up | BAM_SHA256up | CRAM_SHA256up | FASTQ_SHA512up | BAM_SHA512up | CRAM_SHA512up` Required: No ** source1 ** The ETag hash calculated on Source1 of the read set. Type: String Required: No ** source2 ** The ETag hash calculated on Source2 of the read set. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ETag) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ETag) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ETag) # ExportReadSet A read set. ## Contents ** readSetId ** The set's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ExportReadSet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ExportReadSet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ExportReadSet) # ExportReadSetDetail Details about a read set. ## Contents ** id ** The set's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** status ** The set's status. Type: String Valid Values: `NOT_STARTED | IN_PROGRESS | FINISHED | FAILED` Required: Yes ** statusMessage ** The set'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}]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ExportReadSetDetail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ExportReadSetDetail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ExportReadSetDetail) # ExportReadSetFilter An read set export job filter. ## Contents ** createdAfter ** The filter's start date. Type: Timestamp Required: No ** createdBefore ** The filter's end date. Type: Timestamp Required: No ** status ** A status to filter on. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ExportReadSetFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ExportReadSetFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ExportReadSetFilter) # ExportReadSetJobDetail Details about a read set export job. ## Contents ** creationTime ** When the job was created. Type: Timestamp Required: Yes ** destination ** The job's destination in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?` Required: Yes ** id ** The job's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** sequenceStoreId ** The job's sequence store ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** status ** The job's status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` Required: Yes ** completionTime ** When the job completed. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ExportReadSetJobDetail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ExportReadSetJobDetail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ExportReadSetJobDetail) # FileInformation Details about a file. ## Contents ** contentLength ** The file's content length. Type: Long Valid Range: Minimum value of 1. Maximum value of 5497558138880. Required: No ** partSize ** The file's part size. Type: Long Valid Range: Minimum value of 1. Maximum value of 5368709120. Required: No ** s3Access ** The S3 URI metadata of a sequence store. Type: [ReadSetS3Access](API_ReadSetS3Access.md) object Required: No ** totalParts ** The file's total parts. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/FileInformation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/FileInformation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/FileInformation) # Filter Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status. ## Contents ** resourceArns ** Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: No ** status ** Filter based on the resource status. You can specify up to 10 values. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Valid Values: `PENDING | ACTIVATING | ACTIVE | DELETING | DELETED | FAILED` Required: No ** type ** The type of resources to be filtered. You can specify one or more of the resource types. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Valid Values: `VARIANT_STORE | ANNOTATION_STORE | WORKFLOW` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/Filter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/Filter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/Filter) # FormatOptions Formatting options for a file. ## Contents **Important** This data type is a UNION, so only one of the following members can be specified when used or returned. ** tsvOptions ** Options for a TSV file. Type: [TsvOptions](API_TsvOptions.md) object Required: No ** vcfOptions ** Options for a VCF file. Type: [VcfOptions](API_VcfOptions.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/FormatOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/FormatOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/FormatOptions) # ImageDetails Information about the container image used for a task. ## Contents ** image ** The URI of the container image. 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 ** imageDigest ** The container image digest. If the image URI was transformed, this will be the digest of the container image referenced by the transformed URI. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `sha[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` Required: No ** sourceImage ** URI of the source registry. If the URI is from a third-party registry, AWS HealthOmics transforms the URI to the corresponding ECR path, using the pull-through cache mapping rules. 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ImageDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ImageDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ImageDetails) # ImageMapping Specifies image mappings that workflow tasks can use. For example, you can replace all the task references of a public image to use an equivalent image in your private ECR repository. You can use image mappings with upstream registries that don't support pull through cache. You need to manually synchronize the upstream registry with your private repository. ## Contents ** destinationImage ** Specifies the URI of the corresponding image in the private ECR registry. 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 ** sourceImage ** Specifies the URI of the source image in the upstream registry. 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ImageMapping) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ImageMapping) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ImageMapping) # ImportReadSetFilter A filter for import read set jobs. ## Contents ** createdAfter ** The filter's start date. Type: Timestamp Required: No ** createdBefore ** The filter's end date. Type: Timestamp Required: No ** status ** A status to filter on. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ImportReadSetFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ImportReadSetFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ImportReadSetFilter) # ImportReadSetJobItem An import read set job. ## Contents ** creationTime ** When the job was created. Type: Timestamp Required: Yes ** id ** The job's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** roleArn ** The job's service role ARN. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:.*` Required: Yes ** sequenceStoreId ** The job's sequence store ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** status ** The job's status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` Required: Yes ** completionTime ** When the job completed. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ImportReadSetJobItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ImportReadSetJobItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ImportReadSetJobItem) # ImportReadSetSourceItem A source for an import read set job. ## Contents ** sampleId ** 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 ** sourceFiles ** The source files' location in Amazon S3. Type: [SourceFiles](API_SourceFiles.md) object Required: Yes ** sourceFileType ** The source's file type. Type: String Valid Values: `FASTQ | BAM | CRAM | UBAM` Required: Yes ** status ** The source's status. Type: String Valid Values: `NOT_STARTED | IN_PROGRESS | FINISHED | FAILED` Required: Yes ** subjectId ** 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 ** description ** The source'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}]+` Required: No ** generatedFrom ** 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 ** The source'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}]+` Required: No ** readSetId ** The source's read set ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: No ** referenceArn ** The source's genome reference ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: No ** statusMessage ** The source'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}]+` Required: No ** tags ** The source'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. Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ImportReadSetSourceItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ImportReadSetSourceItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ImportReadSetSourceItem) # ImportReferenceFilter A filter for import references. ## Contents ** createdAfter ** The filter's start date. Type: Timestamp Required: No ** createdBefore ** The filter's end date. Type: Timestamp Required: No ** status ** A status to filter on. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ImportReferenceFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ImportReferenceFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ImportReferenceFilter) # ImportReferenceJobItem An import reference job. ## Contents ** creationTime ** When the job was created. Type: Timestamp Required: Yes ** id ** The job's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** referenceStoreId ** The job's reference store ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** roleArn ** The job's service role ARN. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:.*` Required: Yes ** status ** The job's status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES` Required: Yes ** completionTime ** When the job completed. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ImportReferenceJobItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ImportReferenceJobItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ImportReferenceJobItem) # ImportReferenceSourceItem An genome reference source. ## Contents ** status ** The source's status. Type: String Valid Values: `NOT_STARTED | IN_PROGRESS | FINISHED | FAILED` Required: Yes ** description ** The source'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}]+` Required: No ** name ** The source'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}]+` Required: No ** referenceId ** The source's reference ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: No ** sourceFile ** The source file's location in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: No ** statusMessage ** The source'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}]+` Required: No ** tags ** The source'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. Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ImportReferenceSourceItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ImportReferenceSourceItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ImportReferenceSourceItem) # InlineSetting A per-run configuration that overrides or merges with fields from `DefaultRunSetting` for a specific run. ## Contents ** runSettingId ** A customer-provided unique identifier for this run configuration within the batch. After submission, use `ListRunsInBatch` to map each `runSettingId` to the HealthOmics-generated `runId`. 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 ** name ** An optional user-friendly name for this 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}]+` Required: No ** outputBucketOwnerId ** The expected AWS account ID of the owner of the output S3 bucket for this run. Type: String Length Constraints: Fixed length of 12. Pattern: `[0-9]+` Required: No ** outputUri ** Override the destination S3 URI for this run's 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}]+` Required: No ** parameters ** Per-run workflow parameters. Merged with `defaultRunSetting.parameters`; values in this object take precedence when keys overlap. Type: JSON value Required: No ** priority ** Override the priority for this run. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100000. Required: No ** runTags ** Per-run AWS tags. Merged with `defaultRunSetting.runTags`; values in this object take precedence when keys overlap. 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/InlineSetting) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/InlineSetting) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/InlineSetting) # ListAnnotationImportJobsFilter A filter for annotation import jobs. ## Contents ** status ** A status to filter on. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` Required: No ** storeName ** A store name to filter on. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListAnnotationImportJobsFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListAnnotationImportJobsFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListAnnotationImportJobsFilter) # ListAnnotationStoresFilter A filter for annotation stores. ## Contents ** status ** A status to filter on. Type: String Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListAnnotationStoresFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListAnnotationStoresFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListAnnotationStoresFilter) # ListAnnotationStoreVersionsFilter Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store. ## Contents ** status ** The status of an annotation store version. Type: String Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListAnnotationStoreVersionsFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListAnnotationStoreVersionsFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListAnnotationStoreVersionsFilter) # ListVariantImportJobsFilter A filter for variant import jobs. ## Contents ** status ** A status to filter on. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` Required: No ** storeName ** A store name to filter on. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListVariantImportJobsFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListVariantImportJobsFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListVariantImportJobsFilter) # ListVariantStoresFilter A filter for variant stores. ## Contents ** status ** A status to filter on. Type: String Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ListVariantStoresFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ListVariantStoresFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ListVariantStoresFilter) # MultipartReadSetUploadListItem Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads. ## Contents ** creationTime ** The time stamp for when a direct upload was created. Type: Timestamp Required: Yes ** generatedFrom ** The source of an uploaded part. 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 ** The source's reference ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: Yes ** sampleId ** The read set 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 ** sequenceStoreId ** The sequence store ID used for the multipart upload. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** sourceFileType ** The type of file the read set originated from. Type: String Valid Values: `FASTQ | BAM | CRAM | UBAM` Required: Yes ** subjectId ** The read set 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 ** uploadId ** The ID for the initiated multipart upload. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** description ** The description of a 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 ** name ** The name of a 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: No ** tags ** Any tags you wish to add to a 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/MultipartReadSetUploadListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/MultipartReadSetUploadListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/MultipartReadSetUploadListItem) # ReadOptions Read options for an annotation import job. ## Contents ** comment ** The file's comment character. Type: String Length Constraints: Fixed length of 1. Required: No ** encoding ** The file's encoding. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Required: No ** escape ** A character for escaping quotes in the file. Type: String Length Constraints: Fixed length of 1. Required: No ** escapeQuotes ** Whether quotes need to be escaped in the file. Type: Boolean Required: No ** header ** Whether the file has a header row. Type: Boolean Required: No ** lineSep ** A line separator for the file. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Required: No ** quote ** The file's quote character. Type: String Length Constraints: Fixed length of 1. Required: No ** quoteAll ** Whether all values need to be quoted, or just those that contain quotes. Type: Boolean Required: No ** sep ** The file's field separator. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReadOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReadOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReadOptions) # ReadSetBatchError An error from a batch read set operation. ## Contents ** code ** The error's code. Type: String Required: Yes ** id ** The error's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** message ** The error's message. Type: String Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReadSetBatchError) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReadSetBatchError) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReadSetBatchError) # ReadSetFiles Files in a read set. ## Contents ** index ** The files' index. Type: [FileInformation](API_FileInformation.md) object Required: No ** source1 ** The location of the first file in Amazon S3. Type: [FileInformation](API_FileInformation.md) object Required: No ** source2 ** The location of the second file in Amazon S3. Type: [FileInformation](API_FileInformation.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReadSetFiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReadSetFiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReadSetFiles) # ReadSetFilter A filter for read sets. ## Contents ** createdAfter ** The filter's start date. Type: Timestamp Required: No ** createdBefore ** The filter's end date. Type: Timestamp Required: No ** creationType ** The creation type of the read set. Type: String Valid Values: `IMPORT | UPLOAD` Required: No ** generatedFrom ** 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 ** A name to filter on. 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 ** referenceArn ** A genome reference ARN to filter on. Type: String Length Constraints: Minimum length of 0. Maximum length of 127. Pattern: `$|^arn:.+` Required: No ** sampleId ** The read set 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: No ** status ** A status to filter on. Type: String Valid Values: `ARCHIVED | ACTIVATING | ACTIVE | DELETING | DELETED | PROCESSING_UPLOAD | UPLOAD_FAILED` Required: No ** subjectId ** The read set 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: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReadSetFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReadSetFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReadSetFilter) # ReadSetListItem A read set. ## Contents ** arn ** The read set's ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: Yes ** creationTime ** When the read set was created. Type: Timestamp Required: Yes ** fileType ** The read set's file type. Type: String Valid Values: `FASTQ | BAM | CRAM | UBAM` Required: Yes ** id ** The read set's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** sequenceStoreId ** The read set's sequence store ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** status ** The read set's status. Type: String Valid Values: `ARCHIVED | ACTIVATING | ACTIVE | DELETING | DELETED | PROCESSING_UPLOAD | UPLOAD_FAILED` Required: Yes ** creationType ** The creation type of the read set. Type: String Valid Values: `IMPORT | UPLOAD` Required: No ** description ** 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}]+` Required: No ** etag ** The entity tag (ETag) is a hash of the object representing its semantic content. Type: [ETag](API_ETag.md) object Required: No ** name ** 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}]+` Required: No ** referenceArn ** The read set's genome reference ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: No ** sampleId ** 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}]+` Required: No ** sequenceInformation ** Details about a sequence. Type: [SequenceInformation](API_SequenceInformation.md) object Required: No ** statusMessage ** The status 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}]+` Required: No ** subjectId ** 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}]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReadSetListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReadSetListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReadSetListItem) # ReadSetS3Access The S3 URI for each read set file. ## Contents ** s3Uri ** The S3 URI for each read set file. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReadSetS3Access) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReadSetS3Access) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReadSetS3Access) # ReadSetUploadPartListFilter Filter settings that select for read set upload parts of interest. ## Contents ** createdAfter ** Filters for read set uploads after a specified time. Type: Timestamp Required: No ** createdBefore ** Filters for read set part uploads before a specified time. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReadSetUploadPartListFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReadSetUploadPartListFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReadSetUploadPartListFilter) # ReadSetUploadPartListItem The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API. ## Contents ** checksum ** A unique identifier used to confirm that parts are being added to the correct upload. Type: String Required: Yes ** partNumber ** The number identifying the part in an upload. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10000. Required: Yes ** partSize ** The size of the the part in an upload. Type: Long Valid Range: Minimum value of 1. Maximum value of 5368709120. Required: Yes ** partSource ** The origin of the part being direct uploaded. Type: String Valid Values: `SOURCE1 | SOURCE2` Required: Yes ** creationTime ** The time stamp for when a direct upload was created. Type: Timestamp Required: No ** lastUpdatedTime ** The time stamp for the most recent update to an uploaded part. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReadSetUploadPartListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReadSetUploadPartListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReadSetUploadPartListItem) # ReferenceFiles A set of genome reference files. ## Contents ** index ** The files' index. Type: [FileInformation](API_FileInformation.md) object Required: No ** source ** The source file's location in Amazon S3. Type: [FileInformation](API_FileInformation.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReferenceFiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReferenceFiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReferenceFiles) # ReferenceFilter A filter for references. ## Contents ** createdAfter ** The filter's start date. Type: Timestamp Required: No ** createdBefore ** The filter's end date. Type: Timestamp Required: No ** md5 ** An MD5 checksum to filter on. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[\p{L}||\p{N}]+` Required: No ** name ** A name to filter on. 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}]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReferenceFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReferenceFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReferenceFilter) # ReferenceItem A genome reference. ## Contents **Important** This data type is a UNION, so only one of the following members can be specified when used or returned. ** referenceArn ** The reference's ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReferenceItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReferenceItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReferenceItem) # ReferenceListItem A genome reference. ## Contents ** arn ** The reference's ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: Yes ** creationTime ** When the reference was created. Type: Timestamp Required: Yes ** id ** The reference's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** md5 ** The reference's MD5 checksum. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[\p{L}||\p{N}]+` Required: Yes ** referenceStoreId ** The reference's store ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** updateTime ** When the reference was updated. Type: Timestamp Required: Yes ** description ** 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}]+` Required: No ** name ** 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}]+` Required: No ** status ** The reference's status. Type: String Valid Values: `ACTIVE | DELETING | DELETED` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReferenceListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReferenceListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReferenceListItem) # ReferenceStoreDetail Details about a reference store. ## Contents ** arn ** The store's ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: Yes ** creationTime ** When the store was created. Type: Timestamp Required: Yes ** id ** The store's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** description ** 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}]+` Required: No ** name ** 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}]+` Required: No ** sseConfig ** The store's server-side encryption (SSE) settings. Type: [SseConfig](API_SseConfig.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReferenceStoreDetail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReferenceStoreDetail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReferenceStoreDetail) # ReferenceStoreFilter A filter for reference stores. ## Contents ** createdAfter ** The filter's start date. Type: Timestamp Required: No ** createdBefore ** The filter's end date. Type: Timestamp Required: No ** name ** The name to filter on. 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ReferenceStoreFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ReferenceStoreFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ReferenceStoreFilter) # RegistryMapping If you are using the ECR pull through cache feature, the registry mapping maps between the ECR repository and the upstream registry where container images are pulled and synchronized. ## Contents ** ecrAccountId ** Account ID of the account that owns the upstream container image. Type: String Length Constraints: Fixed length of 12. Pattern: `[0-9]+` Required: No ** ecrRepositoryPrefix ** The repository prefix to use in the ECR private repository. 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 ** upstreamRegistryUrl ** The URI of the upstream registry. 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 ** upstreamRepositoryPrefix ** The repository prefix of the corresponding repository in the upstream registry. Type: String Length Constraints: Minimum length of 2. Maximum length of 30. Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RegistryMapping) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RegistryMapping) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RegistryMapping) # RunBatchListItem A single run entry returned by `ListRunsInBatch`. ## Contents ** runArn ** The unique ARN of the workflow run. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:.+` Required: No ** runId ** The HealthOmics-generated identifier for the workflow run. Empty if submission failed. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** runInternalUuid ** The universally unique identifier (UUID) for the 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}]+` Required: No ** runSettingId ** The customer-provided identifier for the run configuration. Use this to correlate results back to the input configuration provided in `inlineSettings` or `s3UriSettings`. 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 ** submissionFailureMessage ** A detailed message describing the submission failure. Type: String Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` Required: No ** submissionFailureReason ** The error category for a failed submission. See the run-level failure table in the HealthOmics User Guide for details on each value. 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 ** submissionStatus ** The submission outcome for this run. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `SUCCESS | FAILED | CANCEL_SUCCESS | CANCEL_FAILED | DELETE_SUCCESS | DELETE_FAILED` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RunBatchListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RunBatchListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RunBatchListItem) # RunCacheListItem List entry for one run cache. ## Contents ** arn ** Unique resource identifier for the run cache. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:.+` Required: No ** cacheBehavior ** Default cache behavior for the run cache. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `CACHE_ON_FAILURE | CACHE_ALWAYS` Required: No ** cacheS3Uri ** The S3 uri for the run cache data. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?` Required: No ** creationTime ** The time that this run cache was created (an ISO 8601 formatted string). Type: Timestamp Required: No ** id ** The identifier for this run cache. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** name ** 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 ** status ** The run cache status. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `ACTIVE | DELETED | FAILED` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RunCacheListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RunCacheListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RunCacheListItem) # RunConfigurations Run-specific configuration settings. ## Contents ** vpcConfig ** VPC configuration for workflow runs. Type: [VpcConfig](API_VpcConfig.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RunConfigurations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RunConfigurations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RunConfigurations) # RunConfigurationsResponse Run-specific configuration settings with computed values. ## Contents ** vpcConfig ** VPC configuration for workflow runs with computed VPC ID. Type: [VpcConfigResponse](API_VpcConfigResponse.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RunConfigurationsResponse) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RunConfigurationsResponse) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RunConfigurationsResponse) # RunGroupListItem A run group. ## Contents ** arn ** The group's ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:.+` Required: No ** creationTime ** When the group was created. Type: Timestamp Required: No ** id ** The group's ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** maxCpus ** The group's maximum CPU count setting. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100000. Required: No ** maxDuration ** The group's maximum duration setting in minutes. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100000. Required: No ** maxGpus ** 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 ** The group's maximum concurrent run setting. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100000. Required: No ** name ** 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}]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RunGroupListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RunGroupListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RunGroupListItem) # RunListItem A workflow run. ## Contents ** arn ** The run's ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:.+` Required: No ** batchId ** The run's batch ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** creationTime ** When the run was created. Type: Timestamp Required: No ** id ** The run's ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** name ** 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}]+` Required: No ** priority ** The run's priority. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100000. Required: No ** startTime ** When the run started. Type: Timestamp Required: No ** status ** 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` Required: No ** stopTime ** When the run stopped. Type: Timestamp Required: No ** storageCapacity ** The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100000. Required: No ** storageType ** The run's storage type. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `STATIC | DYNAMIC` Required: No ** workflowId ** The run's workflow ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** workflowVersionName ** The name of the workflow version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RunListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RunListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RunListItem) # RunLogLocation The URI for the run log. ## Contents ** engineLogStream ** The log stream ARN for the engine log. Type: String Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` Required: No ** runLogStream ** The log stream ARN for the run log. Type: String Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RunLogLocation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RunLogLocation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RunLogLocation) # RunSummary A summary of the runs in a batch. ## Contents ** cancelledRunCount ** The number of cancelled runs. Type: Integer Required: No ** completedRunCount ** The number of completed runs. Type: Integer Required: No ** deletedRunCount ** The number of deleted runs. Type: Integer Required: No ** failedRunCount ** The number of failed runs. Type: Integer Required: No ** pendingRunCount ** The number of pending runs. Type: Integer Required: No ** runningRunCount ** The number of running runs. Type: Integer Required: No ** startingRunCount ** The number of starting runs. Type: Integer Required: No ** stoppingRunCount ** The number of stopping runs. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/RunSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/RunSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/RunSummary) # S3AccessConfig S3 access configuration parameters. ## Contents ** accessLogLocation ** Location of the access logs. Type: String Pattern: `$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,800})/)?` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/S3AccessConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/S3AccessConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/S3AccessConfig) # SequenceInformation Details about a sequence. ## Contents ** alignment ** The sequence's alignment setting. Type: String Required: No ** generatedFrom ** Where the sequence 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 ** totalBaseCount ** The sequence's total base count. Type: Long Required: No ** totalReadCount ** The sequence's total read count. Type: Long Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/SequenceInformation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/SequenceInformation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/SequenceInformation) # SequenceStoreDetail Details about a sequence store. ## Contents ** arn ** The store's ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: Yes ** creationTime ** When the store was created. Type: Timestamp Required: Yes ** id ** The store's ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ** description ** 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}]+` Required: No ** eTagAlgorithmFamily ** The algorithm family of the ETag. Type: String Valid Values: `MD5up | SHA256up | SHA512up` Required: No ** fallbackLocation ** 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})/)?` Required: No ** name ** 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}]+` Required: No ** sseConfig ** The store's server-side encryption (SSE) settings. Type: [SseConfig](API_SseConfig.md) object Required: No ** status ** Status of the sequence store. Type: String Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | FAILED` Required: No ** statusMessage ** 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}]+` Required: No ** updateTime ** The last-updated time of the Sequence Store. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/SequenceStoreDetail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/SequenceStoreDetail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/SequenceStoreDetail) # SequenceStoreFilter A filter for a sequence store. ## Contents ** createdAfter ** The filter's start date. Type: Timestamp Required: No ** createdBefore ** The filter's end date. Type: Timestamp Required: No ** name ** A name to filter on. 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 ** status ** Filter results based on status. Type: String Valid Values: `CREATING | ACTIVE | UPDATING | DELETING | FAILED` Required: No ** updatedAfter ** Filter results based on stores updated after the specified time. Type: Timestamp Required: No ** updatedBefore ** Filter results based on stores updated before the specified time. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/SequenceStoreFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/SequenceStoreFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/SequenceStoreFilter) # SequenceStoreS3Access The S3 access metadata of the sequence store. ## Contents ** accessLogLocation ** Location of the access logs. Type: String Pattern: `$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,800})/)?` Required: No ** s3AccessPointArn ** This is ARN of the access point associated with the S3 bucket storing read sets. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*` Required: No ** s3Uri ** The S3 URI of the sequence store. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/SequenceStoreS3Access) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/SequenceStoreS3Access) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/SequenceStoreS3Access) # ShareDetails The details of a resource share. ## Contents ** creationTime ** The timestamp of when the resource share was created. Type: Timestamp Required: No ** ownerId ** The account ID for the data owner. The owner creates the resource share. Type: String Required: No ** principalSubscriber ** The principal subscriber is the account that is sharing the resource. Type: String Required: No ** resourceArn ** The Arn of the shared resource. Type: String Required: No ** resourceId ** The ID of the shared resource. Type: String Required: No ** shareId ** The ID of the resource share. Type: String Required: No ** shareName ** The name of the resource share. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_-]+` Required: No ** status ** The status of the share. Type: String Valid Values: `PENDING | ACTIVATING | ACTIVE | DELETING | DELETED | FAILED` Required: No ** statusMessage ** The status message for a resource share. It provides additional details about the share status. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** updateTime ** The timestamp of the resource share update. Type: Timestamp Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/ShareDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/ShareDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/ShareDetails) # SourceFiles Source files for a sequence. ## Contents ** source1 ** The location of the first file in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: Yes ** source2 ** The location of the second file in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/SourceFiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/SourceFiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/SourceFiles) # SourceReference Contains information about the source reference in a code repository, such as a branch, tag, or commit. ## Contents ** type ** The type of source reference, such as branch, tag, or commit. Type: String Valid Values: `BRANCH | TAG | COMMIT` Required: Yes ** value ** The value of the source reference, such as the branch name, tag name, or commit ID. Type: String Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/SourceReference) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/SourceReference) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/SourceReference) # SseConfig Server-side encryption (SSE) settings for a store. ## Contents ** type ** The encryption type. Type: String Valid Values: `KMS` Required: Yes ** keyArn ** An encryption key ARN. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/SseConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/SseConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/SseConfig) # StartReadSetActivationJobSourceItem A source for a read set activation job. ## Contents ** readSetId ** The source's read set ID. Type: String Length Constraints: Minimum length of 10. Maximum length of 36. Pattern: `[0-9]+` Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartReadSetActivationJobSourceItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartReadSetActivationJobSourceItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartReadSetActivationJobSourceItem) # StartReadSetImportJobSourceItem A source for a read set import job. ## Contents ** sampleId ** 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 ** sourceFiles ** The source files' location in Amazon S3. Type: [SourceFiles](API_SourceFiles.md) object Required: Yes ** sourceFileType ** The source's file type. Type: String Valid Values: `FASTQ | BAM | CRAM | UBAM` Required: Yes ** subjectId ** 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 ** description ** The source'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}]+` Required: No ** generatedFrom ** 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 ** The source'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}]+` Required: No ** referenceArn ** The source's reference ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 127. Pattern: `arn:.+` Required: No ** tags ** The source'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. Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartReadSetImportJobSourceItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartReadSetImportJobSourceItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartReadSetImportJobSourceItem) # StartReferenceImportJobSourceItem A source for a reference import job. ## Contents ** name ** The source'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}]+` Required: Yes ** sourceFile ** The source file's location in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: Yes ** description ** The source'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}]+` Required: No ** tags ** The source'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. Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StartReferenceImportJobSourceItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StartReferenceImportJobSourceItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StartReferenceImportJobSourceItem) # StoreOptions Settings for a store. ## Contents **Important** This data type is a UNION, so only one of the following members can be specified when used or returned. ** tsvStoreOptions ** File settings for a TSV store. Type: [TsvStoreOptions](API_TsvStoreOptions.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/StoreOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/StoreOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/StoreOptions) # SubmissionSummary A summary of the submissions in a batch. ## Contents ** failedCancelSubmissionCount ** The number of failed cancel submissions. Type: Integer Required: No ** failedDeleteSubmissionCount ** The number of failed delete submissions. Type: Integer Required: No ** failedStartSubmissionCount ** The number of failed start submissions. Type: Integer Required: No ** pendingStartSubmissionCount ** The number of pending start submissions. Type: Integer Required: No ** successfulCancelSubmissionCount ** The number of successful cancel submissions. Type: Integer Required: No ** successfulDeleteSubmissionCount ** The number of successful delete submissions. Type: Integer Required: No ** successfulStartSubmissionCount ** The number of successful start submissions. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/SubmissionSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/SubmissionSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/SubmissionSummary) # TaskListItem A workflow run task. ## Contents ** cacheHit ** Set to true if AWS HealthOmics found a matching entry in the run cache for this task. Type: Boolean Required: No ** cacheS3Uri ** The S3 URI of the cache location. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?` Required: No ** cpus ** The task's CPU count. Type: Integer Valid Range: Minimum value of 1. Required: No ** creationTime ** When the task was created. Type: Timestamp Required: No ** gpus ** The number of Graphics Processing Units (GPU) specified for the task. Type: Integer Valid Range: Minimum value of 0. Required: No ** instanceType ** The instance type for a task. Type: String Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` Required: No ** memory ** The task's memory use in gigabyes. Type: Integer Valid Range: Minimum value of 1. Required: No ** name ** The task's name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ** startTime ** When the task started. Type: Timestamp Required: No ** status ** 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` Required: No ** stopTime ** When the task stopped. Type: Timestamp Required: No ** taskId ** The task's ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/TaskListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/TaskListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/TaskListItem) # TsvOptions Formatting options for a TSV file. ## Contents ** readOptions ** The file's read options. Type: [ReadOptions](API_ReadOptions.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/TsvOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/TsvOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/TsvOptions) # TsvStoreOptions File settings for a TSV store. ## Contents ** annotationType ** The store's annotation type. Type: String Valid Values: `GENERIC | CHR_POS | CHR_POS_REF_ALT | CHR_START_END_ONE_BASE | CHR_START_END_REF_ALT_ONE_BASE | CHR_START_END_ZERO_BASE | CHR_START_END_REF_ALT_ZERO_BASE` Required: No ** formatToHeader ** The store's header key to column name mapping. Type: String to string map Valid Keys: `CHR | START | END | REF | ALT | POS` Value Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** schema ** The store's schema. Type: Array of string to string maps Array Members: Minimum number of 1 item. Maximum number of 5000 items. Map Entries: Maximum number of 1 item. Key Pattern: `[a-z0-9_]{1,255}` Valid Values: `LONG | INT | STRING | FLOAT | DOUBLE | BOOLEAN` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/TsvStoreOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/TsvStoreOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/TsvStoreOptions) # TsvVersionOptions The options for a TSV file. ## Contents ** annotationType ** The store version's annotation type. Type: String Valid Values: `GENERIC | CHR_POS | CHR_POS_REF_ALT | CHR_START_END_ONE_BASE | CHR_START_END_REF_ALT_ONE_BASE | CHR_START_END_ZERO_BASE | CHR_START_END_REF_ALT_ZERO_BASE` Required: No ** formatToHeader ** The annotation store version's header key to column name mapping. Type: String to string map Valid Keys: `CHR | START | END | REF | ALT | POS` Value Length Constraints: Minimum length of 0. Maximum length of 1000. Required: No ** schema ** The TSV schema for an annotation store version. Type: Array of string to string maps Array Members: Minimum number of 1 item. Maximum number of 5000 items. Map Entries: Maximum number of 1 item. Key Pattern: `[a-z0-9_]{1,255}` Valid Values: `LONG | INT | STRING | FLOAT | DOUBLE | BOOLEAN` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/TsvVersionOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/TsvVersionOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/TsvVersionOptions) # VariantImportItemDetail Details about an imported variant item. ## Contents ** jobStatus ** The item's job status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` Required: Yes ** source ** The source file's location in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: Yes ** statusMessage ** A message that provides additional context about a job Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VariantImportItemDetail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VariantImportItemDetail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VariantImportItemDetail) # VariantImportItemSource A imported variant item's source. ## Contents ** source ** The source file's location in Amazon S3. Type: String Pattern: `s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})` Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VariantImportItemSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VariantImportItemSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VariantImportItemSource) # VariantImportJobItem A variant import job. ## Contents ** creationTime ** When the job was created. Type: Timestamp Required: Yes ** destinationName ** The job's destination variant store. Type: String Required: Yes ** id ** The job's ID. Type: String Required: Yes ** roleArn ** The job's service role ARN. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` Required: Yes ** status ** The job's status. Type: String Valid Values: `SUBMITTED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED | COMPLETED_WITH_FAILURES` Required: Yes ** updateTime ** When the job was updated. Type: Timestamp Required: Yes ** annotationFields ** 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 ** completionTime ** When the job completed. Type: Timestamp Required: No ** runLeftNormalization ** The job's left normalization setting. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VariantImportJobItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VariantImportJobItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VariantImportJobItem) # VariantStoreItem A variant store. ## Contents ** creationTime ** When the store was created. Type: Timestamp Required: Yes ** description ** The store's description. Type: String Length Constraints: Minimum length of 0. Maximum length of 500. Required: Yes ** id ** 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}` Required: Yes ** name ** The store's name. Type: String Required: Yes ** reference ** 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. Required: Yes ** sseConfig ** The store's server-side encryption (SSE) settings. Type: [SseConfig](API_SseConfig.md) object Required: Yes ** status ** The store's status. Type: String Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` Required: Yes ** statusMessage ** The store's status message. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Required: Yes ** storeArn ** The store's ARN. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)` Required: Yes ** storeSizeBytes ** The store's size in bytes. Type: Long Required: Yes ** updateTime ** When the store was updated. Type: Timestamp Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VariantStoreItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VariantStoreItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VariantStoreItem) # VcfOptions Formatting options for a VCF file. ## Contents ** ignoreFilterField ** The file's ignore filter field setting. Type: Boolean Required: No ** ignoreQualField ** The file's ignore qual field setting. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VcfOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VcfOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VcfOptions) # VersionDeleteError The error preventing deletion of the annotation store version. ## Contents ** message ** The message explaining the error in annotation store deletion. Type: String Required: Yes ** versionName ** The name given to 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}` Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VersionDeleteError) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VersionDeleteError) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VersionDeleteError) # VersionOptions The options for an annotation store version. ## Contents **Important** This data type is a UNION, so only one of the following members can be specified when used or returned. ** tsvVersionOptions ** File settings for a version of a TSV store. Type: [TsvVersionOptions](API_TsvVersionOptions.md) object Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VersionOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VersionOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VersionOptions) # VpcConfig VPC configuration for workflow runs. ## Contents ** securityGroupIds ** List of security group IDs. Maximum of 5 security groups allowed. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 5 items. Length Constraints: Minimum length of 4. Maximum length of 128. Pattern: `sg-[0-9a-f]+` Required: No ** subnetIds ** List of subnet IDs. Maximum of 16 subnets allowed. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 16 items. Length Constraints: Minimum length of 8. Maximum length of 128. Pattern: `subnet-[0-9a-f]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VpcConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VpcConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VpcConfig) # VpcConfigResponse VPC configuration for workflow runs with computed VPC ID. ## Contents ** securityGroupIds ** List of security group IDs. Type: Array of strings Length Constraints: Minimum length of 4. Maximum length of 128. Pattern: `sg-[0-9a-f]+` Required: No ** subnetIds ** List of subnet IDs. Type: Array of strings Length Constraints: Minimum length of 8. Maximum length of 128. Pattern: `subnet-[0-9a-f]+` Required: No ** vpcId ** VPC ID computed from the provided subnet IDs. Type: String Length Constraints: Minimum length of 5. Maximum length of 128. Pattern: `vpc-[0-9a-f]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/VpcConfigResponse) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/VpcConfigResponse) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/VpcConfigResponse) # WorkflowListItem A workflow. ## Contents ** arn ** The workflow's ARN. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:.+` Required: No ** creationTime ** When the workflow was created. Type: Timestamp Required: No ** digest ** The workflow's digest. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** id ** The workflow's ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ** metadata ** Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return. 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 ** name ** 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}]+` Required: No ** status ** The workflow's status. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `CREATING | ACTIVE | UPDATING | DELETED | FAILED | INACTIVE` Required: No ** type ** The workflow's type. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `PRIVATE | READY2RUN` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/WorkflowListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/WorkflowListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/WorkflowListItem) # WorkflowParameter A workflow parameter. ## Contents ** description ** The parameter's description. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+` Required: No ** optional ** Whether the parameter is optional. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/WorkflowParameter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/WorkflowParameter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/WorkflowParameter) # WorkflowVersionListItem A list of workflow version items. ## Contents ** arn ** ARN of the workflow version. Type: String Length Constraints: Minimum length of 1. Maximum length of 150. Pattern: `arn:.+` Required: No ** creationTime ** The creation time of the workflow version. Type: Timestamp Required: No ** description ** The 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 ** digest ** The digist of the workflow version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** metadata ** 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. Required: No ** status ** The status of the workflow version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `CREATING | ACTIVE | UPDATING | DELETED | FAILED | INACTIVE` Required: No ** type ** The type of the workflow version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Valid Values: `PRIVATE | READY2RUN` Required: No ** versionName ** The name of the workflow version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*` Required: No ** workflowId ** The workflow's ID. Type: String Length Constraints: Minimum length of 1. Maximum length of 18. Pattern: `[0-9]+` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/omics-2022-11-28/WorkflowVersionListItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/omics-2022-11-28/WorkflowVersionListItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/omics-2022-11-28/WorkflowVersionListItem)