types

package
v1.21.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 23, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Accelerators added in v1.4.0 

type Accelerators string
const (
	AcceleratorsGpu Accelerators = "GPU"
)

Enum values for Accelerators

func (Accelerators) Values added in v1.4.0 

func (Accelerators) Values() []Accelerators

Values returns all known values for Accelerators. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type ActivateReadSetFilter 

type ActivateReadSetFilter struct {

	// The filter's start date.
	CreatedAfter *time.Time

	// The filter's end date.
	CreatedBefore *time.Time

	// The filter's status.
	Status ReadSetActivationJobStatus
	// contains filtered or unexported fields
}

A read set activation job filter.

type ActivateReadSetJobItem 

type ActivateReadSetJobItem struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's status.
	//
	// This member is required.
	Status ReadSetActivationJobStatus

	// When the job completed.
	CompletionTime *time.Time
	// contains filtered or unexported fields
}

A read set activation job.

type ActivateReadSetSourceItem 

type ActivateReadSetSourceItem struct {

	// The source's read set ID.
	//
	// This member is required.
	ReadSetId *string

	// The source's status.
	//
	// This member is required.
	Status ReadSetActivationJobItemStatus

	// The source's status message.
	StatusMessage *string
	// contains filtered or unexported fields
}

A source for a read set activation job.

type AnnotationImportItemDetail 

type AnnotationImportItemDetail struct {

	// The item's job status.
	//
	// This member is required.
	JobStatus JobStatus

	// The source file's location in Amazon S3.
	//
	// This member is required.
	Source *string
	// contains filtered or unexported fields
}

Details about an imported annotation item.

type AnnotationImportItemSource 

type AnnotationImportItemSource struct {

	// The source file's location in Amazon S3.
	//
	// This member is required.
	Source *string
	// contains filtered or unexported fields
}

A source for an annotation import job.

type AnnotationImportJobItem 

type AnnotationImportJobItem struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's destination annotation store.
	//
	// This member is required.
	DestinationName *string

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's status.
	//
	// This member is required.
	Status JobStatus

	// When the job was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The name of the annotation store version.
	//
	// This member is required.
	VersionName *string

	//  The annotation schema generated by the parsed annotation data.
	AnnotationFields map[string]string

	// When the job completed.
	CompletionTime *time.Time

	// The job's left normalization setting.
	RunLeftNormalization bool
	// contains filtered or unexported fields
}

An annotation import job.

type AnnotationStoreItem 

type AnnotationStoreItem struct {

	// The store's creation time.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's description.
	//
	// This member is required.
	Description *string

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's name.
	//
	// This member is required.
	Name *string

	// The store's genome reference.
	//
	// This member is required.
	Reference ReferenceItem

	// The store's server-side encryption (SSE) settings.
	//
	// This member is required.
	SseConfig *SseConfig

	// The store's status.
	//
	// This member is required.
	Status StoreStatus

	// The store's status message.
	//
	// This member is required.
	StatusMessage *string

	// The store's ARN.
	//
	// This member is required.
	StoreArn *string

	// The store's file format.
	//
	// This member is required.
	StoreFormat StoreFormat

	// The store's size in bytes.
	//
	// This member is required.
	StoreSizeBytes *int64

	// When the store was updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

An annotation store.

type AnnotationStoreVersionItem added in v1.8.0 

type AnnotationStoreVersionItem struct {

	//  The time stamp for when an annotation store version was created.
	//
	// This member is required.
	CreationTime *time.Time

	//  The description of an annotation store version.
	//
	// This member is required.
	Description *string

	//  The annotation store version ID.
	//
	// This member is required.
	Id *string

	//  A name given to an annotation store version to distinguish it from others.
	//
	// This member is required.
	Name *string

	//  The status of an annotation store version.
	//
	// This member is required.
	Status VersionStatus

	//  The status of an annotation store version.
	//
	// This member is required.
	StatusMessage *string

	//  The store ID for an annotation store version.
	//
	// This member is required.
	StoreId *string

	//  The time stamp for when an annotation store version was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The Arn for an annotation store version.
	//
	// This member is required.
	VersionArn *string

	//  The name of an annotation store version.
	//
	// This member is required.
	VersionName *string

	//  The size of an annotation store version in Bytes.
	//
	// This member is required.
	VersionSizeBytes *int64
	// contains filtered or unexported fields
}

Annotation store versions.

type AnnotationType 

type AnnotationType string
const (
	// Generic text file. No genomic information
	AnnotationTypeGeneric AnnotationType = "GENERIC"
	// Contains contig and 1-base position
	AnnotationTypeChrPos AnnotationType = "CHR_POS"
	// Contains contig, 1-base position, ref and alt allele information
	AnnotationTypeChrPosRefAlt AnnotationType = "CHR_POS_REF_ALT"
	// Contains contig, start, and end positions. Coordinates are 1-based
	AnnotationTypeChrStartEndOneBase AnnotationType = "CHR_START_END_ONE_BASE"
	// Contains contig, start, end, ref and alt allele information. Coordinates are
	// 1-based
	AnnotationTypeChrStartEndRefAltOneBase AnnotationType = "CHR_START_END_REF_ALT_ONE_BASE"
	// Contains contig, start, and end positions. Coordinates are 0-based
	AnnotationTypeChrStartEndZeroBase AnnotationType = "CHR_START_END_ZERO_BASE"
	// Contains contig, start, end, ref and alt allele information. Coordinates are
	// 0-based
	AnnotationTypeChrStartEndRefAltZeroBase AnnotationType = "CHR_START_END_REF_ALT_ZERO_BASE"
)

Enum values for AnnotationType

func (AnnotationType) Values 

func (AnnotationType) Values() []AnnotationType

Values returns all known values for AnnotationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CompleteReadSetUploadPartListItem added in v1.4.0 

type CompleteReadSetUploadPartListItem struct {

	//  A unique identifier used to confirm that parts are being added to the correct
	// upload.
	//
	// This member is required.
	Checksum *string

	//  A number identifying the part in a read set upload.
	//
	// This member is required.
	PartNumber *int32

	//  The source file of the part being uploaded.
	//
	// This member is required.
	PartSource ReadSetPartSource
	// contains filtered or unexported fields
}

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

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type CreationType added in v1.6.0 

type CreationType string
const (
	CreationTypeImport CreationType = "IMPORT"
	CreationTypeUpload CreationType = "UPLOAD"
)

Enum values for CreationType

func (CreationType) Values added in v1.6.0 

func (CreationType) Values() []CreationType

Values returns all known values for CreationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ETag added in v1.10.0 

type ETag struct {

	// The algorithm used to calculate the read set’s ETag(s).
	Algorithm ETagAlgorithm

	// The ETag hash calculated on Source1 of the read set.
	Source1 *string

	// The ETag hash calculated on Source2 of the read set.
	Source2 *string
	// contains filtered or unexported fields
}

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

type ETagAlgorithm added in v1.10.0 

type ETagAlgorithm string
const (
	ETagAlgorithmFastqMd5up    ETagAlgorithm = "FASTQ_MD5up"
	ETagAlgorithmBamMd5up      ETagAlgorithm = "BAM_MD5up"
	ETagAlgorithmCramMd5up     ETagAlgorithm = "CRAM_MD5up"
	ETagAlgorithmFastqSha256up ETagAlgorithm = "FASTQ_SHA256up"
	ETagAlgorithmBamSha256up   ETagAlgorithm = "BAM_SHA256up"
	ETagAlgorithmCramSha256up  ETagAlgorithm = "CRAM_SHA256up"
	ETagAlgorithmFastqSha512up ETagAlgorithm = "FASTQ_SHA512up"
	ETagAlgorithmBamSha512up   ETagAlgorithm = "BAM_SHA512up"
	ETagAlgorithmCramSha512up  ETagAlgorithm = "CRAM_SHA512up"
)

Enum values for ETagAlgorithm

func (ETagAlgorithm) Values added in v1.10.0 

func (ETagAlgorithm) Values() []ETagAlgorithm

Values returns all known values for ETagAlgorithm. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ETagAlgorithmFamily added in v1.20.0 

type ETagAlgorithmFamily string
const (
	ETagAlgorithmFamilyMd5up    ETagAlgorithmFamily = "MD5up"
	ETagAlgorithmFamilySha256up ETagAlgorithmFamily = "SHA256up"
	ETagAlgorithmFamilySha512up ETagAlgorithmFamily = "SHA512up"
)

Enum values for ETagAlgorithmFamily

func (ETagAlgorithmFamily) Values added in v1.20.0 

func (ETagAlgorithmFamily) Values() []ETagAlgorithmFamily

Values returns all known values for ETagAlgorithmFamily. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EncryptionType 

type EncryptionType string
const (
	// KMS
	EncryptionTypeKms EncryptionType = "KMS"
)

Enum values for EncryptionType

func (EncryptionType) Values 

func (EncryptionType) Values() []EncryptionType

Values returns all known values for EncryptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExportReadSet 

type ExportReadSet struct {

	// The set's ID.
	//
	// This member is required.
	ReadSetId *string
	// contains filtered or unexported fields
}

A read set.

type ExportReadSetDetail 

type ExportReadSetDetail struct {

	// The set's ID.
	//
	// This member is required.
	Id *string

	// The set's status.
	//
	// This member is required.
	Status ReadSetExportJobItemStatus

	// The set's status message.
	StatusMessage *string
	// contains filtered or unexported fields
}

Details about a read set.

type ExportReadSetFilter 

type ExportReadSetFilter struct {

	// The filter's start date.
	CreatedAfter *time.Time

	// The filter's end date.
	CreatedBefore *time.Time

	// A status to filter on.
	Status ReadSetExportJobStatus
	// contains filtered or unexported fields
}

An read set export job filter.

type ExportReadSetJobDetail 

type ExportReadSetJobDetail struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's destination in Amazon S3.
	//
	// This member is required.
	Destination *string

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's status.
	//
	// This member is required.
	Status ReadSetExportJobStatus

	// When the job completed.
	CompletionTime *time.Time
	// contains filtered or unexported fields
}

