Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Activate
Read SetFilter A read set activation job filter.
- Activate
Read SetJob Item A read set activation job.
- Activate
Read SetSource Item A source for a read set activation job.
- Annotation
Import Item Detail Details about an imported annotation item.
- Annotation
Import Item Source A source for an annotation import job.
- Annotation
Import JobItem An annotation import job.
- Annotation
Store Item An annotation store.
- Annotation
Store Version Item Annotation store versions.
- Complete
Read SetUpload Part List Item Part of the response to the CompleteReadSetUpload API, including metadata.
- Container
Registry Map Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.
- Definition
Repository Contains information about a source code repository that hosts the workflow definition files.
- Definition
Repository Details Contains detailed information about the source code repository that hosts the workflow definition files.
- ETag
The entity tag (ETag) is a hash of the object representing its semantic content.
- Export
Read Set A read set.
- Export
Read SetDetail Details about a read set.
- Export
Read SetFilter An read set export job filter.
- Export
Read SetJob Detail Details about a read set export job.
- File
Information Details about a file.
- Filter
Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status.
- Image
Details Information about the container image used for a task.
- Image
Mapping 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.
- Import
Read SetFilter A filter for import read set jobs.
- Import
Read SetJob Item An import read set job.
- Import
Read SetSource Item A source for an import read set job.
- Import
Reference Filter A filter for import references.
- Import
Reference JobItem An import reference job.
- Import
Reference Source Item An genome reference source.
- List
Annotation Import Jobs Filter A filter for annotation import jobs.
- List
Annotation Store Versions Filter Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.
- List
Annotation Stores Filter A filter for annotation stores.
- List
Variant Import Jobs Filter A filter for variant import jobs.
- List
Variant Stores Filter A filter for variant stores.
- Multipart
Read SetUpload List Item Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads.
- Read
Options Read options for an annotation import job.
- Read
SetBatch Error An error from a batch read set operation.
- Read
SetFiles Files in a read set.
- Read
SetFilter A filter for read sets.
- Read
SetList Item A read set.
- Read
SetS3 Access The S3 URI for each read set file.
- Read
SetUpload Part List Filter Filter settings that select for read set upload parts of interest.
- Read
SetUpload Part List Item 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.
- Reference
Files A set of genome reference files.
- Reference
Filter A filter for references.
- Reference
List Item A genome reference.
- Reference
Store Detail Details about a reference store.
- Reference
Store Filter A filter for reference stores.
- Registry
Mapping 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.
- RunCache
List Item List entry for one run cache.
- RunGroup
List Item A run group.
- RunList
Item A workflow run.
- RunLog
Location The URI for the run log.
- S3Access
Config S3 access configuration parameters.
- Sequence
Information Details about a sequence.
- Sequence
Store Detail Details about a sequence store.
- Sequence
Store Filter A filter for a sequence store.
- Sequence
Store S3Access The S3 access metadata of the sequence store.
- Share
Details The details of a resource share.
- Source
Files Source files for a sequence.
- Source
Reference Contains information about the source reference in a code repository, such as a branch, tag, or commit.
- SseConfig
Server-side encryption (SSE) settings for a store.
- Start
Read SetActivation JobSource Item A source for a read set activation job.
- Start
Read SetImport JobSource Item A source for a read set import job.
- Start
Reference Import JobSource Item A source for a reference import job.
- Task
List Item A workflow run task.
- TsvOptions
Formatting options for a TSV file.
- TsvStore
Options File settings for a TSV store.
- TsvVersion
Options The options for a TSV file.
- Variant
Import Item Detail Details about an imported variant item.
- Variant
Import Item Source A imported variant item's source.
- Variant
Import JobItem A variant import job.
- Variant
Store Item A variant store.
- VcfOptions
Formatting options for a VCF file.
- Version
Delete Error The error preventing deletion of the annotation store version.
- Workflow
List Item A workflow.
- Workflow
Parameter A workflow parameter.
- Workflow
Version List Item A list of workflow version items.
Enums§
- Accelerators
- When writing a match expression against
Accelerators
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Annotation
Type - When writing a match expression against
AnnotationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cache
Behavior - When writing a match expression against
CacheBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Creation
Type - When writing a match expression against
CreationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - ETag
Algorithm - When writing a match expression against
ETagAlgorithm
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - ETag
Algorithm Family - When writing a match expression against
ETagAlgorithmFamily
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Encryption
Type - When writing a match expression against
EncryptionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - File
Type - When writing a match expression against
FileType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Format
Options Formatting options for a file.
- Format
ToHeader Key - When writing a match expression against
FormatToHeaderKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - JobStatus
- When writing a match expression against
JobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetActivation JobItem Status - When writing a match expression against
ReadSetActivationJobItemStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetActivation JobStatus - When writing a match expression against
ReadSetActivationJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetExport JobItem Status - When writing a match expression against
ReadSetExportJobItemStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetExport JobStatus - When writing a match expression against
ReadSetExportJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetFile - When writing a match expression against
ReadSetFile
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetImport JobItem Status - When writing a match expression against
ReadSetImportJobItemStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetImport JobStatus - When writing a match expression against
ReadSetImportJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetPart Source - When writing a match expression against
ReadSetPartSource
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Read
SetStatus - When writing a match expression against
ReadSetStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reference
Creation Type - When writing a match expression against
ReferenceCreationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reference
File - When writing a match expression against
ReferenceFile
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reference
Import JobItem Status - When writing a match expression against
ReferenceImportJobItemStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reference
Import JobStatus - When writing a match expression against
ReferenceImportJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reference
Item A genome reference.
- Reference
Status - When writing a match expression against
ReferenceStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Resource
Owner - When writing a match expression against
ResourceOwner
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - RunCache
Status - When writing a match expression against
RunCacheStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - RunExport
- When writing a match expression against
RunExport
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - RunLog
Level - When writing a match expression against
RunLogLevel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - RunRetention
Mode - When writing a match expression against
RunRetentionMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - RunStatus
- When writing a match expression against
RunStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schema
Value Type - When writing a match expression against
SchemaValueType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Sequence
Store Status - When writing a match expression against
SequenceStoreStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Share
Resource Type - When writing a match expression against
ShareResourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Share
Status - When writing a match expression against
ShareStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Source
Reference Type - When writing a match expression against
SourceReferenceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Storage
Type - When writing a match expression against
StorageType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Store
Format - When writing a match expression against
StoreFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Store
Options Settings for a store.
- Store
Status - When writing a match expression against
StoreStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Store
Type - When writing a match expression against
StoreType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Task
Status - When writing a match expression against
TaskStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Version
Options The options for an annotation store version.
- Version
Status - When writing a match expression against
VersionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Workflow
Engine - When writing a match expression against
WorkflowEngine
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Workflow
Export - When writing a match expression against
WorkflowExport
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Workflow
Status - When writing a match expression against
WorkflowStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Workflow
Type - When writing a match expression against
WorkflowType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.