Details about a read set export job.

type FileInformation 

type FileInformation struct {

	// The file's content length.
	ContentLength *int64

	// The file's part size.
	PartSize *int64

	// The S3 URI metadata of a sequence store.
	S3Access *ReadSetS3Access

	// The file's total parts.
	TotalParts *int32
	// contains filtered or unexported fields
}

Details about a file.

type FileType 

type FileType string
const (
	FileTypeFastq FileType = "FASTQ"
	FileTypeBam   FileType = "BAM"
	FileTypeCram  FileType = "CRAM"
	FileTypeUbam  FileType = "UBAM"
)

Enum values for FileType

func (FileType) Values 

func (FileType) Values() []FileType

Values returns all known values for FileType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Filter added in v1.8.0 

type Filter struct {

	// Filter based on the Amazon Resource Number (ARN) of the resource. You can
	// specify up to 10 values.
	ResourceArns []string

	// Filter based on the resource status. You can specify up to 10 values.
	Status []ShareStatus

	// The type of resources to be filtered. You can specify one or more of the
	// resource types.
	Type []ShareResourceType
	// contains filtered or unexported fields
}

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

type FormatOptions 

type FormatOptions interface {
	// contains filtered or unexported methods
}

Formatting options for a file.

The following types satisfy this interface: 

FormatOptionsMemberTsvOptions
FormatOptionsMemberVcfOptions
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/omics/types"
)

func main() {
	var union types.FormatOptions
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FormatOptionsMemberTsvOptions:
		_ = v.Value // Value is types.TsvOptions

	case *types.FormatOptionsMemberVcfOptions:
		_ = v.Value // Value is types.VcfOptions

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type FormatOptionsMemberTsvOptions 

type FormatOptionsMemberTsvOptions struct {
	Value TsvOptions
	// contains filtered or unexported fields
}

Options for a TSV file.

type FormatOptionsMemberVcfOptions 

type FormatOptionsMemberVcfOptions struct {
	Value VcfOptions
	// contains filtered or unexported fields
}

Options for a VCF file.

type FormatToHeaderKey 

type FormatToHeaderKey string
const (
	FormatToHeaderKeyChr   FormatToHeaderKey = "CHR"
	FormatToHeaderKeyStart FormatToHeaderKey = "START"
	FormatToHeaderKeyEnd   FormatToHeaderKey = "END"
	FormatToHeaderKeyRef   FormatToHeaderKey = "REF"
	FormatToHeaderKeyAlt   FormatToHeaderKey = "ALT"
	FormatToHeaderKeyPos   FormatToHeaderKey = "POS"
)

Enum values for FormatToHeaderKey

func (FormatToHeaderKey) Values 

func (FormatToHeaderKey) Values() []FormatToHeaderKey

Values returns all known values for FormatToHeaderKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ImportReadSetFilter 

type ImportReadSetFilter struct {

	// The filter's start date.
	CreatedAfter *time.Time

	// The filter's end date.
	CreatedBefore *time.Time

	// A status to filter on.
	Status ReadSetImportJobStatus
	// contains filtered or unexported fields
}

A filter for import read set jobs.

type ImportReadSetJobItem 

type ImportReadSetJobItem struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The job's status.
	//
	// This member is required.
	Status ReadSetImportJobStatus

	// When the job completed.
	CompletionTime *time.Time
	// contains filtered or unexported fields
}

An import read set job.

type ImportReadSetSourceItem 

type ImportReadSetSourceItem struct {

	// The source's sample ID.
	//
	// This member is required.
	SampleId *string

	// The source's file type.
	//
	// This member is required.
	SourceFileType FileType

	// The source files' location in Amazon S3.
	//
	// This member is required.
	SourceFiles *SourceFiles

	// The source's status.
	//
	// This member is required.
	Status ReadSetImportJobItemStatus

	// The source's subject ID.
	//
	// This member is required.
	SubjectId *string

	// The source's description.
	Description *string

	// Where the source originated.
	GeneratedFrom *string

	// The source's name.
	Name *string

	// The source's genome reference ARN.
	ReferenceArn *string

	// The source's status message.
	StatusMessage *string

	// The source's tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

A source for an import read set job.

type ImportReferenceFilter 

type ImportReferenceFilter struct {

	// The filter's start date.
	CreatedAfter *time.Time

	// The filter's end date.
	CreatedBefore *time.Time

	// A status to filter on.
	Status ReferenceImportJobStatus
	// contains filtered or unexported fields
}

A filter for import references.

type ImportReferenceJobItem 

type ImportReferenceJobItem struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's reference store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's status.
	//
	// This member is required.
	Status ReferenceImportJobStatus

	// When the job completed.
	CompletionTime *time.Time
	// contains filtered or unexported fields
}

An import reference job.

type ImportReferenceSourceItem 

type ImportReferenceSourceItem struct {

	// The source's status.
	//
	// This member is required.
	Status ReferenceImportJobItemStatus

	// The source's description.
	Description *string

	// The source's name.
	Name *string

	// The source file's location in Amazon S3.
	SourceFile *string

	// The source's status message.
	StatusMessage *string

	// The source's tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

An genome reference source.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An unexpected error occurred. Try the request again.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type JobStatus 

type JobStatus string
const (
	// The Job has been submitted to run
	JobStatusSubmitted JobStatus = "SUBMITTED"
	// The Job is executing
	JobStatusInProgress JobStatus = "IN_PROGRESS"
	// The Job was cancelled
	JobStatusCancelled JobStatus = "CANCELLED"
	// The Job has completed
	JobStatusCompleted JobStatus = "COMPLETED"
	// The Job failed
	JobStatusFailed JobStatus = "FAILED"
	// The Job completed with failed runs
	JobStatusCompletedWithFailures JobStatus = "COMPLETED_WITH_FAILURES"
)

Enum values for JobStatus

func (JobStatus) Values 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ListAnnotationImportJobsFilter 

type ListAnnotationImportJobsFilter struct {

	// A status to filter on.
	Status JobStatus

	// A store name to filter on.
	StoreName *string
	// contains filtered or unexported fields
}

A filter for annotation import jobs.

type ListAnnotationStoreVersionsFilter added in v1.8.0 

type ListAnnotationStoreVersionsFilter struct {

	// The status of an annotation store version.
	Status VersionStatus
	// contains filtered or unexported fields
}

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

type ListAnnotationStoresFilter 

type ListAnnotationStoresFilter struct {

	// A status to filter on.
	Status StoreStatus
	// contains filtered or unexported fields
}

A filter for annotation stores.

type ListVariantImportJobsFilter 

type ListVariantImportJobsFilter struct {

	// A status to filter on.
	Status JobStatus

	// A store name to filter on.
	StoreName *string
	// contains filtered or unexported fields
}

A filter for variant import jobs.

type ListVariantStoresFilter 

type ListVariantStoresFilter struct {

	// A status to filter on.
	Status StoreStatus
	// contains filtered or unexported fields
}

A filter for variant stores.

type MultipartReadSetUploadListItem added in v1.4.0 

type MultipartReadSetUploadListItem struct {

	//  The time stamp for when a direct upload was created.
	//
	// This member is required.
	CreationTime *time.Time

	//  The source of an uploaded part.
	//
	// This member is required.
	GeneratedFrom *string

	//  The source's reference ARN.
	//
	// This member is required.
	ReferenceArn *string

	//  The read set source's sample ID.
	//
	// This member is required.
	SampleId *string

	//  The sequence store ID used for the multipart upload.
	//
	// This member is required.
	SequenceStoreId *string

	//  The type of file the read set originated from.
	//
	// This member is required.
	SourceFileType FileType

	//  The read set source's subject ID.
	//
	// This member is required.
	SubjectId *string

	//  The ID for the initiated multipart upload.
	//
	// This member is required.
	UploadId *string

	//  The description of a read set.
	Description *string

	//  The name of a read set.
	Name *string

	//  Any tags you wish to add to a read set.
	Tags map[string]string
	// contains filtered or unexported fields
}
Part of the response to ListMultipartReadSetUploads, excluding completed and

aborted multipart uploads.

type NotSupportedOperationException added in v1.4.0 

type NotSupportedOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*NotSupportedOperationException) Error added in v1.4.0 

func (e *NotSupportedOperationException) Error() string

func (*NotSupportedOperationException) ErrorCode added in v1.4.0 

func (e *NotSupportedOperationException) ErrorCode() string

func (*NotSupportedOperationException) ErrorFault added in v1.4.0 

func (e *NotSupportedOperationException) ErrorFault() smithy.ErrorFault

func (*NotSupportedOperationException) ErrorMessage added in v1.4.0 

func (e *NotSupportedOperationException) ErrorMessage() string

type RangeNotSatisfiableException 

type RangeNotSatisfiableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The ranges specified in the request are not valid.

func (*RangeNotSatisfiableException) Error 

func (e *RangeNotSatisfiableException) Error() string

func (*RangeNotSatisfiableException) ErrorCode 

func (e *RangeNotSatisfiableException) ErrorCode() string

func (*RangeNotSatisfiableException) ErrorFault 

func (e *RangeNotSatisfiableException) ErrorFault() smithy.ErrorFault

func (*RangeNotSatisfiableException) ErrorMessage 

func (e *RangeNotSatisfiableException) ErrorMessage() string

type ReadOptions 

type ReadOptions struct {

	// The file's comment character.
	Comment *string

	// The file's encoding.
	Encoding *string

	// A character for escaping quotes in the file.
	Escape *string

	// Whether quotes need to be escaped in the file.
	EscapeQuotes bool

	// Whether the file has a header row.
	Header bool

	// A line separator for the file.
	LineSep *string

	// The file's quote character.
	Quote *string

	// Whether all values need to be quoted, or just those that contain quotes.
	QuoteAll bool

	// The file's field separator.
	Sep *string
	// contains filtered or unexported fields
}

Read options for an annotation import job.

type ReadSetActivationJobItemStatus 

type ReadSetActivationJobItemStatus string
const (
	ReadSetActivationJobItemStatusNotStarted ReadSetActivationJobItemStatus = "NOT_STARTED"
	ReadSetActivationJobItemStatusInProgress ReadSetActivationJobItemStatus = "IN_PROGRESS"
	ReadSetActivationJobItemStatusFinished   ReadSetActivationJobItemStatus = "FINISHED"
	ReadSetActivationJobItemStatusFailed     ReadSetActivationJobItemStatus = "FAILED"
)

Enum values for ReadSetActivationJobItemStatus

func (ReadSetActivationJobItemStatus) Values 

func (ReadSetActivationJobItemStatus) Values() []ReadSetActivationJobItemStatus

Values returns all known values for ReadSetActivationJobItemStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetActivationJobStatus 

type ReadSetActivationJobStatus string
const (
	ReadSetActivationJobStatusSubmitted             ReadSetActivationJobStatus = "SUBMITTED"
	ReadSetActivationJobStatusInProgress            ReadSetActivationJobStatus = "IN_PROGRESS"
	ReadSetActivationJobStatusCancelling            ReadSetActivationJobStatus = "CANCELLING"
	ReadSetActivationJobStatusCancelled             ReadSetActivationJobStatus = "CANCELLED"
	ReadSetActivationJobStatusFailed                ReadSetActivationJobStatus = "FAILED"
	ReadSetActivationJobStatusCompleted             ReadSetActivationJobStatus = "COMPLETED"
	ReadSetActivationJobStatusCompletedWithFailures ReadSetActivationJobStatus = "COMPLETED_WITH_FAILURES"
)

Enum values for ReadSetActivationJobStatus

func (ReadSetActivationJobStatus) Values 

func (ReadSetActivationJobStatus) Values() []ReadSetActivationJobStatus

Values returns all known values for ReadSetActivationJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetBatchError 

type ReadSetBatchError struct {

	// The error's code.
	//
	// This member is required.
	Code *string

	// The error's ID.
	//
	// This member is required.
	Id *string

	// The error's message.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

An error from a batch read set operation.

type ReadSetExportJobItemStatus 

type ReadSetExportJobItemStatus string
const (
	ReadSetExportJobItemStatusNotStarted ReadSetExportJobItemStatus = "NOT_STARTED"
	ReadSetExportJobItemStatusInProgress ReadSetExportJobItemStatus = "IN_PROGRESS"
	ReadSetExportJobItemStatusFinished   ReadSetExportJobItemStatus = "FINISHED"
	ReadSetExportJobItemStatusFailed     ReadSetExportJobItemStatus = "FAILED"
)

Enum values for ReadSetExportJobItemStatus

func (ReadSetExportJobItemStatus) Values 

func (ReadSetExportJobItemStatus) Values() []ReadSetExportJobItemStatus

Values returns all known values for ReadSetExportJobItemStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetExportJobStatus 

type ReadSetExportJobStatus string
const (
	ReadSetExportJobStatusSubmitted             ReadSetExportJobStatus = "SUBMITTED"
	ReadSetExportJobStatusInProgress            ReadSetExportJobStatus = "IN_PROGRESS"
	ReadSetExportJobStatusCancelling            ReadSetExportJobStatus = "CANCELLING"
	ReadSetExportJobStatusCancelled             ReadSetExportJobStatus = "CANCELLED"
	ReadSetExportJobStatusFailed                ReadSetExportJobStatus = "FAILED"
	ReadSetExportJobStatusCompleted             ReadSetExportJobStatus = "COMPLETED"
	ReadSetExportJobStatusCompletedWithFailures ReadSetExportJobStatus = "COMPLETED_WITH_FAILURES"
)

Enum values for ReadSetExportJobStatus

func (ReadSetExportJobStatus) Values 

func (ReadSetExportJobStatus) Values() []ReadSetExportJobStatus

Values returns all known values for ReadSetExportJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetFile 

type ReadSetFile string
const (
	ReadSetFileSource1 ReadSetFile = "SOURCE1"
	ReadSetFileSource2 ReadSetFile = "SOURCE2"
	ReadSetFileIndex   ReadSetFile = "INDEX"
)

Enum values for ReadSetFile

func (ReadSetFile) Values 

func (ReadSetFile) Values() []ReadSetFile

Values returns all known values for ReadSetFile. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetFiles 

type ReadSetFiles struct {

	// The files' index.
	Index *FileInformation

	// The location of the first file in Amazon S3.
	Source1 *FileInformation

	// The location of the second file in Amazon S3.
	Source2 *FileInformation
	// contains filtered or unexported fields
}

Files in a read set.

type ReadSetFilter 

type ReadSetFilter struct {

	// The filter's start date.
	CreatedAfter *time.Time

	// The filter's end date.
	CreatedBefore *time.Time

	//  The creation type of the read set.
	CreationType CreationType

	//  Where the source originated.
	GeneratedFrom *string

	// A name to filter on.
	Name *string

	// A genome reference ARN to filter on.
	ReferenceArn *string

	//  The read set source's sample ID.
	SampleId *string

	// A status to filter on.
	Status ReadSetStatus

	//  The read set source's subject ID.
	SubjectId *string
	// contains filtered or unexported fields
}

A filter for read sets.

type ReadSetImportJobItemStatus 

type ReadSetImportJobItemStatus string
const (
	ReadSetImportJobItemStatusNotStarted ReadSetImportJobItemStatus = "NOT_STARTED"
	ReadSetImportJobItemStatusInProgress ReadSetImportJobItemStatus = "IN_PROGRESS"
	ReadSetImportJobItemStatusFinished   ReadSetImportJobItemStatus = "FINISHED"
	ReadSetImportJobItemStatusFailed     ReadSetImportJobItemStatus = "FAILED"
)

Enum values for ReadSetImportJobItemStatus

func (ReadSetImportJobItemStatus) Values 

func (ReadSetImportJobItemStatus) Values() []ReadSetImportJobItemStatus

Values returns all known values for ReadSetImportJobItemStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetImportJobStatus 

type ReadSetImportJobStatus string
const (
	ReadSetImportJobStatusSubmitted             ReadSetImportJobStatus = "SUBMITTED"
	ReadSetImportJobStatusInProgress            ReadSetImportJobStatus = "IN_PROGRESS"
	ReadSetImportJobStatusCancelling            ReadSetImportJobStatus = "CANCELLING"
	ReadSetImportJobStatusCancelled             ReadSetImportJobStatus = "CANCELLED"
	ReadSetImportJobStatusFailed                ReadSetImportJobStatus = "FAILED"
	ReadSetImportJobStatusCompleted             ReadSetImportJobStatus = "COMPLETED"
	ReadSetImportJobStatusCompletedWithFailures ReadSetImportJobStatus = "COMPLETED_WITH_FAILURES"
)

Enum values for ReadSetImportJobStatus

func (ReadSetImportJobStatus) Values 

func (ReadSetImportJobStatus) Values() []ReadSetImportJobStatus

Values returns all known values for ReadSetImportJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetListItem 

type ReadSetListItem struct {

	// The read set's ARN.
	//
	// This member is required.
	Arn *string

	// When the read set was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The read set's file type.
	//
	// This member is required.
	FileType FileType

	// The read set's ID.
	//
	// This member is required.
	Id *string

	// The read set's sequence store ID.
	//
	// This member is required.
	SequenceStoreId *string

	// The read set's status.
	//
	// This member is required.
	Status ReadSetStatus

	//  The creation type of the read set.
	CreationType CreationType

	// The read set's description.
	Description *string

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

	// The read set's name.
	Name *string

	// The read set's genome reference ARN.
	ReferenceArn *string

	// The read set's sample ID.
	SampleId *string

	// Details about a sequence.
	SequenceInformation *SequenceInformation

	//  The status for a read set. It provides more detail as to why the read set has
	// a status.
	StatusMessage *string

	// The read set's subject ID.
	SubjectId *string
	// contains filtered or unexported fields
}

A read set.

type ReadSetPartSource added in v1.4.0 

type ReadSetPartSource string
const (
	ReadSetPartSourceSource1 ReadSetPartSource = "SOURCE1"
	ReadSetPartSourceSource2 ReadSetPartSource = "SOURCE2"
)

Enum values for ReadSetPartSource

func (ReadSetPartSource) Values added in v1.4.0 

func (ReadSetPartSource) Values() []ReadSetPartSource

Values returns all known values for ReadSetPartSource. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetS3Access added in v1.20.0 

type ReadSetS3Access struct {

	// The S3 URI for each read set file.
	S3Uri *string
	// contains filtered or unexported fields
}

The S3 URI for each read set file.

type ReadSetStatus 

type ReadSetStatus string
const (
	ReadSetStatusArchived         ReadSetStatus = "ARCHIVED"
	ReadSetStatusActivating       ReadSetStatus = "ACTIVATING"
	ReadSetStatusActive           ReadSetStatus = "ACTIVE"
	ReadSetStatusDeleting         ReadSetStatus = "DELETING"
	ReadSetStatusDeleted          ReadSetStatus = "DELETED"
	ReadSetStatusProcessingUpload ReadSetStatus = "PROCESSING_UPLOAD"
	ReadSetStatusUploadFailed     ReadSetStatus = "UPLOAD_FAILED"
)

Enum values for ReadSetStatus

func (ReadSetStatus) Values 

func (ReadSetStatus) Values() []ReadSetStatus

Values returns all known values for ReadSetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReadSetUploadPartListFilter added in v1.4.0 

type ReadSetUploadPartListFilter struct {

	//  Filters for read set uploads after a specified time.
	CreatedAfter *time.Time

	//  Filters for read set part uploads before a specified time.
	CreatedBefore *time.Time
	// contains filtered or unexported fields
}

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

type ReadSetUploadPartListItem added in v1.4.0 

type ReadSetUploadPartListItem struct {

	//  A unique identifier used to confirm that parts are being added to the correct
	// upload.
	//
	// This member is required.
	Checksum *string

	//  The number identifying the part in an upload.
	//
	// This member is required.
	PartNumber *int32

	//  The size of the the part in an upload.
	//
	// This member is required.
	PartSize *int64

	//  The origin of the part being direct uploaded.
	//
	// This member is required.
	PartSource ReadSetPartSource

	//  The time stamp for when a direct upload was created.
	CreationTime *time.Time

	//  The time stamp for the most recent update to an uploaded part.
	LastUpdatedTime *time.Time
	// contains filtered or unexported fields
}
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.

type ReferenceFile 

type ReferenceFile string
const (
	ReferenceFileSource ReferenceFile = "SOURCE"
	ReferenceFileIndex  ReferenceFile = "INDEX"
)

Enum values for ReferenceFile

func (ReferenceFile) Values 

func (ReferenceFile) Values() []ReferenceFile

Values returns all known values for ReferenceFile. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceFiles 

type ReferenceFiles struct {

	// The files' index.
	Index *FileInformation

	// The source file's location in Amazon S3.
	Source *FileInformation
	// contains filtered or unexported fields
}

A set of genome reference files.

type ReferenceFilter 

type ReferenceFilter struct {

	// The filter's start date.
	CreatedAfter *time.Time

	// The filter's end date.
	CreatedBefore *time.Time

	// An MD5 checksum to filter on.
	Md5 *string

	// A name to filter on.
	Name *string
	// contains filtered or unexported fields
}

A filter for references.

type ReferenceImportJobItemStatus 

type ReferenceImportJobItemStatus string
const (
	ReferenceImportJobItemStatusNotStarted ReferenceImportJobItemStatus = "NOT_STARTED"
	ReferenceImportJobItemStatusInProgress ReferenceImportJobItemStatus = "IN_PROGRESS"
	ReferenceImportJobItemStatusFinished   ReferenceImportJobItemStatus = "FINISHED"
	ReferenceImportJobItemStatusFailed     ReferenceImportJobItemStatus = "FAILED"
)

Enum values for ReferenceImportJobItemStatus

func (ReferenceImportJobItemStatus) Values 

func (ReferenceImportJobItemStatus) Values() []ReferenceImportJobItemStatus

Values returns all known values for ReferenceImportJobItemStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceImportJobStatus 

type ReferenceImportJobStatus string
const (
	ReferenceImportJobStatusSubmitted             ReferenceImportJobStatus = "SUBMITTED"
	ReferenceImportJobStatusInProgress            ReferenceImportJobStatus = "IN_PROGRESS"
	ReferenceImportJobStatusCancelling            ReferenceImportJobStatus = "CANCELLING"
	ReferenceImportJobStatusCancelled             ReferenceImportJobStatus = "CANCELLED"
	ReferenceImportJobStatusFailed                ReferenceImportJobStatus = "FAILED"
	ReferenceImportJobStatusCompleted             ReferenceImportJobStatus = "COMPLETED"
	ReferenceImportJobStatusCompletedWithFailures ReferenceImportJobStatus = "COMPLETED_WITH_FAILURES"
)

Enum values for ReferenceImportJobStatus

func (ReferenceImportJobStatus) Values 

func (ReferenceImportJobStatus) Values() []ReferenceImportJobStatus

Values returns all known values for ReferenceImportJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceItem 

type ReferenceItem interface {
	// contains filtered or unexported methods
}

A genome reference.

The following types satisfy this interface: 

ReferenceItemMemberReferenceArn
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/omics/types"
)

func main() {
	var union types.ReferenceItem
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ReferenceItemMemberReferenceArn:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ReferenceItemMemberReferenceArn 

type ReferenceItemMemberReferenceArn struct {
	Value string
	// contains filtered or unexported fields
}

The reference's ARN.

type ReferenceListItem 

type ReferenceListItem struct {

	// The reference's ARN.
	//
	// This member is required.
	Arn *string

	// When the reference was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The reference's ID.
	//
	// This member is required.
	Id *string

	// The reference's MD5 checksum.
	//
	// This member is required.
	Md5 *string

	// The reference's store ID.
	//
	// This member is required.
	ReferenceStoreId *string

	// When the reference was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The reference's description.
	Description *string

	// The reference's name.
	Name *string

	// The reference's status.
	Status ReferenceStatus
	// contains filtered or unexported fields
}

A genome reference.

type ReferenceStatus 

type ReferenceStatus string
const (
	ReferenceStatusActive   ReferenceStatus = "ACTIVE"
	ReferenceStatusDeleting ReferenceStatus = "DELETING"
	ReferenceStatusDeleted  ReferenceStatus = "DELETED"
)

Enum values for ReferenceStatus

func (ReferenceStatus) Values 

func (ReferenceStatus) Values() []ReferenceStatus

Values returns all known values for ReferenceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceStoreDetail 

type ReferenceStoreDetail struct {

	// The store's ARN.
	//
	// This member is required.
	Arn *string

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's description.
	Description *string

	// The store's name.
	Name *string

	// The store's server-side encryption (SSE) settings.
	SseConfig *SseConfig
	// contains filtered or unexported fields
}

Details about a reference store.

type ReferenceStoreFilter 

type ReferenceStoreFilter struct {

	// The filter's start date.
	CreatedAfter *time.Time

	// The filter's end date.
	CreatedBefore *time.Time

	// The name to filter on.
	Name *string
	// contains filtered or unexported fields
}

A filter for reference stores.

type RequestTimeoutException 

type RequestTimeoutException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request timed out.

func (*RequestTimeoutException) Error 

func (e *RequestTimeoutException) Error() string

func (*RequestTimeoutException) ErrorCode 

func (e *RequestTimeoutException) ErrorCode() string

func (*RequestTimeoutException) ErrorFault 

func (e *RequestTimeoutException) ErrorFault() smithy.ErrorFault

func (*RequestTimeoutException) ErrorMessage 

func (e *RequestTimeoutException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The target resource was not found in the current Region.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceOwner added in v1.8.0 

type ResourceOwner string
const (
	// The resource owner is the calling account
	ResourceOwnerSelf ResourceOwner = "SELF"
	// The resource owner is an account other than the caller
	ResourceOwnerOther ResourceOwner = "OTHER"
)

Enum values for ResourceOwner

func (ResourceOwner) Values added in v1.8.0 

func (ResourceOwner) Values() []ResourceOwner

Values returns all known values for ResourceOwner. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RunExport 

type RunExport string
const (
	RunExportDefinition RunExport = "DEFINITION"
)

Enum values for RunExport

func (RunExport) Values 

func (RunExport) Values() []RunExport

Values returns all known values for RunExport. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RunGroupListItem 

type RunGroupListItem struct {

	// The group's ARN.
	Arn *string

	// When the group was created.
	CreationTime *time.Time

	// The group's ID.
	Id *string

	// The group's maximum CPU count setting.
	MaxCpus *int32

	// The group's maximum duration setting in minutes.
	MaxDuration *int32

	//  The maximum GPUs that can be used by a run group.
	MaxGpus *int32

	// The group's maximum concurrent run setting.
	MaxRuns *int32

	// The group's name.
	Name *string
	// contains filtered or unexported fields
}

A run group.

type RunListItem 

type RunListItem struct {

	// The run's ARN.
	Arn *string

	// When the run was created.
	CreationTime *time.Time

	// The run's ID.
	Id *string

	// The run's name.
	Name *string

	// The run's priority.
	Priority *int32

	// When the run started.
	StartTime *time.Time

	// The run's status.
	Status RunStatus

	// When the run stopped.
	StopTime *time.Time

	// 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.
	StorageCapacity *int32

	// The run's storage type.
	StorageType StorageType

	// The run's workflow ID.
	WorkflowId *string
	// contains filtered or unexported fields
}

A workflow run.

type RunLogLevel 

type RunLogLevel string
const (
	RunLogLevelOff   RunLogLevel = "OFF"
	RunLogLevelFatal RunLogLevel = "FATAL"
	RunLogLevelError RunLogLevel = "ERROR"
	RunLogLevelAll   RunLogLevel = "ALL"
)

Enum values for RunLogLevel

func (RunLogLevel) Values 

func (RunLogLevel) Values() []RunLogLevel

Values returns all known values for RunLogLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RunLogLocation added in v1.11.0 

type RunLogLocation struct {

	// The log stream ARN for the engine log.
	EngineLogStream *string

	// The log stream ARN for the run log.
	RunLogStream *string
	// contains filtered or unexported fields
}

The URI for the run log.

type RunRetentionMode added in v1.9.0 

type RunRetentionMode string
const (
	RunRetentionModeRetain RunRetentionMode = "RETAIN"
	RunRetentionModeRemove RunRetentionMode = "REMOVE"
)

Enum values for RunRetentionMode

func (RunRetentionMode) Values added in v1.9.0 

func (RunRetentionMode) Values() []RunRetentionMode

Values returns all known values for RunRetentionMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RunStatus 

type RunStatus string
const (
	RunStatusPending   RunStatus = "PENDING"
	RunStatusStarting  RunStatus = "STARTING"
	RunStatusRunning   RunStatus = "RUNNING"
	RunStatusStopping  RunStatus = "STOPPING"
	RunStatusCompleted RunStatus = "COMPLETED"
	RunStatusDeleted   RunStatus = "DELETED"
	RunStatusCancelled RunStatus = "CANCELLED"
	RunStatusFailed    RunStatus = "FAILED"
)

Enum values for RunStatus

func (RunStatus) Values 

func (RunStatus) Values() []RunStatus

Values returns all known values for RunStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SchemaValueType 

type SchemaValueType string
const (
	// LONG type
	SchemaValueTypeLong SchemaValueType = "LONG"
	// INT type
	SchemaValueTypeInt SchemaValueType = "INT"
	// STRING type
	SchemaValueTypeString SchemaValueType = "STRING"
	// FLOAT type
	SchemaValueTypeFloat SchemaValueType = "FLOAT"
	// DOUBLE type
	SchemaValueTypeDouble SchemaValueType = "DOUBLE"
	// BOOLEAN type
	SchemaValueTypeBoolean SchemaValueType = "BOOLEAN"
)

Enum values for SchemaValueType

func (SchemaValueType) Values 

func (SchemaValueType) Values() []SchemaValueType

Values returns all known values for SchemaValueType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SequenceInformation 

type SequenceInformation struct {

	// The sequence's alignment setting.
	Alignment *string

	// Where the sequence originated.
	GeneratedFrom *string

	// The sequence's total base count.
	TotalBaseCount *int64

	// The sequence's total read count.
	TotalReadCount *int64
	// contains filtered or unexported fields
}

Details about a sequence.

type SequenceStoreDetail 

type SequenceStoreDetail struct {

	// The store's ARN.
	//
	// This member is required.
	Arn *string

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's description.
	Description *string

	// The algorithm family of the ETag.
	ETagAlgorithmFamily ETagAlgorithmFamily

	//  An S3 location that is used to store files that have failed a direct upload.
	FallbackLocation *string

	// The store's name.
	Name *string

	// The store's server-side encryption (SSE) settings.
	SseConfig *SseConfig
	// contains filtered or unexported fields
}

Details about a sequence store.

type SequenceStoreFilter 

type SequenceStoreFilter struct {

	// The filter's start date.
	CreatedAfter *time.Time

	// The filter's end date.
	CreatedBefore *time.Time

	// A name to filter on.
	Name *string
	// contains filtered or unexported fields
}

A filter for a sequence store.

type SequenceStoreS3Access added in v1.20.0 

type SequenceStoreS3Access struct {

	// This is ARN of the access point associated with the S3 bucket storing read sets.
	S3AccessPointArn *string

	// The S3 URI of the sequence store.
	S3Uri *string
	// contains filtered or unexported fields
}

The S3 access metadata of the sequence store.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request exceeds a service quota.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ShareDetails added in v1.8.0 

type ShareDetails struct {

	// The timestamp of when the resource share was created.
	CreationTime *time.Time

	// The account ID for the data owner. The owner creates the resource share.
	OwnerId *string

	// The principal subscriber is the account that is sharing the resource.
	PrincipalSubscriber *string

	// The Arn of the shared resource.
	ResourceArn *string

	// The ID of the shared resource.
	ResourceId *string

	// The ID of the resource share.
	ShareId *string

	// The name of the resource share.
	ShareName *string

	// The status of the share.
	Status ShareStatus

	// The status message for a resource share. It provides additional details about
	// the share status.
	StatusMessage *string

	// The timestamp of the resource share update.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

The details of a resource share.

type ShareResourceType added in v1.21.0 

type ShareResourceType string
const (
	// The share is on a variant store
	ShareResourceTypeVariantStore ShareResourceType = "VARIANT_STORE"
	// The share is on an annotation store
	ShareResourceTypeAnnotationStore ShareResourceType = "ANNOTATION_STORE"
	// The share is on a workflow
	ShareResourceTypeWorkflow ShareResourceType = "WORKFLOW"
)

Enum values for ShareResourceType

func (ShareResourceType) Values added in v1.21.0 

func (ShareResourceType) Values() []ShareResourceType

Values returns all known values for ShareResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ShareStatus added in v1.8.0 

type ShareStatus string
const (
	// The share has been created but is not yet active
	ShareStatusPending ShareStatus = "PENDING"
	// The share is activated
	ShareStatusActivating ShareStatus = "ACTIVATING"
	// The share is active and can be used
	ShareStatusActive ShareStatus = "ACTIVE"
	// The share is being deleted
	ShareStatusDeleting ShareStatus = "DELETING"
	// The share has been deleted
	ShareStatusDeleted ShareStatus = "DELETED"
	// The share has failed to activate or delete
	ShareStatusFailed ShareStatus = "FAILED"
)

Enum values for ShareStatus

func (ShareStatus) Values added in v1.8.0 

func (ShareStatus) Values() []ShareStatus

Values returns all known values for ShareStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SourceFiles 

type SourceFiles struct {

	// The location of the first file in Amazon S3.
	//
	// This member is required.
	Source1 *string

	// The location of the second file in Amazon S3.
	Source2 *string
	// contains filtered or unexported fields
}

Source files for a sequence.

type SseConfig 

type SseConfig struct {

	// The encryption type.
	//
	// This member is required.
	Type EncryptionType

	// An encryption key ARN.
	KeyArn *string
	// contains filtered or unexported fields
}

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

type StartReadSetActivationJobSourceItem 

type StartReadSetActivationJobSourceItem struct {

	// The source's read set ID.
	//
	// This member is required.
	ReadSetId *string
	// contains filtered or unexported fields
}

A source for a read set activation job.

type StartReadSetImportJobSourceItem 

type StartReadSetImportJobSourceItem struct {

	// The source's sample ID.
	//
	// This member is required.
	SampleId *string

	// The source's file type.
	//
	// This member is required.
	SourceFileType FileType

	// The source files' location in Amazon S3.
	//
	// This member is required.
	SourceFiles *SourceFiles

	// The source's subject ID.
	//
	// This member is required.
	SubjectId *string

	// The source's description.
	Description *string

	// Where the source originated.
	GeneratedFrom *string

	// The source's name.
	Name *string

	// The source's reference ARN.
	ReferenceArn *string

	// The source's tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

A source for a read set import job.

type StartReferenceImportJobSourceItem 

type StartReferenceImportJobSourceItem struct {

	// The source's name.
	//
	// This member is required.
	Name *string

	// The source file's location in Amazon S3.
	//
	// This member is required.
	SourceFile *string

	// The source's description.
	Description *string

	// The source's tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

A source for a reference import job.

type StorageType added in v1.21.0 

type StorageType string
const (
	StorageTypeStatic  StorageType = "STATIC"
	StorageTypeDynamic StorageType = "DYNAMIC"
)

Enum values for StorageType

func (StorageType) Values added in v1.21.0 

func (StorageType) Values() []StorageType

Values returns all known values for StorageType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StoreFormat 

type StoreFormat string
const (
	// GFF3 Format
	StoreFormatGff StoreFormat = "GFF"
	// TSV Format
	StoreFormatTsv StoreFormat = "TSV"
	// VCF Format
	StoreFormatVcf StoreFormat = "VCF"
)

Enum values for StoreFormat

func (StoreFormat) Values 

func (StoreFormat) Values() []StoreFormat

Values returns all known values for StoreFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StoreOptions 

type StoreOptions interface {
	// contains filtered or unexported methods
}

Settings for a store.

The following types satisfy this interface: 

StoreOptionsMemberTsvStoreOptions
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/omics/types"
)

func main() {
	var union types.StoreOptions
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.StoreOptionsMemberTsvStoreOptions:
		_ = v.Value // Value is types.TsvStoreOptions

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type StoreOptionsMemberTsvStoreOptions 

type StoreOptionsMemberTsvStoreOptions struct {
	Value TsvStoreOptions
	// contains filtered or unexported fields
}

File settings for a TSV store.

type StoreStatus 

type StoreStatus string
const (
	// The Store is being created
	StoreStatusCreating StoreStatus = "CREATING"
	// The Store is updating
	StoreStatusUpdating StoreStatus = "UPDATING"
	// The Store is deleting
	StoreStatusDeleting StoreStatus = "DELETING"
	// The Store is active
	StoreStatusActive StoreStatus = "ACTIVE"
	// The Store creation failed
	StoreStatusFailed StoreStatus = "FAILED"
)

Enum values for StoreStatus

func (StoreStatus) Values 

func (StoreStatus) Values() []StoreStatus

Values returns all known values for StoreStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TaskListItem 

type TaskListItem struct {

	// The task's CPU count.
	Cpus *int32

	// When the task was created.
	CreationTime *time.Time

	//  The number of Graphics Processing Units (GPU) specified for the task.
	Gpus *int32

	//  The instance type for a task.
	InstanceType *string

	// The task's memory use in gigabyes.
	Memory *int32

	// The task's name.
	Name *string

	// When the task started.
	StartTime *time.Time

	// The task's status.
	Status TaskStatus

	// When the task stopped.
	StopTime *time.Time

	// The task's ID.
	TaskId *string
	// contains filtered or unexported fields
}

A workflow run task.

type TaskStatus 

type TaskStatus string
const (
	TaskStatusPending   TaskStatus = "PENDING"
	TaskStatusStarting  TaskStatus = "STARTING"
	TaskStatusRunning   TaskStatus = "RUNNING"
	TaskStatusStopping  TaskStatus = "STOPPING"
	TaskStatusCompleted TaskStatus = "COMPLETED"
	TaskStatusCancelled TaskStatus = "CANCELLED"
	TaskStatusFailed    TaskStatus = "FAILED"
)

Enum values for TaskStatus

func (TaskStatus) Values 

func (TaskStatus) Values() []TaskStatus

Values returns all known values for TaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TsvOptions 

type TsvOptions struct {

	// The file's read options.
	ReadOptions *ReadOptions
	// contains filtered or unexported fields
}

Formatting options for a TSV file.

type TsvStoreOptions 

type TsvStoreOptions struct {

	// The store's annotation type.
	AnnotationType AnnotationType

	// The store's header key to column name mapping.
	FormatToHeader map[string]string

	// The store's schema.
	Schema []map[string]SchemaValueType
	// contains filtered or unexported fields
}

File settings for a TSV store.

type TsvVersionOptions added in v1.8.0 

type TsvVersionOptions struct {

	//  The store version's annotation type.
	AnnotationType AnnotationType

	//  The annotation store version's header key to column name mapping.
	FormatToHeader map[string]string

	//  The TSV schema for an annotation store version.
	Schema []map[string]SchemaValueType
	// contains filtered or unexported fields
}

The options for a TSV file.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VariantImportItemDetail 

type VariantImportItemDetail struct {

	// The item's job status.
	//
	// This member is required.
	JobStatus JobStatus

	// The source file's location in Amazon S3.
	//
	// This member is required.
	Source *string

	//  A message that provides additional context about a job
	StatusMessage *string
	// contains filtered or unexported fields
}

Details about an imported variant item.

type VariantImportItemSource 

type VariantImportItemSource struct {

	// The source file's location in Amazon S3.
	//
	// This member is required.
	Source *string
	// contains filtered or unexported fields
}

A imported variant item's source.

type VariantImportJobItem 

type VariantImportJobItem struct {

	// When the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The job's destination variant store.
	//
	// This member is required.
	DestinationName *string

	// The job's ID.
	//
	// This member is required.
	Id *string

	// The job's service role ARN.
	//
	// This member is required.
	RoleArn *string

	// The job's status.
	//
	// This member is required.
	Status JobStatus

	// When the job was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The annotation schema generated by the parsed annotation data.
	AnnotationFields map[string]string

	// When the job completed.
	CompletionTime *time.Time

	// The job's left normalization setting.
	RunLeftNormalization bool
	// contains filtered or unexported fields
}

A variant import job.

type VariantStoreItem 

type VariantStoreItem struct {

	// When the store was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The store's description.
	//
	// This member is required.
	Description *string

	// The store's ID.
	//
	// This member is required.
	Id *string

	// The store's name.
	//
	// This member is required.
	Name *string

	// The store's genome reference.
	//
	// This member is required.
	Reference ReferenceItem

	// The store's server-side encryption (SSE) settings.
	//
	// This member is required.
	SseConfig *SseConfig

	// The store's status.
	//
	// This member is required.
	Status StoreStatus

	// The store's status message.
	//
	// This member is required.
	StatusMessage *string

	// The store's ARN.
	//
	// This member is required.
	StoreArn *string

	// The store's size in bytes.
	//
	// This member is required.
	StoreSizeBytes *int64

	// When the store was updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

A variant store.

type VcfOptions 

type VcfOptions struct {

	// The file's ignore filter field setting.
	IgnoreFilterField *bool

	// The file's ignore qual field setting.
	IgnoreQualField *bool
	// contains filtered or unexported fields
}

Formatting options for a VCF file.

type VersionDeleteError added in v1.8.0 

type VersionDeleteError struct {

	//  The message explaining the error in annotation store deletion.
	//
	// This member is required.
	Message *string

	//  The name given to an annotation store version.
	//
	// This member is required.
	VersionName *string
	// contains filtered or unexported fields
}

The error preventing deletion of the annotation store version.

type VersionOptions added in v1.8.0 

type VersionOptions interface {
	// contains filtered or unexported methods
}
The options for an annotation store version.

The following types satisfy this interface: 

VersionOptionsMemberTsvVersionOptions
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/omics/types"
)

func main() {
	var union types.VersionOptions
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.VersionOptionsMemberTsvVersionOptions:
		_ = v.Value // Value is types.TsvVersionOptions

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type VersionOptionsMemberTsvVersionOptions added in v1.8.0 

type VersionOptionsMemberTsvVersionOptions struct {
	Value TsvVersionOptions
	// contains filtered or unexported fields
}

File settings for a version of a TSV store.

type VersionStatus added in v1.8.0 

type VersionStatus string
const (
	// The Version is being created
	VersionStatusCreating VersionStatus = "CREATING"
	// The Version is updating
	VersionStatusUpdating VersionStatus = "UPDATING"
	// The Version is deleting
	VersionStatusDeleting VersionStatus = "DELETING"
	// The Version is active
	VersionStatusActive VersionStatus = "ACTIVE"
	// The Version creation failed
	VersionStatusFailed VersionStatus = "FAILED"
)

Enum values for VersionStatus

func (VersionStatus) Values added in v1.8.0 

func (VersionStatus) Values() []VersionStatus

Values returns all known values for VersionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkflowEngine 

type WorkflowEngine string
const (
	WorkflowEngineWdl      WorkflowEngine = "WDL"
	WorkflowEngineNextflow WorkflowEngine = "NEXTFLOW"
	WorkflowEngineCwl      WorkflowEngine = "CWL"
)

Enum values for WorkflowEngine

func (WorkflowEngine) Values 

func (WorkflowEngine) Values() []WorkflowEngine

Values returns all known values for WorkflowEngine. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkflowExport 

type WorkflowExport string
const (
	WorkflowExportDefinition WorkflowExport = "DEFINITION"
)

Enum values for WorkflowExport

func (WorkflowExport) Values 

func (WorkflowExport) Values() []WorkflowExport

Values returns all known values for WorkflowExport. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkflowListItem 

type WorkflowListItem struct {

	// The workflow's ARN.
	Arn *string

	// When the workflow was created.
	CreationTime *time.Time

	// The workflow's digest.
	Digest *string

	// The workflow's ID.
	Id *string

	//  Any metadata available for workflow. The information listed may vary depending
	// on the workflow, and there may also be no metadata to return.
	Metadata map[string]string

	// The workflow's name.
	Name *string

	// The workflow's status.
	Status WorkflowStatus

	// The workflow's type.
	Type WorkflowType
	// contains filtered or unexported fields
}

A workflow.

type WorkflowParameter 

type WorkflowParameter struct {

	// The parameter's description.
	Description *string

	// Whether the parameter is optional.
	Optional *bool
	// contains filtered or unexported fields
}

A workflow parameter.

type WorkflowStatus 

type WorkflowStatus string
const (
	WorkflowStatusCreating WorkflowStatus = "CREATING"
	WorkflowStatusActive   WorkflowStatus = "ACTIVE"
	WorkflowStatusUpdating WorkflowStatus = "UPDATING"
	WorkflowStatusDeleted  WorkflowStatus = "DELETED"
	WorkflowStatusFailed   WorkflowStatus = "FAILED"
	WorkflowStatusInactive WorkflowStatus = "INACTIVE"
)

Enum values for WorkflowStatus

func (WorkflowStatus) Values 

func (WorkflowStatus) Values() []WorkflowStatus

Values returns all known values for WorkflowStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkflowType 

type WorkflowType string
const (
	WorkflowTypePrivate   WorkflowType = "PRIVATE"
	WorkflowTypeReady2run WorkflowType = "READY2RUN"
)

Enum values for WorkflowType

func (WorkflowType) Values 

func (WorkflowType) Values() []WorkflowType

Values returns all known values for WorkflowType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.