openapi: 3.0.0
info:
version: '2022-11-28'
x-release: v4
title: Amazon Omics
description: 'This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS
HealthOmics User Guide.'
x-logo:
url: 'https://twitter.com/awscloud/profile_image?size=original'
backgroundColor: '#FFFFFF'
termsOfService: 'https://aws.amazon.com/service-terms/'
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: 'https://github.com/mermade/aws2openapi'
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: 'http://www.apache.org/licenses/'
x-providerName: amazonaws.com
x-serviceName: omics
x-aws-signingName: omics
x-origin:
- contentType: application/json
url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/omics-2022-11-28.normal.json'
converter:
url: 'https://github.com/mermade/aws2openapi'
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct'
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: 'https://docs.aws.amazon.com/omics/'
servers:
- url: 'http://omics.{region}.amazonaws.com'
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Omics multi-region endpoint
- url: 'https://omics.{region}.amazonaws.com'
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Omics multi-region endpoint
- url: 'http://omics.{region}.amazonaws.com.cn'
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Omics endpoint for China (Beijing) and China (Ningxia)
- url: 'https://omics.{region}.amazonaws.com.cn'
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Omics endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
'/sequencestore/{sequenceStoreId}/upload/{uploadId}/abort':
delete:
operationId: AbortMultipartReadSetUpload
description: ' Stops a multipart upload. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AbortMultipartReadSetUploadResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: NotSupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/NotSupportedOperationException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: ' The sequence store ID for the store involved in the multipart upload. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: uploadId
in: path
required: true
description: ' The ID for the multipart upload. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Abort Multipart Read Set Upload
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/readset/batch/delete':
post:
operationId: BatchDeleteReadSet
description: Deletes one or more read sets.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDeleteReadSetResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: The read sets' sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ids
properties:
ids:
description: The read sets' IDs.
type: array
items:
$ref: '#/components/schemas/ReadSetId'
minItems: 1
maxItems: 100
summary: Amazon HealthOmics Batch Delete Read Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/import/annotation/{jobId}':
delete:
operationId: CancelAnnotationImportJob
description: Cancels an annotation import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelAnnotationImportResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: jobId
in: path
required: true
description: The job's ID.
schema:
type: string
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
summary: Amazon HealthOmics Cancel Annotation Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetAnnotationImportJob
description: Gets information about an annotation import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAnnotationImportResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: jobId
in: path
required: true
description: The job's ID.
schema:
type: string
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
summary: Amazon HealthOmics Get Annotation Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/run/{id}/cancel':
post:
operationId: CancelRun
description: Cancels a run.
responses:
'202':
description: Success
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The run's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
summary: Amazon HealthOmics Cancel Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/import/variant/{jobId}':
delete:
operationId: CancelVariantImportJob
description: Cancels a variant import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelVariantImportResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: jobId
in: path
required: true
description: The job's ID.
schema:
type: string
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
summary: Amazon HealthOmics Cancel Variant Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetVariantImportJob
description: Gets information about a variant import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetVariantImportResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: jobId
in: path
required: true
description: The job's ID.
schema:
type: string
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
summary: Amazon HealthOmics Get Variant Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/sequencestore/{sequenceStoreId}/upload/{uploadId}/complete':
post:
operationId: CompleteMultipartReadSetUpload
description: ' Concludes a multipart upload once you have uploaded all the components. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CompleteMultipartReadSetUploadResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: NotSupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/NotSupportedOperationException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: ' The sequence store ID for the store involved in the multipart upload. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: uploadId
in: path
required: true
description: ' The ID for the multipart upload. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- parts
properties:
parts:
description: ' The individual uploads or parts of a multipart upload. '
type: array
items:
$ref: '#/components/schemas/CompleteReadSetUploadPartListItem'
summary: Amazon HealthOmics Complete Multipart Read Set Upload
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/annotationStore:
post:
operationId: CreateAnnotationStore
description: Creates an annotation store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAnnotationStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- storeFormat
properties:
reference:
description: A genome reference.
type: object
properties:
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The reference's ARN.
name:
description: A name for the store.
type: string
pattern: '([a-z]){1}([a-z0-9_]){2,254}'
description:
description: A description for the store.
type: string
minLength: 0
maxLength: 500
tags:
description: Tags for the store.
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
sseConfig:
description: Server-side encryption (SSE) settings for a store.
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/EncryptionType'
- description: The encryption type.
keyArn:
allOf:
- $ref: '#/components/schemas/SseConfigKeyArnString'
- description: An encryption key ARN.
storeFormat:
description: The annotation file format of the store.
type: string
enum:
- GFF
- TSV
- VCF
storeOptions:
description: Settings for a store.
type: object
properties:
tsvStoreOptions:
allOf:
- $ref: '#/components/schemas/TsvStoreOptions'
- description: File settings for a TSV store.
summary: Amazon HealthOmics Create Annotation Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/upload':
post:
operationId: CreateMultipartReadSetUpload
description: ' Begins a multipart read set upload. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMultipartReadSetUploadResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: NotSupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/NotSupportedOperationException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: ' The sequence store ID for the store that is the destination of the multipart uploads. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sourceFileType
- subjectId
- sampleId
- referenceArn
- name
properties:
clientToken:
description: ' An idempotency token that can be used to avoid triggering multiple multipart uploads. '
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
sourceFileType:
description: ' The type of file being uploaded. '
type: string
enum:
- FASTQ
- BAM
- CRAM
subjectId:
description: ' The source''s subject ID. '
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
sampleId:
description: ' The source''s sample ID. '
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
generatedFrom:
description: ' Where the source originated. '
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
referenceArn:
description: ' The ARN of the reference. '
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 127
name:
description: ' The name of the read set. '
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
description:
description: ' The description of the read set. '
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 255
tags:
description: ' Any tags to add to the read set. '
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon HealthOmics Create Multipart Read Set Upload
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/referencestore:
post:
operationId: CreateReferenceStore
description: Creates a reference store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReferenceStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
description: A name for the store.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
description:
description: A description for the store.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 255
sseConfig:
description: Server-side encryption (SSE) settings for a store.
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/EncryptionType'
- description: The encryption type.
keyArn:
allOf:
- $ref: '#/components/schemas/SseConfigKeyArnString'
- description: An encryption key ARN.
tags:
description: Tags for the store.
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
clientToken:
description: 'To ensure that requests don''t run multiple times, specify a unique token for each request.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
summary: Amazon HealthOmics Create Reference Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/runGroup:
post:
operationId: CreateRunGroup
description: Creates a run group.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRunGroupResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- requestId
properties:
name:
description: A name for the group.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
maxCpus:
description: The maximum number of CPUs to use in the group.
type: integer
minimum: 1
maximum: 100000
maxRuns:
description: The maximum number of concurrent runs for the group.
type: integer
minimum: 1
maximum: 100000
maxDuration:
description: A maximum run time for the group in minutes.
type: integer
minimum: 1
maximum: 100000
tags:
description: Tags for the group.
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
requestId:
description: 'To ensure that requests don''t run multiple times, specify a unique ID for each request.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
maxGpus:
description: ' The maximum GPUs that can be used by a run group. '
type: integer
minimum: 1
maximum: 100000
summary: Amazon HealthOmics Create Run Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListRunGroups
description: Retrieves a list of run groups.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRunGroupsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: name
in: query
required: false
description: The run groups' name.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
- name: startingToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
- name: maxResults
in: query
required: false
description: The maximum number of run groups to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
summary: Amazon HealthOmics List Run Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/sequencestore:
post:
operationId: CreateSequenceStore
description: Creates a sequence store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSequenceStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
description: A name for the store.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
description:
description: A description for the store.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 255
sseConfig:
description: Server-side encryption (SSE) settings for a store.
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/EncryptionType'
- description: The encryption type.
keyArn:
allOf:
- $ref: '#/components/schemas/SseConfigKeyArnString'
- description: An encryption key ARN.
tags:
description: Tags for the store.
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
clientToken:
description: 'To ensure that requests don''t run multiple times, specify a unique token for each request.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
fallbackLocation:
description: ' An S3 location that is used to store files that have failed a direct upload. '
type: string
pattern: 's3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?'
summary: Amazon HealthOmics Create Sequence Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/variantStore:
post:
operationId: CreateVariantStore
description: Creates a variant store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVariantStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- reference
properties:
reference:
description: A genome reference.
type: object
properties:
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The reference's ARN.
name:
description: A name for the store.
type: string
pattern: '([a-z]){1}([a-z0-9_]){2,254}'
description:
description: A description for the store.
type: string
minLength: 0
maxLength: 500
tags:
description: Tags for the store.
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
sseConfig:
description: Server-side encryption (SSE) settings for a store.
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/EncryptionType'
- description: The encryption type.
keyArn:
allOf:
- $ref: '#/components/schemas/SseConfigKeyArnString'
- description: An encryption key ARN.
summary: Amazon HealthOmics Create Variant Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/workflow:
post:
operationId: CreateWorkflow
description: Creates a workflow.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkflowResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- requestId
properties:
name:
description: A name for the workflow.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
description:
description: A description for the workflow.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 256
engine:
description: An engine for the workflow.
type: string
enum:
- WDL
- NEXTFLOW
- CWL
minLength: 1
maxLength: 64
definitionZip:
description: A ZIP archive for the workflow.
type: string
definitionUri:
description: The URI of a definition for the workflow.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 256
main:
description: The path of the main definition file for the workflow.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
parameterTemplate:
description: A parameter template for the workflow.
type: object
minProperties: 1
maxProperties: 1000
additionalProperties:
$ref: '#/components/schemas/WorkflowParameter'
storageCapacity:
description: A storage capacity for the workflow in gigabytes.
type: integer
minimum: 0
maximum: 100000
tags:
description: Tags for the workflow.
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
requestId:
description: 'To ensure that requests don''t run multiple times, specify a unique ID for each request.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
accelerators:
description: ' The computational accelerator specified to run the workflow. '
type: string
enum:
- GPU
minLength: 1
maxLength: 64
summary: Amazon HealthOmics Create Workflow
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListWorkflows
description: Retrieves a list of workflows.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListWorkflowsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: type
in: query
required: false
description: The workflows' type.
schema:
type: string
enum:
- PRIVATE
- READY2RUN
minLength: 1
maxLength: 64
- name: name
in: query
required: false
description: The workflows' name.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
- name: startingToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
- name: maxResults
in: query
required: false
description: The maximum number of workflows to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
summary: Amazon HealthOmics List Workflows
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/annotationStore/{name}':
delete:
operationId: DeleteAnnotationStore
description: Deletes an annotation store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAnnotationStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: name
in: path
required: true
description: The store's name.
schema:
type: string
- name: force
in: query
required: false
description: Whether to force deletion.
schema:
type: boolean
summary: Amazon HealthOmics Delete Annotation Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetAnnotationStore
description: Gets information about an annotation store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAnnotationStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: name
in: path
required: true
description: The store's name.
schema:
type: string
summary: Amazon HealthOmics Get Annotation Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: UpdateAnnotationStore
description: Updates an annotation store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAnnotationStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: name
in: path
required: true
description: A name for the store.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
description: A description for the store.
type: string
minLength: 0
maxLength: 500
summary: Amazon HealthOmics Update Annotation Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/referencestore/{referenceStoreId}/reference/{id}':
delete:
operationId: DeleteReference
description: Deletes a genome reference.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteReferenceResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The reference's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: referenceStoreId
in: path
required: true
description: The reference's store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Delete Reference
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/referencestore/{id}':
delete:
operationId: DeleteReferenceStore
description: Deletes a genome reference store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteReferenceStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The store's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Delete Reference Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetReferenceStore
description: Gets information about a reference store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReferenceStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The store's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Get Reference Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/run/{id}':
delete:
operationId: DeleteRun
description: Deletes a workflow run.
responses:
'202':
description: Success
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The run's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
summary: Amazon HealthOmics Delete Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetRun
description: Gets information about a workflow run.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRunResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The run's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
- name: export
in: query
required: false
description: The run's export format.
schema:
type: array
items:
$ref: '#/components/schemas/RunExport'
minItems: 0
maxItems: 32
summary: Amazon HealthOmics Get Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/runGroup/{id}':
delete:
operationId: DeleteRunGroup
description: Deletes a workflow run group.
responses:
'202':
description: Success
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The run group's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
summary: Amazon HealthOmics Delete Run Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetRunGroup
description: Gets information about a workflow run group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRunGroupResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The group's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
summary: Amazon HealthOmics Get Run Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: UpdateRunGroup
description: Updates a run group.
responses:
'202':
description: Success
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The group's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
description: A name for the group.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
maxCpus:
description: The maximum number of CPUs to use.
type: integer
minimum: 1
maximum: 100000
maxRuns:
description: The maximum number of concurrent runs for the group.
type: integer
minimum: 1
maximum: 100000
maxDuration:
description: A maximum run time for the group in minutes.
type: integer
minimum: 1
maximum: 100000
maxGpus:
description: ' The maximum GPUs that can be used by a run group. '
type: integer
minimum: 1
maximum: 100000
summary: Amazon HealthOmics Update Run Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/sequencestore/{id}':
delete:
operationId: DeleteSequenceStore
description: Deletes a sequence store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSequenceStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The sequence store's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Delete Sequence Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetSequenceStore
description: Gets information about a sequence store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSequenceStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The store's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Get Sequence Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/variantStore/{name}':
delete:
operationId: DeleteVariantStore
description: Deletes a variant store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteVariantStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: name
in: path
required: true
description: The store's name.
schema:
type: string
- name: force
in: query
required: false
description: Whether to force deletion.
schema:
type: boolean
summary: Amazon HealthOmics Delete Variant Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetVariantStore
description: Gets information about a variant store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetVariantStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: name
in: path
required: true
description: The store's name.
schema:
type: string
summary: Amazon HealthOmics Get Variant Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: UpdateVariantStore
description: Updates a variant store.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVariantStoreResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: name
in: path
required: true
description: A name for the store.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
description: A description for the store.
type: string
minLength: 0
maxLength: 500
summary: Amazon HealthOmics Update Variant Store
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/workflow/{id}':
delete:
operationId: DeleteWorkflow
description: Deletes a workflow.
responses:
'202':
description: Success
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The workflow's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
summary: Amazon HealthOmics Delete Workflow
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetWorkflow
description: Gets information about a workflow.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkflowResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The workflow's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
- name: type
in: query
required: false
description: The workflow's type.
schema:
type: string
enum:
- PRIVATE
- READY2RUN
minLength: 1
maxLength: 64
- name: export
in: query
required: false
description: The export format for the workflow.
schema:
type: array
items:
$ref: '#/components/schemas/WorkflowExport'
minItems: 0
maxItems: 32
summary: Amazon HealthOmics Get Workflow
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: UpdateWorkflow
description: Updates a workflow.
responses:
'202':
description: Success
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The workflow's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
description: A name for the workflow.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
description:
description: A description for the workflow.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 256
summary: Amazon HealthOmics Update Workflow
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/sequencestore/{sequenceStoreId}/readset/{id}#partNumber':
get:
operationId: GetReadSet
description: Gets a file from a read set.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReadSetResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: RangeNotSatisfiableException
content:
application/json:
schema:
$ref: '#/components/schemas/RangeNotSatisfiableException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The read set's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: sequenceStoreId
in: path
required: true
description: The read set's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: file
in: query
required: false
description: The file to retrieve.
schema:
type: string
enum:
- SOURCE1
- SOURCE2
- INDEX
- name: partNumber
in: query
required: true
description: The part number to retrieve.
schema:
type: integer
minimum: 1
maximum: 10000
summary: Amazon HealthOmics Get Read Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/activationjob/{id}':
get:
operationId: GetReadSetActivationJob
description: Gets information about a read set activation job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReadSetActivationJobResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The job's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: sequenceStoreId
in: path
required: true
description: The job's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Get Read Set Activation Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/exportjob/{id}':
get:
operationId: GetReadSetExportJob
description: Gets information about a read set export job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReadSetExportJobResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: The job's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: id
in: path
required: true
description: The job's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Get Read Set Export Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/importjob/{id}':
get:
operationId: GetReadSetImportJob
description: Gets information about a read set import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReadSetImportJobResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The job's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: sequenceStoreId
in: path
required: true
description: The job's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Get Read Set Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/readset/{id}/metadata':
get:
operationId: GetReadSetMetadata
description: Gets details about a read set.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReadSetMetadataResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The read set's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: sequenceStoreId
in: path
required: true
description: The read set's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Get Read Set Metadata
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/referencestore/{referenceStoreId}/reference/{id}#partNumber':
get:
operationId: GetReference
description: Gets a reference file.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReferenceResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: RangeNotSatisfiableException
content:
application/json:
schema:
$ref: '#/components/schemas/RangeNotSatisfiableException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The reference's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: referenceStoreId
in: path
required: true
description: The reference's store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: Range
in: header
required: false
description: The range to retrieve.
schema:
type: string
pattern: '[\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
- name: partNumber
in: query
required: true
description: The part number to retrieve.
schema:
type: integer
minimum: 1
maximum: 10000
- name: file
in: query
required: false
description: The file to retrieve.
schema:
type: string
enum:
- SOURCE
- INDEX
summary: Amazon HealthOmics Get Reference
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/referencestore/{referenceStoreId}/importjob/{id}':
get:
operationId: GetReferenceImportJob
description: Gets information about a reference import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReferenceImportJobResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The job's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: referenceStoreId
in: path
required: true
description: The job's reference store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Get Reference Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/referencestore/{referenceStoreId}/reference/{id}/metadata':
get:
operationId: GetReferenceMetadata
description: Gets information about a genome reference's metadata.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReferenceMetadataResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The reference's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: referenceStoreId
in: path
required: true
description: The reference's reference store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
summary: Amazon HealthOmics Get Reference Metadata
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/run/{id}/task/{taskId}':
get:
operationId: GetRunTask
description: Gets information about a workflow run task.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRunTaskResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The task's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
- name: taskId
in: path
required: true
description: The task's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
summary: Amazon HealthOmics Get Run Task
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/import/annotations:
post:
operationId: ListAnnotationImportJobs
description: Retrieves a list of annotation import jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationImportJobsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of jobs to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
minLength: 1
maxLength: 10000
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
description: IDs of annotation import jobs to retrieve.
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
minItems: 1
maxItems: 20
filter:
description: A filter for annotation import jobs.
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: A status to filter on.
storeName:
allOf:
- $ref: '#/components/schemas/String'
- description: A store name to filter on.
summary: Amazon HealthOmics List Annotation Import Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/annotationStores:
post:
operationId: ListAnnotationStores
description: Retrieves a list of annotation stores.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationStoresResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of stores to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
minLength: 1
maxLength: 10000
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
description: IDs of stores to list.
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
minItems: 1
maxItems: 20
filter:
description: A filter for annotation stores.
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: A status to filter on.
summary: Amazon HealthOmics List Annotation Stores
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/uploads':
post:
operationId: ListMultipartReadSetUploads
description: ' Lists all multipart read set uploads and their statuses. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMultipartReadSetUploadsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: NotSupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/NotSupportedOperationException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: ' The Sequence Store ID used for the multipart uploads. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: maxResults
in: query
required: false
description: ' The maximum number of multipart uploads returned in a page. '
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: ' Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results. '
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
summary: Amazon HealthOmics List Multipart Read Set Uploads
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/activationjobs':
post:
operationId: ListReadSetActivationJobs
description: Retrieves a list of read set activation jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReadSetActivationJobsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: The read set's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: maxResults
in: query
required: false
description: The maximum number of read set activation jobs to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filter:
description: A read set activation job filter.
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReadSetActivationJobStatus'
- description: The filter's status.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
summary: Amazon HealthOmics List Read Set Activation Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/exportjobs':
post:
operationId: ListReadSetExportJobs
description: Retrieves a list of read set export jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReadSetExportJobsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: The jobs' sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: maxResults
in: query
required: false
description: The maximum number of jobs to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filter:
description: An read set export job filter.
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReadSetExportJobStatus'
- description: A status to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
summary: Amazon HealthOmics List Read Set Export Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/importjobs':
post:
operationId: ListReadSetImportJobs
description: Retrieves a list of read set import jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReadSetImportJobsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of jobs to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
- name: sequenceStoreId
in: path
required: true
description: The jobs' sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filter:
description: A filter for import read set jobs.
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReadSetImportJobStatus'
- description: A status to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
summary: Amazon HealthOmics List Read Set Import Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/upload/{uploadId}/parts':
post:
operationId: ListReadSetUploadParts
description: ' This operation will list all parts in a requested multipart upload for a sequence store. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReadSetUploadPartsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: NotSupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/NotSupportedOperationException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: ' The Sequence Store ID used for the multipart uploads. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: uploadId
in: path
required: true
description: ' The ID for the initiated multipart upload. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: maxResults
in: query
required: false
description: ' The maximum number of read set upload parts returned in a page. '
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: ' Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results. '
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- partSource
properties:
partSource:
description: ' The source file for the upload part. '
type: string
enum:
- SOURCE1
- SOURCE2
filter:
description: ' Filter settings that select for read set upload parts of interest. '
type: object
properties:
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: ' Filters for read set uploads after a specified time. '
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: ' Filters for read set part uploads before a specified time. '
summary: Amazon HealthOmics List Read Set Upload Parts
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/readsets':
post:
operationId: ListReadSets
description: Retrieves a list of read sets.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReadSetsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: The jobs' sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: maxResults
in: query
required: false
description: The maximum number of read sets to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filter:
description: A filter for read sets.
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: A name to filter on.
status:
allOf:
- $ref: '#/components/schemas/ReadSetStatus'
- description: A status to filter on.
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: A genome reference ARN to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: ' The read set source''s sample ID. '
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: ' The read set source''s subject ID. '
generatedFrom:
allOf:
- $ref: '#/components/schemas/GeneratedFrom'
- description: ' Where the source originated. '
creationType:
allOf:
- $ref: '#/components/schemas/CreationType'
- description: ' The creation type of the read set. '
summary: Amazon HealthOmics List Read Sets
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/referencestore/{referenceStoreId}/importjobs':
post:
operationId: ListReferenceImportJobs
description: Retrieves a list of reference import jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReferenceImportJobsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of jobs to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
- name: referenceStoreId
in: path
required: true
description: The job's reference store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filter:
description: A filter for import references.
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReferenceImportJobStatus'
- description: A status to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
summary: Amazon HealthOmics List Reference Import Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/referencestores:
post:
operationId: ListReferenceStores
description: Retrieves a list of reference stores.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReferenceStoresResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of stores to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filter:
description: A filter for reference stores.
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ReferenceStoreName'
- description: The name to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
summary: Amazon HealthOmics List Reference Stores
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/referencestore/{referenceStoreId}/references':
post:
operationId: ListReferences
description: Retrieves a list of references.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReferencesResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: referenceStoreId
in: path
required: true
description: The references' reference store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: maxResults
in: query
required: false
description: The maximum number of references to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filter:
description: A filter for references.
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ReferenceName'
- description: A name to filter on.
md5:
allOf:
- $ref: '#/components/schemas/Md5'
- description: An MD5 checksum to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
summary: Amazon HealthOmics List References
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/run/{id}/task':
get:
operationId: ListRunTasks
description: Retrieves a list of tasks for a run.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRunTasksResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: id
in: path
required: true
description: The run's ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
- name: status
in: query
required: false
description: Filter the list by status.
schema:
type: string
enum:
- PENDING
- STARTING
- RUNNING
- STOPPING
- COMPLETED
- CANCELLED
- FAILED
minLength: 1
maxLength: 64
- name: startingToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
- name: maxResults
in: query
required: false
description: The maximum number of run tasks to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
summary: Amazon HealthOmics List Run Tasks
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/run:
get:
operationId: ListRuns
description: Retrieves a list of runs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRunsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: name
in: query
required: false
description: Filter the list by run name.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
- name: runGroupId
in: query
required: false
description: Filter the list by run group ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
- name: startingToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
- name: maxResults
in: query
required: false
description: The maximum number of runs to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: status
in: query
required: false
description: ' The status of a run. '
schema:
type: string
enum:
- PENDING
- STARTING
- RUNNING
- STOPPING
- COMPLETED
- DELETED
- CANCELLED
- FAILED
minLength: 1
maxLength: 64
summary: Amazon HealthOmics List Runs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: StartRun
description: Starts a run.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartRunResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- roleArn
- requestId
properties:
workflowId:
description: The run's workflow ID.
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
workflowType:
description: The run's workflows type.
type: string
enum:
- PRIVATE
- READY2RUN
minLength: 1
maxLength: 64
runId:
description: The run's ID.
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
roleArn:
description: A service role for the run.
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
name:
description: A name for the run.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
runGroupId:
description: The run's group ID.
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
priority:
description: A priority for the run.
type: integer
minimum: 0
maximum: 100000
parameters:
description: Parameters for the run.
type: object
properties: {}
storageCapacity:
description: A storage capacity for the run in gigabytes.
type: integer
minimum: 0
maximum: 100000
outputUri:
description: An output URI for the run.
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
logLevel:
description: A log level for the run.
type: string
enum:
- 'OFF'
- FATAL
- ERROR
- ALL
minLength: 1
maxLength: 64
tags:
description: Tags for the run.
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
requestId:
description: 'To ensure that requests don''t run multiple times, specify a unique ID for each request.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
summary: Amazon HealthOmics Start Run
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/sequencestores:
post:
operationId: ListSequenceStores
description: Retrieves a list of sequence stores.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSequenceStoresResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of stores to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filter:
description: A filter for a sequence store.
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/SequenceStoreName'
- description: A name to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
summary: Amazon HealthOmics List Sequence Stores
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/tags/{resourceArn}':
get:
operationId: ListTagsForResource
description: Retrieves a list of tags for a resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: resourceArn
in: path
required: true
description: The resource's ARN.
schema:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
summary: Amazon HealthOmics List Tags for Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: TagResource
description: Tags a resource.
responses:
'204':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: resourceArn
in: path
required: true
description: The resource's ARN.
schema:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- tags
properties:
tags:
description: Tags for the resource.
type: object
minProperties: 0
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon HealthOmics Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/import/variants:
post:
operationId: ListVariantImportJobs
description: Retrieves a list of variant import jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListVariantImportJobsResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of import jobs to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
minLength: 1
maxLength: 10000
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
description: A list of job IDs.
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
minItems: 1
maxItems: 20
filter:
description: A filter for variant import jobs.
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: A status to filter on.
storeName:
allOf:
- $ref: '#/components/schemas/String'
- description: A store name to filter on.
summary: Amazon HealthOmics List Variant Import Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/variantStores:
post:
operationId: ListVariantStores
description: Retrieves a list of variant stores.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListVariantStoresResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of stores to return in one page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
minLength: 1
maxLength: 10000
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
description: A list of store IDs.
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
minItems: 1
maxItems: 20
filter:
description: A filter for variant stores.
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: A status to filter on.
summary: Amazon HealthOmics List Variant Stores
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/import/annotation:
post:
operationId: StartAnnotationImportJob
description: Starts an annotation import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartAnnotationImportResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- destinationName
- roleArn
- items
properties:
destinationName:
description: A destination annotation store for the job.
type: string
pattern: '([a-z]){1}([a-z0-9_]){2,254}'
minLength: 3
maxLength: 255
roleArn:
description: A service role for the job.
type: string
pattern: 'arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)'
minLength: 20
maxLength: 2048
items:
description: Items to import.
type: array
items:
$ref: '#/components/schemas/AnnotationImportItemSource'
minItems: 1
formatOptions:
description: Formatting options for a file.
type: object
properties:
tsvOptions:
allOf:
- $ref: '#/components/schemas/TsvOptions'
- description: Options for a TSV file.
vcfOptions:
allOf:
- $ref: '#/components/schemas/VcfOptions'
- description: Options for a VCF file.
runLeftNormalization:
description: The job's left normalization setting.
type: boolean
annotationFields:
description: ' The annotation schema generated by the parsed annotation data. '
type: object
additionalProperties:
$ref: '#/components/schemas/AnnotationFieldMapValueString'
summary: Amazon HealthOmics Start Annotation Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/activationjob':
post:
operationId: StartReadSetActivationJob
description: 'Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartReadSetActivationJobResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: The read set's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sources
properties:
clientToken:
description: 'To ensure that jobs don''t run multiple times, specify a unique token for each job.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
sources:
description: The job's source files.
type: array
items:
$ref: '#/components/schemas/StartReadSetActivationJobSourceItem'
minItems: 1
maxItems: 20
summary: Amazon HealthOmics Start Read Set Activation Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/exportjob':
post:
operationId: StartReadSetExportJob
description: Exports a read set to Amazon S3.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartReadSetExportJobResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: The read set's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- destination
- roleArn
- sources
properties:
destination:
description: A location for exported files in Amazon S3.
type: string
pattern: 's3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?'
roleArn:
description: A service role for the job.
type: string
pattern: 'arn:.*'
minLength: 20
maxLength: 2048
clientToken:
description: 'To ensure that jobs don''t run multiple times, specify a unique token for each job.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
sources:
description: The job's source files.
type: array
items:
$ref: '#/components/schemas/ExportReadSet'
minItems: 1
maxItems: 100
summary: Amazon HealthOmics Start Read Set Export Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/importjob':
post:
operationId: StartReadSetImportJob
description: Starts a read set import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartReadSetImportJobResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: The read set's sequence store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- roleArn
- sources
properties:
roleArn:
description: A service role for the job.
type: string
pattern: 'arn:.*'
minLength: 20
maxLength: 2048
clientToken:
description: 'To ensure that jobs don''t run multiple times, specify a unique token for each job.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
sources:
description: The job's source files.
type: array
items:
$ref: '#/components/schemas/StartReadSetImportJobSourceItem'
minItems: 1
maxItems: 100
summary: Amazon HealthOmics Start Read Set Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/referencestore/{referenceStoreId}/importjob':
post:
operationId: StartReferenceImportJob
description: Starts a reference import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartReferenceImportJobResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: referenceStoreId
in: path
required: true
description: The job's reference store ID.
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- roleArn
- sources
properties:
roleArn:
description: A service role for the job.
type: string
pattern: 'arn:.*'
minLength: 20
maxLength: 2048
clientToken:
description: 'To ensure that jobs don''t run multiple times, specify a unique token for each job.'
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
sources:
description: The job's source files.
type: array
items:
$ref: '#/components/schemas/StartReferenceImportJobSourceItem'
minItems: 1
maxItems: 100
summary: Amazon HealthOmics Start Reference Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
/import/variant:
post:
operationId: StartVariantImportJob
description: Starts a variant import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartVariantImportResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- destinationName
- roleArn
- items
properties:
destinationName:
description: The destination variant store for the job.
type: string
pattern: '([a-z]){1}([a-z0-9_]){2,254}'
minLength: 3
maxLength: 255
roleArn:
description: A service role for the job.
type: string
pattern: 'arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)'
minLength: 20
maxLength: 2048
items:
description: Items to import.
type: array
items:
$ref: '#/components/schemas/VariantImportItemSource'
minItems: 1
runLeftNormalization:
description: The job's left normalization setting.
type: boolean
annotationFields:
description: ' The annotation schema generated by the parsed annotation data. '
type: object
additionalProperties:
$ref: '#/components/schemas/AnnotationFieldMapValueString'
summary: Amazon HealthOmics Start Variant Import Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/tags/{resourceArn}#tagKeys':
delete:
operationId: UntagResource
description: Removes tags from a resource.
responses:
'204':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: resourceArn
in: path
required: true
description: The resource's ARN.
schema:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
- name: tagKeys
in: query
required: true
description: Keys of tags to remove.
schema:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 0
maxItems: 50
summary: Amazon HealthOmics Untag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
'/sequencestore/{sequenceStoreId}/upload/{uploadId}/part#partSource&partNumber':
put:
operationId: UploadReadSetPart
description: ' This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UploadReadSetPartResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: NotSupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/NotSupportedOperationException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'486':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'487':
description: RequestTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/RequestTimeoutException'
parameters:
- name: sequenceStoreId
in: path
required: true
description: ' The Sequence Store ID used for the multipart upload. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: uploadId
in: path
required: true
description: ' The ID for the initiated multipart upload. '
schema:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
- name: partSource
in: query
required: true
description: ' The source file for an upload part. '
schema:
type: string
enum:
- SOURCE1
- SOURCE2
- name: partNumber
in: query
required: true
description: ' The number of the part being uploaded. '
schema:
type: integer
minimum: 1
maximum: 10000
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- payload
properties:
payload:
description: ' The read set data to upload for a part. '
type: string
summary: Amazon HealthOmics Upload Read Set Part
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
AbortMultipartReadSetUploadResponse:
type: object
properties: {}
InternalServerException: {}
NotSupportedOperationException: {}
ServiceQuotaExceededException: {}
ThrottlingException: {}
ValidationException: {}
ResourceNotFoundException: {}
AccessDeniedException: {}
RequestTimeoutException: {}
BatchDeleteReadSetResponse:
type: object
properties:
errors:
allOf:
- $ref: '#/components/schemas/ReadSetBatchErrorList'
- description: Errors returned by individual delete operations.
ReadSetId:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
CancelAnnotationImportResponse:
type: object
properties: {}
ConflictException: {}
CancelVariantImportResponse:
type: object
properties: {}
CompleteMultipartReadSetUploadResponse:
type: object
required:
- readSetId
properties:
readSetId:
allOf:
- $ref: '#/components/schemas/ReadSetId'
- description: ' The read set ID created for an uploaded read set. '
CompleteReadSetUploadPartListItem:
type: object
required:
- partNumber
- partSource
- checksum
properties:
partNumber:
allOf:
- $ref: '#/components/schemas/CompleteReadSetUploadPartListItemPartNumberInteger'
- description: ' A number identifying the part in a read set upload. '
partSource:
allOf:
- $ref: '#/components/schemas/ReadSetPartSource'
- description: ' The source file of the part being uploaded. '
checksum:
allOf:
- $ref: '#/components/schemas/String'
- description: ' A unique identifier used to confirm that parts are being added to the correct upload. '
description: ' Part of the response to the CompleteReadSetUpload API, including metadata. '
CreateAnnotationStoreResponse:
type: object
required:
- id
- status
- name
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The store's ID.
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The store's genome reference. Required for all stores except TSV format with generic annotations.
storeFormat:
allOf:
- $ref: '#/components/schemas/StoreFormat'
- description: The annotation file format of the store.
storeOptions:
allOf:
- $ref: '#/components/schemas/StoreOptions'
- description: The store's file parsing options.
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The store's name.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the store was created.
ReferenceArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 127
TagValue:
type: string
minLength: 0
maxLength: 256
EncryptionType:
type: string
enum:
- KMS
SseConfigKeyArnString:
type: string
pattern: '.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*'
minLength: 20
maxLength: 2048
TsvStoreOptions:
type: object
properties:
annotationType:
allOf:
- $ref: '#/components/schemas/AnnotationType'
- description: The store's annotation type.
formatToHeader:
allOf:
- $ref: '#/components/schemas/FormatToHeader'
- description: The store's header key to column name mapping.
schema:
allOf:
- $ref: '#/components/schemas/TsvStoreOptionsSchemaList'
- description: The store's schema.
description: File settings for a TSV store.
CreateMultipartReadSetUploadResponse:
type: object
required:
- sequenceStoreId
- uploadId
- sourceFileType
- subjectId
- sampleId
- referenceArn
- creationTime
properties:
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: ' The sequence store ID for the store that the read set will be created in. '
uploadId:
allOf:
- $ref: '#/components/schemas/UploadId'
- description: ' he ID for the initiated multipart upload. '
sourceFileType:
allOf:
- $ref: '#/components/schemas/FileType'
- description: ' The file type of the read set source. '
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: ' The source''s subject ID. '
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: ' The source''s sample ID. '
generatedFrom:
allOf:
- $ref: '#/components/schemas/GeneratedFrom'
- description: ' The source of the read set. '
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: ' The read set source''s reference ARN. '
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: ' The name of the read set. '
description:
allOf:
- $ref: '#/components/schemas/ReadSetDescription'
- description: ' The description of the read set. '
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: ' The tags to add to the read set. '
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: ' The creation time of the multipart upload. '
CreateReferenceStoreResponse:
type: object
required:
- id
- arn
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ReferenceStoreId'
- description: The store's ID.
arn:
allOf:
- $ref: '#/components/schemas/ReferenceStoreArn'
- description: The store's ARN.
name:
allOf:
- $ref: '#/components/schemas/ReferenceStoreName'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/ReferenceStoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's SSE settings.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the store was created.
CreateRunGroupResponse:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/RunGroupArn'
- description: The group's ARN.
id:
allOf:
- $ref: '#/components/schemas/RunGroupId'
- description: The group's ID.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags for the run group.
CreateSequenceStoreResponse:
type: object
required:
- id
- arn
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The store's ID.
arn:
allOf:
- $ref: '#/components/schemas/SequenceStoreArn'
- description: The store's ARN.
name:
allOf:
- $ref: '#/components/schemas/SequenceStoreName'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/SequenceStoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's SSE settings.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the store was created.
fallbackLocation:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: ' An S3 location that is used to store files that have failed a direct upload. '
CreateVariantStoreResponse:
type: object
required:
- id
- status
- name
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The store's ID.
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The store's genome reference.
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The store's name.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the store was created.
CreateWorkflowResponse:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/WorkflowArn'
- description: The workflow's ARN.
id:
allOf:
- $ref: '#/components/schemas/WorkflowId'
- description: The workflow's ID.
status:
allOf:
- $ref: '#/components/schemas/WorkflowStatus'
- description: The workflow's status.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The workflow's tags.
WorkflowParameter:
type: object
properties:
description:
allOf:
- $ref: '#/components/schemas/WorkflowParameterDescription'
- description: The parameter's description.
optional:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the parameter is optional.
description: A workflow parameter.
DeleteAnnotationStoreResponse:
type: object
required:
- status
properties:
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
DeleteReferenceResponse:
type: object
properties: {}
DeleteReferenceStoreResponse:
type: object
properties: {}
DeleteSequenceStoreResponse:
type: object
properties: {}
DeleteVariantStoreResponse:
type: object
required:
- status
properties:
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
GetAnnotationImportResponse:
type: object
required:
- id
- destinationName
- roleArn
- status
- statusMessage
- creationTime
- updateTime
- completionTime
- items
- runLeftNormalization
- formatOptions
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The job's ID.
destinationName:
allOf:
- $ref: '#/components/schemas/StoreName'
- description: The job's destination annotation store.
roleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The job's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMsg'
- description: The job's status message.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the job was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the job was updated.
completionTime:
allOf:
- $ref: '#/components/schemas/CompletionTime'
- description: When the job completed.
items:
allOf:
- $ref: '#/components/schemas/AnnotationImportItemDetails'
- description: The job's imported items.
runLeftNormalization:
allOf:
- $ref: '#/components/schemas/RunLeftNormalization'
- description: The job's left normalization setting.
formatOptions:
$ref: '#/components/schemas/FormatOptions'
annotationFields:
allOf:
- $ref: '#/components/schemas/AnnotationFieldMap'
- description: ' The annotation schema generated by the parsed annotation data. '
GetAnnotationStoreResponse:
type: object
required:
- id
- reference
- status
- storeArn
- name
- description
- sseConfig
- creationTime
- updateTime
- tags
- statusMessage
- storeSizeBytes
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The store's ID.
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The store's genome reference.
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
storeArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The store's ARN.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's server-side encryption (SSE) settings.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the store was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the store was updated.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The store's tags.
storeOptions:
allOf:
- $ref: '#/components/schemas/StoreOptions'
- description: The store's parsing options.
storeFormat:
allOf:
- $ref: '#/components/schemas/StoreFormat'
- description: The store's annotation file format.
statusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: A status message.
storeSizeBytes:
allOf:
- $ref: '#/components/schemas/Long'
- description: The store's size in bytes.
GetReadSetResponse:
type: object
properties:
payload:
allOf:
- $ref: '#/components/schemas/ReadSetStreamingBlob'
- description: The read set file payload.
RangeNotSatisfiableException: {}
GetReadSetActivationJobResponse:
type: object
required:
- id
- sequenceStoreId
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ActivationJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The job's sequence store ID.
status:
allOf:
- $ref: '#/components/schemas/ReadSetActivationJobStatus'
- description: The job's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMessage'
- description: The job's status message.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
completionTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job completed.
sources:
allOf:
- $ref: '#/components/schemas/ActivateReadSetSourceList'
- description: The job's source files.
GetReadSetExportJobResponse:
type: object
required:
- id
- sequenceStoreId
- destination
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ExportJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The job's sequence store ID.
destination:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: The job's destination in Amazon S3.
status:
allOf:
- $ref: '#/components/schemas/ReadSetExportJobStatus'
- description: The job's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMessage'
- description: The job's status message.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
completionTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job completed.
readSets:
allOf:
- $ref: '#/components/schemas/ExportReadSetDetailList'
- description: The job's read sets.
GetReadSetImportJobResponse:
type: object
required:
- id
- sequenceStoreId
- roleArn
- status
- creationTime
- sources
properties:
id:
allOf:
- $ref: '#/components/schemas/ImportJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The job's sequence store ID.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/ReadSetImportJobStatus'
- description: The job's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMessage'
- description: The job's status message.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
completionTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job completed.
sources:
allOf:
- $ref: '#/components/schemas/ImportReadSetSourceList'
- description: The job's source files.
GetReadSetMetadataResponse:
type: object
required:
- id
- arn
- sequenceStoreId
- status
- fileType
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ReadSetId'
- description: The read set's ID.
arn:
allOf:
- $ref: '#/components/schemas/ReadSetArn'
- description: The read set's ARN.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The read set's sequence store ID.
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: The read set's subject ID.
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: The read set's sample ID.
status:
allOf:
- $ref: '#/components/schemas/ReadSetStatus'
- description: The read set's status.
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: The read set's name.
description:
allOf:
- $ref: '#/components/schemas/ReadSetDescription'
- description: The read set's description.
fileType:
allOf:
- $ref: '#/components/schemas/FileType'
- description: The read set's file type.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the read set was created.
sequenceInformation:
allOf:
- $ref: '#/components/schemas/SequenceInformation'
- description: The read set's sequence information.
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The read set's genome reference ARN.
files:
allOf:
- $ref: '#/components/schemas/ReadSetFiles'
- description: The read set's files.
statusMessage:
allOf:
- $ref: '#/components/schemas/ReadSetStatusMessage'
- description: ' The status message for a read set. It provides more detail as to why the read set has a status. '
creationType:
allOf:
- $ref: '#/components/schemas/CreationType'
- description: ' The creation type of the read set. '
GetReferenceResponse:
type: object
properties:
payload:
allOf:
- $ref: '#/components/schemas/ReferenceStreamingBlob'
- description: The reference file payload.
GetReferenceImportJobResponse:
type: object
required:
- id
- referenceStoreId
- roleArn
- status
- creationTime
- sources
properties:
id:
allOf:
- $ref: '#/components/schemas/ImportJobId'
- description: The job's ID.
referenceStoreId:
allOf:
- $ref: '#/components/schemas/ReferenceStoreId'
- description: The job's reference store ID.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/ReferenceImportJobStatus'
- description: The job's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMessage'
- description: The job's status message.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
completionTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job completed.
sources:
allOf:
- $ref: '#/components/schemas/ImportReferenceSourceList'
- description: The job's source files.
GetReferenceMetadataResponse:
type: object
required:
- id
- arn
- referenceStoreId
- md5
- creationTime
- updateTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ReferenceId'
- description: The reference's ID.
arn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The reference's ARN.
referenceStoreId:
allOf:
- $ref: '#/components/schemas/ReferenceStoreId'
- description: The reference's reference store ID.
md5:
allOf:
- $ref: '#/components/schemas/Md5'
- description: The reference's MD5 checksum.
status:
allOf:
- $ref: '#/components/schemas/ReferenceStatus'
- description: The reference's status.
name:
allOf:
- $ref: '#/components/schemas/ReferenceName'
- description: The reference's name.
description:
allOf:
- $ref: '#/components/schemas/ReferenceDescription'
- description: The reference's description.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the reference was created.
updateTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the reference was updated.
files:
allOf:
- $ref: '#/components/schemas/ReferenceFiles'
- description: The reference's files.
GetReferenceStoreResponse:
type: object
required:
- id
- arn
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ReferenceStoreId'
- description: The store's ID.
arn:
allOf:
- $ref: '#/components/schemas/ReferenceStoreArn'
- description: The store's ARN.
name:
allOf:
- $ref: '#/components/schemas/ReferenceStoreName'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/ReferenceStoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's server-side encryption (SSE) settings.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the store was created.
GetRunResponse:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/RunArn'
- description: The run's ARN.
id:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The run's ID.
status:
allOf:
- $ref: '#/components/schemas/RunStatus'
- description: The run's status.
workflowId:
allOf:
- $ref: '#/components/schemas/WorkflowId'
- description: The run's workflow ID.
workflowType:
allOf:
- $ref: '#/components/schemas/WorkflowType'
- description: The run's workflow type.
runId:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The run's ID.
roleArn:
allOf:
- $ref: '#/components/schemas/RunRoleArn'
- description: The run's service role ARN.
name:
allOf:
- $ref: '#/components/schemas/RunName'
- description: The run's name.
runGroupId:
allOf:
- $ref: '#/components/schemas/RunGroupId'
- description: The run's group ID.
priority:
allOf:
- $ref: '#/components/schemas/GetRunResponsePriorityInteger'
- description: The run's priority.
definition:
allOf:
- $ref: '#/components/schemas/WorkflowDefinition'
- description: The run's definition.
digest:
allOf:
- $ref: '#/components/schemas/WorkflowDigest'
- description: The run's digest.
parameters:
allOf:
- $ref: '#/components/schemas/RunParameters'
- description: The run's parameters.
storageCapacity:
allOf:
- $ref: '#/components/schemas/GetRunResponseStorageCapacityInteger'
- description: The run's storage capacity in gigabytes.
outputUri:
allOf:
- $ref: '#/components/schemas/RunOutputUri'
- description: The run's output URI.
logLevel:
allOf:
- $ref: '#/components/schemas/RunLogLevel'
- description: The run's log level.
resourceDigests:
allOf:
- $ref: '#/components/schemas/RunResourceDigests'
- description: The run's resource digests.
startedBy:
allOf:
- $ref: '#/components/schemas/RunStartedBy'
- description: Who started the run.
creationTime:
allOf:
- $ref: '#/components/schemas/RunTimestamp'
- description: When the run was created.
startTime:
allOf:
- $ref: '#/components/schemas/RunTimestamp'
- description: When the run started.
stopTime:
allOf:
- $ref: '#/components/schemas/RunTimestamp'
- description: The run's stop time.
statusMessage:
allOf:
- $ref: '#/components/schemas/RunStatusMessage'
- description: The run's status message.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The run's tags.
accelerators:
allOf:
- $ref: '#/components/schemas/Accelerators'
- description: ' The computational accelerator used to run the workflow. '
RunExport:
type: string
enum:
- DEFINITION
minLength: 1
maxLength: 64
GetRunGroupResponse:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/RunGroupArn'
- description: The group's ARN.
id:
allOf:
- $ref: '#/components/schemas/RunGroupId'
- description: The group's ID.
name:
allOf:
- $ref: '#/components/schemas/RunGroupName'
- description: The group's name.
maxCpus:
allOf:
- $ref: '#/components/schemas/GetRunGroupResponseMaxCpusInteger'
- description: The group's maximum number of CPUs to use.
maxRuns:
allOf:
- $ref: '#/components/schemas/GetRunGroupResponseMaxRunsInteger'
- description: The maximum number of concurrent runs for the group.
maxDuration:
allOf:
- $ref: '#/components/schemas/GetRunGroupResponseMaxDurationInteger'
- description: The group's maximum run time in minutes.
creationTime:
allOf:
- $ref: '#/components/schemas/RunGroupTimestamp'
- description: When the group was created.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The group's tags.
maxGpus:
allOf:
- $ref: '#/components/schemas/GetRunGroupResponseMaxGpusInteger'
- description: ' The maximum GPUs that can be used by a run group. '
GetRunTaskResponse:
type: object
properties:
taskId:
allOf:
- $ref: '#/components/schemas/TaskId'
- description: The task's ID.
status:
allOf:
- $ref: '#/components/schemas/TaskStatus'
- description: The task's status.
name:
allOf:
- $ref: '#/components/schemas/TaskName'
- description: The task's name.
cpus:
allOf:
- $ref: '#/components/schemas/GetRunTaskResponseCpusInteger'
- description: The task's CPU usage.
memory:
allOf:
- $ref: '#/components/schemas/GetRunTaskResponseMemoryInteger'
- description: The task's memory use in gigabytes.
creationTime:
allOf:
- $ref: '#/components/schemas/TaskTimestamp'
- description: When the task was created.
startTime:
allOf:
- $ref: '#/components/schemas/TaskTimestamp'
- description: The task's start time.
stopTime:
allOf:
- $ref: '#/components/schemas/TaskTimestamp'
- description: The task's stop time.
statusMessage:
allOf:
- $ref: '#/components/schemas/TaskStatusMessage'
- description: The task's status message.
logStream:
allOf:
- $ref: '#/components/schemas/TaskLogStream'
- description: The task's log stream.
gpus:
allOf:
- $ref: '#/components/schemas/GetRunTaskResponseGpusInteger'
- description: ' The number of Graphics Processing Units (GPU) specified in the task. '
GetSequenceStoreResponse:
type: object
required:
- id
- arn
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The store's ID.
arn:
allOf:
- $ref: '#/components/schemas/SequenceStoreArn'
- description: The store's ARN.
name:
allOf:
- $ref: '#/components/schemas/SequenceStoreName'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/SequenceStoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's server-side encryption (SSE) settings.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the store was created.
fallbackLocation:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: ' An S3 location that is used to store files that have failed a direct upload. '
GetVariantImportResponse:
type: object
required:
- id
- destinationName
- roleArn
- status
- statusMessage
- creationTime
- updateTime
- items
- runLeftNormalization
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The job's ID.
destinationName:
allOf:
- $ref: '#/components/schemas/StoreName'
- description: The job's destination variant store.
roleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The job's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMsg'
- description: The job's status message.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the job was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the job was updated.
completionTime:
allOf:
- $ref: '#/components/schemas/CompletionTime'
- description: When the job completed.
items:
allOf:
- $ref: '#/components/schemas/VariantImportItemDetails'
- description: The job's items.
runLeftNormalization:
allOf:
- $ref: '#/components/schemas/RunLeftNormalization'
- description: The job's left normalization setting.
annotationFields:
allOf:
- $ref: '#/components/schemas/AnnotationFieldMap'
- description: ' The annotation schema generated by the parsed annotation data. '
GetVariantStoreResponse:
type: object
required:
- id
- reference
- status
- storeArn
- name
- description
- sseConfig
- creationTime
- updateTime
- tags
- statusMessage
- storeSizeBytes
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The store's ID.
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The store's genome reference.
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
storeArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The store's ARN.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's server-side encryption (SSE) settings.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the store was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the store was updated.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The store's tags.
statusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: The store's status message.
storeSizeBytes:
allOf:
- $ref: '#/components/schemas/Long'
- description: The store's size in bytes.
GetWorkflowResponse:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/WorkflowArn'
- description: The workflow's ARN.
id:
allOf:
- $ref: '#/components/schemas/WorkflowId'
- description: The workflow's ID.
status:
allOf:
- $ref: '#/components/schemas/WorkflowStatus'
- description: The workflow's status.
type:
allOf:
- $ref: '#/components/schemas/WorkflowType'
- description: The workflow's type.
name:
allOf:
- $ref: '#/components/schemas/WorkflowName'
- description: The workflow's name.
description:
allOf:
- $ref: '#/components/schemas/WorkflowDescription'
- description: The workflow's description.
engine:
allOf:
- $ref: '#/components/schemas/WorkflowEngine'
- description: The workflow's engine.
definition:
allOf:
- $ref: '#/components/schemas/WorkflowDefinition'
- description: The workflow's definition.
main:
allOf:
- $ref: '#/components/schemas/WorkflowMain'
- description: The path of the main definition file for the workflow.
digest:
allOf:
- $ref: '#/components/schemas/WorkflowDigest'
- description: The workflow's digest.
parameterTemplate:
allOf:
- $ref: '#/components/schemas/WorkflowParameterTemplate'
- description: The workflow's parameter template.
storageCapacity:
allOf:
- $ref: '#/components/schemas/GetWorkflowResponseStorageCapacityInteger'
- description: The workflow's storage capacity in gigabytes.
creationTime:
allOf:
- $ref: '#/components/schemas/WorkflowTimestamp'
- description: When the workflow was created.
statusMessage:
allOf:
- $ref: '#/components/schemas/WorkflowStatusMessage'
- description: The workflow's status message.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The workflow's tags.
metadata:
allOf:
- $ref: '#/components/schemas/WorkflowMetadata'
- description: ' Gets metadata for workflow. '
accelerators:
allOf:
- $ref: '#/components/schemas/Accelerators'
- description: ' The computational accelerator specified to run the workflow. '
WorkflowExport:
type: string
enum:
- DEFINITION
minLength: 1
maxLength: 64
ListAnnotationImportJobsResponse:
type: object
properties:
annotationImportJobs:
allOf:
- $ref: '#/components/schemas/AnnotationImportJobItems'
- description: A list of jobs.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A pagination token that's included if more results are available.
ResourceIdentifier:
type: string
minLength: 1
maxLength: 50
JobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- CANCELLED
- COMPLETED
- FAILED
- COMPLETED_WITH_FAILURES
String:
type: string
ListAnnotationStoresResponse:
type: object
properties:
annotationStores:
allOf:
- $ref: '#/components/schemas/AnnotationStoreItems'
- description: A list of stores.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A pagination token that's included if more results are available.
StoreStatus:
type: string
enum:
- CREATING
- UPDATING
- DELETING
- ACTIVE
- FAILED
ListMultipartReadSetUploadsResponse:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: ' Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results. '
uploads:
allOf:
- $ref: '#/components/schemas/MultipartReadSetUploadList'
- description: ' An array of multipart uploads. '
ListReadSetActivationJobsResponse:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A pagination token that's included if more results are available.
activationJobs:
allOf:
- $ref: '#/components/schemas/ActivateReadSetJobList'
- description: A list of jobs.
ReadSetActivationJobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- CANCELLING
- CANCELLED
- FAILED
- COMPLETED
- COMPLETED_WITH_FAILURES
SyntheticTimestamp_date_time:
type: string
format: date-time
ListReadSetExportJobsResponse:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A pagination token that's included if more results are available.
exportJobs:
allOf:
- $ref: '#/components/schemas/ExportReadSetJobDetailList'
- description: A list of jobs.
ReadSetExportJobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- CANCELLING
- CANCELLED
- FAILED
- COMPLETED
- COMPLETED_WITH_FAILURES
ListReadSetImportJobsResponse:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A pagination token that's included if more results are available.
importJobs:
allOf:
- $ref: '#/components/schemas/ImportReadSetJobList'
- description: A list of jobs.
ReadSetImportJobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- CANCELLING
- CANCELLED
- FAILED
- COMPLETED
- COMPLETED_WITH_FAILURES
ListReadSetUploadPartsResponse:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: ' Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results. '
parts:
allOf:
- $ref: '#/components/schemas/ReadSetUploadPartList'
- description: ' An array of upload parts. '
ListReadSetsResponse:
type: object
required:
- readSets
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A pagination token that's included if more results are available.
readSets:
allOf:
- $ref: '#/components/schemas/ReadSetList'
- description: A list of read sets.
ReadSetName:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
ReadSetStatus:
type: string
enum:
- ARCHIVED
- ACTIVATING
- ACTIVE
- DELETING
- DELETED
- PROCESSING_UPLOAD
- UPLOAD_FAILED
SampleId:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
SubjectId:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
GeneratedFrom:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
CreationType:
type: string
enum:
- IMPORT
- UPLOAD
ListReferenceImportJobsResponse:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A pagination token that's included if more results are available.
importJobs:
allOf:
- $ref: '#/components/schemas/ImportReferenceJobList'
- description: A lis of jobs.
ReferenceImportJobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- CANCELLING
- CANCELLED
- FAILED
- COMPLETED
- COMPLETED_WITH_FAILURES
ListReferenceStoresResponse:
type: object
required:
- referenceStores
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A pagination token that's included if more results are available.
referenceStores:
allOf:
- $ref: '#/components/schemas/ReferenceStoreDetailList'
- description: A list of reference stores.
ReferenceStoreName:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
ListReferencesResponse:
type: object
required:
- references
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A pagination token that's included if more results are available.
references:
allOf:
- $ref: '#/components/schemas/ReferenceList'
- description: A list of references.
ReferenceName:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 3
maxLength: 255
Md5:
type: string
pattern: '[\p{L}||\p{N}]+'
minLength: 1
maxLength: 255
ListRunGroupsResponse:
type: object
properties:
items:
allOf:
- $ref: '#/components/schemas/RunGroupList'
- description: A list of groups.
nextToken:
allOf:
- $ref: '#/components/schemas/RunGroupListToken'
- description: A pagination token that's included if more results are available.
ListRunTasksResponse:
type: object
properties:
items:
allOf:
- $ref: '#/components/schemas/TaskList'
- description: A list of tasks.
nextToken:
allOf:
- $ref: '#/components/schemas/TaskListToken'
- description: A pagination token that's included if more results are available.
ListRunsResponse:
type: object
properties:
items:
allOf:
- $ref: '#/components/schemas/RunList'
- description: A list of runs.
nextToken:
allOf:
- $ref: '#/components/schemas/RunListToken'
- description: A pagination token that's included if more results are available.
ListSequenceStoresResponse:
type: object
required:
- sequenceStores
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A pagination token that's included if more results are available.
sequenceStores:
allOf:
- $ref: '#/components/schemas/SequenceStoreDetailList'
- description: A list of sequence stores.
SequenceStoreName:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
ListTagsForResourceResponse:
type: object
required:
- tags
properties:
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: A list of tags.
ListVariantImportJobsResponse:
type: object
properties:
variantImportJobs:
allOf:
- $ref: '#/components/schemas/VariantImportJobItems'
- description: A list of jobs.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A pagination token that's included if more results are available.
ListVariantStoresResponse:
type: object
properties:
variantStores:
allOf:
- $ref: '#/components/schemas/VariantStoreItems'
- description: A list of variant stores.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A pagination token that's included if more results are available.
ListWorkflowsResponse:
type: object
properties:
items:
allOf:
- $ref: '#/components/schemas/WorkflowList'
- description: The workflows' items.
nextToken:
allOf:
- $ref: '#/components/schemas/WorkflowListToken'
- description: A pagination token that's included if more results are available.
StartAnnotationImportResponse:
type: object
required:
- jobId
properties:
jobId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The job's ID.
AnnotationImportItemSource:
type: object
required:
- source
properties:
source:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The source file's location in Amazon S3.
description: A source for an annotation import job.
TsvOptions:
type: object
properties:
readOptions:
allOf:
- $ref: '#/components/schemas/ReadOptions'
- description: The file's read options.
description: Formatting options for a TSV file.
VcfOptions:
type: object
properties:
ignoreQualField:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: The file's ignore qual field setting.
ignoreFilterField:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: The file's ignore filter field setting.
description: Formatting options for a VCF file.
AnnotationFieldMapValueString:
type: string
minLength: 1
maxLength: 21
StartReadSetActivationJobResponse:
type: object
required:
- id
- sequenceStoreId
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ActivationJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The read set's sequence store ID.
status:
allOf:
- $ref: '#/components/schemas/ReadSetActivationJobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
StartReadSetActivationJobSourceItem:
type: object
required:
- readSetId
properties:
readSetId:
allOf:
- $ref: '#/components/schemas/ReadSetId'
- description: The source's read set ID.
description: A source for a read set activation job.
StartReadSetExportJobResponse:
type: object
required:
- id
- sequenceStoreId
- destination
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ExportJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The read set's sequence store ID.
destination:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: The job's output location.
status:
allOf:
- $ref: '#/components/schemas/ReadSetExportJobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
ExportReadSet:
type: object
required:
- readSetId
properties:
readSetId:
allOf:
- $ref: '#/components/schemas/ReadSetId'
- description: The set's ID.
description: A read set.
StartReadSetImportJobResponse:
type: object
required:
- id
- sequenceStoreId
- roleArn
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ImportJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The read set's sequence store ID.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/ReadSetImportJobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
StartReadSetImportJobSourceItem:
type: object
required:
- sourceFiles
- sourceFileType
- subjectId
- sampleId
- referenceArn
properties:
sourceFiles:
allOf:
- $ref: '#/components/schemas/SourceFiles'
- description: The source files' location in Amazon S3.
sourceFileType:
allOf:
- $ref: '#/components/schemas/FileType'
- description: The source's file type.
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: The source's subject ID.
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: The source's sample ID.
generatedFrom:
allOf:
- $ref: '#/components/schemas/GeneratedFrom'
- description: Where the source originated.
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The source's reference ARN.
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: The source's name.
description:
allOf:
- $ref: '#/components/schemas/ReadSetDescription'
- description: The source's description.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The source's tags.
description: A source for a read set import job.
StartReferenceImportJobResponse:
type: object
required:
- id
- referenceStoreId
- roleArn
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ImportJobId'
- description: The job's ID.
referenceStoreId:
allOf:
- $ref: '#/components/schemas/ReferenceStoreId'
- description: The job's reference store ID.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/ReferenceImportJobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
StartReferenceImportJobSourceItem:
type: object
required:
- sourceFile
- name
properties:
sourceFile:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The source file's location in Amazon S3.
name:
allOf:
- $ref: '#/components/schemas/ReferenceName'
- description: The source's name.
description:
allOf:
- $ref: '#/components/schemas/ReferenceDescription'
- description: The source's description.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The source's tags.
description: A source for a reference import job.
StartRunResponse:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/RunArn'
- description: The run's ARN.
id:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The run's ID.
status:
allOf:
- $ref: '#/components/schemas/RunStatus'
- description: The run's status.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The run's tags.
StartVariantImportResponse:
type: object
required:
- jobId
properties:
jobId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The job's ID.
VariantImportItemSource:
type: object
required:
- source
properties:
source:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The source file's location in Amazon S3.
description: A imported variant item's source.
TagResourceResponse:
type: object
properties: {}
UntagResourceResponse:
type: object
properties: {}
TagKey:
type: string
minLength: 1
maxLength: 128
UpdateAnnotationStoreResponse:
type: object
required:
- id
- reference
- status
- name
- description
- creationTime
- updateTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The store's ID.
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The store's genome reference.
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: The store's description.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the store was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the store was updated.
storeOptions:
allOf:
- $ref: '#/components/schemas/StoreOptions'
- description: Parsing options for the store.
storeFormat:
allOf:
- $ref: '#/components/schemas/StoreFormat'
- description: The annotation file format of the store.
UpdateVariantStoreResponse:
type: object
required:
- id
- reference
- status
- name
- description
- creationTime
- updateTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The store's ID.
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The store's genome reference.
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: The store's description.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the store was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the store was updated.
UploadReadSetPartResponse:
type: object
required:
- checksum
properties:
checksum:
allOf:
- $ref: '#/components/schemas/String'
- description: ' An identifier used to confirm that parts are being added to the intended upload. '
SequenceStoreId:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
UploadId:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
AbortMultipartReadSetUploadRequest:
type: object
title: AbortMultipartReadSetUploadRequest
properties: {}
Accelerators:
type: string
enum:
- GPU
minLength: 1
maxLength: 64
ActivateReadSetFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReadSetActivationJobStatus'
- description: The filter's status.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
description: A read set activation job filter.
ActivationJobId:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
ActivateReadSetJobItem:
type: object
required:
- id
- sequenceStoreId
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ActivationJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The job's sequence store ID.
status:
allOf:
- $ref: '#/components/schemas/ReadSetActivationJobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
completionTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job completed.
description: A read set activation job.
ActivateReadSetJobList:
type: array
items:
$ref: '#/components/schemas/ActivateReadSetJobItem'
ReadSetActivationJobItemStatus:
type: string
enum:
- NOT_STARTED
- IN_PROGRESS
- FINISHED
- FAILED
JobStatusMessage:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
ActivateReadSetSourceItem:
type: object
required:
- readSetId
- status
properties:
readSetId:
allOf:
- $ref: '#/components/schemas/ReadSetId'
- description: The source's read set ID.
status:
allOf:
- $ref: '#/components/schemas/ReadSetActivationJobItemStatus'
- description: The source's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMessage'
- description: The source's status message.
description: A source for a read set activation job.
ActivateReadSetSourceList:
type: array
items:
$ref: '#/components/schemas/ActivateReadSetSourceItem'
AnnotationFieldMap:
type: object
additionalProperties:
$ref: '#/components/schemas/AnnotationFieldMapValueString'
AnnotationFieldMapKeyString:
type: string
minLength: 1
maxLength: 21
S3Uri:
type: string
pattern: 's3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/(.{1,1024})'
AnnotationImportItemDetail:
type: object
required:
- source
- jobStatus
properties:
source:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The source file's location in Amazon S3.
jobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The item's job status.
description: Details about an imported annotation item.
AnnotationImportItemDetails:
type: array
items:
$ref: '#/components/schemas/AnnotationImportItemDetail'
minItems: 1
maxItems: 1
AnnotationImportItemSources:
type: array
items:
$ref: '#/components/schemas/AnnotationImportItemSource'
minItems: 1
Arn:
type: string
pattern: 'arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)'
minLength: 20
maxLength: 2048
CreationTime:
type: string
format: date-time
UpdateTime:
type: string
format: date-time
CompletionTime:
type: string
format: date-time
RunLeftNormalization:
type: boolean
AnnotationImportJobItem:
type: object
required:
- id
- destinationName
- roleArn
- status
- creationTime
- updateTime
properties:
id:
allOf:
- $ref: '#/components/schemas/String'
- description: The job's ID.
destinationName:
allOf:
- $ref: '#/components/schemas/String'
- description: The job's destination annotation store.
roleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the job was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the job was updated.
completionTime:
allOf:
- $ref: '#/components/schemas/CompletionTime'
- description: When the job completed.
runLeftNormalization:
allOf:
- $ref: '#/components/schemas/RunLeftNormalization'
- description: The job's left normalization setting.
annotationFields:
allOf:
- $ref: '#/components/schemas/AnnotationFieldMap'
- description: ' The annotation schema generated by the parsed annotation data. '
description: An annotation import job.
AnnotationImportJobItems:
type: array
items:
$ref: '#/components/schemas/AnnotationImportJobItem'
ResourceId:
type: string
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
ReferenceItem:
type: object
properties:
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The reference's ARN.
description: A genome reference.
StoreFormat:
type: string
enum:
- GFF
- TSV
- VCF
StoreDescription:
type: string
minLength: 0
maxLength: 500
SseConfig:
type: object
required:
- type
properties:
type:
allOf:
- $ref: '#/components/schemas/EncryptionType'
- description: The encryption type.
keyArn:
allOf:
- $ref: '#/components/schemas/SseConfigKeyArnString'
- description: An encryption key ARN.
description: Server-side encryption (SSE) settings for a store.
StatusMessage:
type: string
minLength: 0
maxLength: 1000
Long:
type: integer
AnnotationStoreItem:
type: object
required:
- id
- reference
- status
- storeArn
- name
- storeFormat
- description
- sseConfig
- creationTime
- updateTime
- statusMessage
- storeSizeBytes
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The store's ID.
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The store's genome reference.
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
storeArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The store's ARN.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The store's name.
storeFormat:
allOf:
- $ref: '#/components/schemas/StoreFormat'
- description: The store's file format.
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's server-side encryption (SSE) settings.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: The store's creation time.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the store was updated.
statusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: The store's status message.
storeSizeBytes:
allOf:
- $ref: '#/components/schemas/Long'
- description: The store's size in bytes.
description: An annotation store.
AnnotationStoreItems:
type: array
items:
$ref: '#/components/schemas/AnnotationStoreItem'
AnnotationType:
type: string
enum:
- GENERIC
- CHR_POS
- CHR_POS_REF_ALT
- CHR_START_END_ONE_BASE
- CHR_START_END_REF_ALT_ONE_BASE
- CHR_START_END_ZERO_BASE
- CHR_START_END_REF_ALT_ZERO_BASE
ReadSetIdList:
type: array
items:
$ref: '#/components/schemas/ReadSetId'
minItems: 1
maxItems: 100
BatchDeleteReadSetRequest:
type: object
required:
- ids
title: BatchDeleteReadSetRequest
properties:
ids:
allOf:
- $ref: '#/components/schemas/ReadSetIdList'
- description: The read sets' IDs.
ReadSetBatchErrorList:
type: array
items:
$ref: '#/components/schemas/ReadSetBatchError'
Blob:
type: string
Boolean:
type: boolean
CancelAnnotationImportRequest:
type: object
title: CancelAnnotationImportRequest
properties: {}
RunId:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
CancelRunRequest:
type: object
title: CancelRunRequest
properties: {}
CancelVariantImportRequest:
type: object
title: CancelVariantImportRequest
properties: {}
ClientToken:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
CommentChar:
type: string
minLength: 1
maxLength: 1
CompleteReadSetUploadPartList:
type: array
items:
$ref: '#/components/schemas/CompleteReadSetUploadPartListItem'
CompleteMultipartReadSetUploadRequest:
type: object
required:
- parts
title: CompleteMultipartReadSetUploadRequest
properties:
parts:
allOf:
- $ref: '#/components/schemas/CompleteReadSetUploadPartList'
- description: ' The individual uploads or parts of a multipart upload. '
CompleteReadSetUploadPartListItemPartNumberInteger:
type: integer
minimum: 1
maximum: 10000
ReadSetPartSource:
type: string
enum:
- SOURCE1
- SOURCE2
CreateAnnotationStoreRequestNameString:
type: string
pattern: '([a-z]){1}([a-z0-9_]){2,254}'
TagMap:
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
StoreOptions:
type: object
properties:
tsvStoreOptions:
allOf:
- $ref: '#/components/schemas/TsvStoreOptions'
- description: File settings for a TSV store.
description: Settings for a store.
CreateAnnotationStoreRequest:
type: object
required:
- storeFormat
title: CreateAnnotationStoreRequest
properties:
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The genome reference for the store's annotations.
name:
allOf:
- $ref: '#/components/schemas/CreateAnnotationStoreRequestNameString'
- description: A name for the store.
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: A description for the store.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags for the store.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: Server-side encryption (SSE) settings for the store.
storeFormat:
allOf:
- $ref: '#/components/schemas/StoreFormat'
- description: The annotation file format of the store.
storeOptions:
allOf:
- $ref: '#/components/schemas/StoreOptions'
- description: File parsing options for the annotation store.
FileType:
type: string
enum:
- FASTQ
- BAM
- CRAM
ReadSetDescription:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 255
CreateMultipartReadSetUploadRequest:
type: object
required:
- sourceFileType
- subjectId
- sampleId
- referenceArn
- name
title: CreateMultipartReadSetUploadRequest
properties:
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: ' An idempotency token that can be used to avoid triggering multiple multipart uploads. '
sourceFileType:
allOf:
- $ref: '#/components/schemas/FileType'
- description: ' The type of file being uploaded. '
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: ' The source''s subject ID. '
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: ' The source''s sample ID. '
generatedFrom:
allOf:
- $ref: '#/components/schemas/GeneratedFrom'
- description: ' Where the source originated. '
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: ' The ARN of the reference. '
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: ' The name of the read set. '
description:
allOf:
- $ref: '#/components/schemas/ReadSetDescription'
- description: ' The description of the read set. '
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: ' Any tags to add to the read set. '
ReferenceStoreDescription:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 255
CreateReferenceStoreRequest:
type: object
required:
- name
title: CreateReferenceStoreRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/ReferenceStoreName'
- description: A name for the store.
description:
allOf:
- $ref: '#/components/schemas/ReferenceStoreDescription'
- description: A description for the store.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: Server-side encryption (SSE) settings for the store.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags for the store.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 'To ensure that requests don''t run multiple times, specify a unique token for each request.'
ReferenceStoreId:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
ReferenceStoreArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 127
RunGroupName:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
CreateRunGroupRequestMaxCpusInteger:
type: integer
minimum: 1
maximum: 100000
CreateRunGroupRequestMaxRunsInteger:
type: integer
minimum: 1
maximum: 100000
CreateRunGroupRequestMaxDurationInteger:
type: integer
minimum: 1
maximum: 100000
RunGroupRequestId:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
CreateRunGroupRequestMaxGpusInteger:
type: integer
minimum: 1
maximum: 100000
CreateRunGroupRequest:
type: object
required:
- requestId
title: CreateRunGroupRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/RunGroupName'
- description: A name for the group.
maxCpus:
allOf:
- $ref: '#/components/schemas/CreateRunGroupRequestMaxCpusInteger'
- description: The maximum number of CPUs to use in the group.
maxRuns:
allOf:
- $ref: '#/components/schemas/CreateRunGroupRequestMaxRunsInteger'
- description: The maximum number of concurrent runs for the group.
maxDuration:
allOf:
- $ref: '#/components/schemas/CreateRunGroupRequestMaxDurationInteger'
- description: A maximum run time for the group in minutes.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags for the group.
requestId:
allOf:
- $ref: '#/components/schemas/RunGroupRequestId'
- description: 'To ensure that requests don''t run multiple times, specify a unique ID for each request.'
maxGpus:
allOf:
- $ref: '#/components/schemas/CreateRunGroupRequestMaxGpusInteger'
- description: ' The maximum GPUs that can be used by a run group. '
RunGroupArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
RunGroupId:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
SequenceStoreDescription:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 255
S3Destination:
type: string
pattern: 's3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?'
CreateSequenceStoreRequest:
type: object
required:
- name
title: CreateSequenceStoreRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/SequenceStoreName'
- description: A name for the store.
description:
allOf:
- $ref: '#/components/schemas/SequenceStoreDescription'
- description: A description for the store.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: Server-side encryption (SSE) settings for the store.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags for the store.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 'To ensure that requests don''t run multiple times, specify a unique token for each request.'
fallbackLocation:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: ' An S3 location that is used to store files that have failed a direct upload. '
SequenceStoreArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 127
CreateVariantStoreRequestNameString:
type: string
pattern: '([a-z]){1}([a-z0-9_]){2,254}'
CreateVariantStoreRequest:
type: object
required:
- reference
title: CreateVariantStoreRequest
properties:
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The genome reference for the store's variants.
name:
allOf:
- $ref: '#/components/schemas/CreateVariantStoreRequestNameString'
- description: A name for the store.
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: A description for the store.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags for the store.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: Server-side encryption (SSE) settings for the store.
WorkflowName:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
WorkflowDescription:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 256
WorkflowEngine:
type: string
enum:
- WDL
- NEXTFLOW
- CWL
minLength: 1
maxLength: 64
WorkflowDefinition:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 256
WorkflowMain:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
WorkflowParameterTemplate:
type: object
minProperties: 1
maxProperties: 1000
additionalProperties:
$ref: '#/components/schemas/WorkflowParameter'
CreateWorkflowRequestStorageCapacityInteger:
type: integer
minimum: 0
maximum: 100000
WorkflowRequestId:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
CreateWorkflowRequest:
type: object
required:
- requestId
title: CreateWorkflowRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/WorkflowName'
- description: A name for the workflow.
description:
allOf:
- $ref: '#/components/schemas/WorkflowDescription'
- description: A description for the workflow.
engine:
allOf:
- $ref: '#/components/schemas/WorkflowEngine'
- description: An engine for the workflow.
definitionZip:
allOf:
- $ref: '#/components/schemas/Blob'
- description: A ZIP archive for the workflow.
definitionUri:
allOf:
- $ref: '#/components/schemas/WorkflowDefinition'
- description: The URI of a definition for the workflow.
main:
allOf:
- $ref: '#/components/schemas/WorkflowMain'
- description: The path of the main definition file for the workflow.
parameterTemplate:
allOf:
- $ref: '#/components/schemas/WorkflowParameterTemplate'
- description: A parameter template for the workflow.
storageCapacity:
allOf:
- $ref: '#/components/schemas/CreateWorkflowRequestStorageCapacityInteger'
- description: A storage capacity for the workflow in gigabytes.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags for the workflow.
requestId:
allOf:
- $ref: '#/components/schemas/WorkflowRequestId'
- description: 'To ensure that requests don''t run multiple times, specify a unique ID for each request.'
accelerators:
allOf:
- $ref: '#/components/schemas/Accelerators'
- description: ' The computational accelerator specified to run the workflow. '
WorkflowArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
WorkflowId:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
WorkflowStatus:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETED
- FAILED
- INACTIVE
minLength: 1
maxLength: 64
PrimitiveBoolean:
type: boolean
DeleteAnnotationStoreRequest:
type: object
title: DeleteAnnotationStoreRequest
properties: {}
ReferenceId:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
DeleteReferenceRequest:
type: object
title: DeleteReferenceRequest
properties: {}
DeleteReferenceStoreRequest:
type: object
title: DeleteReferenceStoreRequest
properties: {}
DeleteRunGroupRequest:
type: object
title: DeleteRunGroupRequest
properties: {}
DeleteRunRequest:
type: object
title: DeleteRunRequest
properties: {}
DeleteSequenceStoreRequest:
type: object
title: DeleteSequenceStoreRequest
properties: {}
DeleteVariantStoreRequest:
type: object
title: DeleteVariantStoreRequest
properties: {}
DeleteWorkflowRequest:
type: object
title: DeleteWorkflowRequest
properties: {}
Encoding:
type: string
minLength: 1
maxLength: 20
EscapeChar:
type: string
minLength: 1
maxLength: 1
EscapeQuotes:
type: boolean
ExportJobId:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
ReadSetExportJobItemStatus:
type: string
enum:
- NOT_STARTED
- IN_PROGRESS
- FINISHED
- FAILED
ExportReadSetDetail:
type: object
required:
- id
- status
properties:
id:
allOf:
- $ref: '#/components/schemas/ReadSetId'
- description: The set's ID.
status:
allOf:
- $ref: '#/components/schemas/ReadSetExportJobItemStatus'
- description: The set's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMessage'
- description: The set's status message.
description: Details about a read set.
ExportReadSetDetailList:
type: array
items:
$ref: '#/components/schemas/ExportReadSetDetail'
ExportReadSetFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReadSetExportJobStatus'
- description: A status to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
description: An read set export job filter.
ExportReadSetJobDetail:
type: object
required:
- id
- sequenceStoreId
- destination
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ExportJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The job's sequence store ID.
destination:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: The job's destination in Amazon S3.
status:
allOf:
- $ref: '#/components/schemas/ReadSetExportJobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
completionTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job completed.
description: Details about a read set export job.
ExportReadSetJobDetailList:
type: array
items:
$ref: '#/components/schemas/ExportReadSetJobDetail'
FileInformationTotalPartsInteger:
type: integer
minimum: 1
maximum: 10000
FileInformationPartSizeLong:
type: integer
minimum: 1
maximum: 5368709120
FileInformationContentLengthLong:
type: integer
minimum: 1
maximum: 5497558138880
FileInformation:
type: object
properties:
totalParts:
allOf:
- $ref: '#/components/schemas/FileInformationTotalPartsInteger'
- description: The file's total parts.
partSize:
allOf:
- $ref: '#/components/schemas/FileInformationPartSizeLong'
- description: The file's part size.
contentLength:
allOf:
- $ref: '#/components/schemas/FileInformationContentLengthLong'
- description: The file's content length.
description: Details about a file.
FormatOptions:
type: object
properties:
tsvOptions:
allOf:
- $ref: '#/components/schemas/TsvOptions'
- description: Options for a TSV file.
vcfOptions:
allOf:
- $ref: '#/components/schemas/VcfOptions'
- description: Options for a VCF file.
description: Formatting options for a file.
FormatToHeaderValueString:
type: string
minLength: 0
maxLength: 1000
FormatToHeader:
type: object
additionalProperties:
$ref: '#/components/schemas/FormatToHeaderValueString'
FormatToHeaderKey:
type: string
enum:
- CHR
- START
- END
- REF
- ALT
- POS
GetAnnotationImportRequest:
type: object
title: GetAnnotationImportRequest
properties: {}
StoreName:
type: string
pattern: '([a-z]){1}([a-z0-9_]){2,254}'
minLength: 3
maxLength: 255
JobStatusMsg:
type: string
GetAnnotationStoreRequest:
type: object
title: GetAnnotationStoreRequest
properties: {}
GetReadSetActivationJobRequest:
type: object
title: GetReadSetActivationJobRequest
properties: {}
GetReadSetExportJobRequest:
type: object
title: GetReadSetExportJobRequest
properties: {}
ImportJobId:
type: string
pattern: '[0-9]+'
minLength: 10
maxLength: 36
GetReadSetImportJobRequest:
type: object
title: GetReadSetImportJobRequest
properties: {}
RoleArn:
type: string
pattern: 'arn:.*'
minLength: 20
maxLength: 2048
ImportReadSetSourceList:
type: array
items:
$ref: '#/components/schemas/ImportReadSetSourceItem'
GetReadSetMetadataRequest:
type: object
title: GetReadSetMetadataRequest
properties: {}
ReadSetArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 127
SequenceInformation:
type: object
properties:
totalReadCount:
allOf:
- $ref: '#/components/schemas/Long'
- description: The sequence's total read count.
totalBaseCount:
allOf:
- $ref: '#/components/schemas/Long'
- description: The sequence's total base count.
generatedFrom:
allOf:
- $ref: '#/components/schemas/GeneratedFrom'
- description: Where the sequence originated.
alignment:
allOf:
- $ref: '#/components/schemas/String'
- description: The sequence's alignment setting.
description: Details about a sequence.
ReadSetFiles:
type: object
properties:
source1:
allOf:
- $ref: '#/components/schemas/FileInformation'
- description: The location of the first file in Amazon S3.
source2:
allOf:
- $ref: '#/components/schemas/FileInformation'
- description: The location of the second file in Amazon S3.
index:
allOf:
- $ref: '#/components/schemas/FileInformation'
- description: The files' index.
description: Files in a read set.
ReadSetStatusMessage:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 255
ReadSetFile:
type: string
enum:
- SOURCE1
- SOURCE2
- INDEX
GetReadSetRequestPartNumberInteger:
type: integer
minimum: 1
maximum: 10000
GetReadSetRequest:
type: object
title: GetReadSetRequest
properties: {}
ReadSetStreamingBlob:
type: string
GetReferenceImportJobRequest:
type: object
title: GetReferenceImportJobRequest
properties: {}
ImportReferenceSourceList:
type: array
items:
$ref: '#/components/schemas/ImportReferenceSourceItem'
GetReferenceMetadataRequest:
type: object
title: GetReferenceMetadataRequest
properties: {}
ReferenceStatus:
type: string
enum:
- ACTIVE
- DELETING
- DELETED
ReferenceDescription:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 255
ReferenceFiles:
type: object
properties:
source:
allOf:
- $ref: '#/components/schemas/FileInformation'
- description: The source file's location in Amazon S3.
index:
allOf:
- $ref: '#/components/schemas/FileInformation'
- description: The files' index.
description: A set of genome reference files.
Range:
type: string
pattern: '[\p{N}||\p{P}]+'
minLength: 1
maxLength: 127
GetReferenceRequestPartNumberInteger:
type: integer
minimum: 1
maximum: 10000
ReferenceFile:
type: string
enum:
- SOURCE
- INDEX
GetReferenceRequest:
type: object
title: GetReferenceRequest
properties: {}
ReferenceStreamingBlob:
type: string
GetReferenceStoreRequest:
type: object
title: GetReferenceStoreRequest
properties: {}
GetRunGroupRequest:
type: object
title: GetRunGroupRequest
properties: {}
GetRunGroupResponseMaxCpusInteger:
type: integer
minimum: 1
maximum: 100000
GetRunGroupResponseMaxRunsInteger:
type: integer
minimum: 1
maximum: 100000
GetRunGroupResponseMaxDurationInteger:
type: integer
minimum: 1
maximum: 100000
RunGroupTimestamp:
type: string
format: date-time
GetRunGroupResponseMaxGpusInteger:
type: integer
minimum: 1
maximum: 100000
RunExportList:
type: array
items:
$ref: '#/components/schemas/RunExport'
minItems: 0
maxItems: 32
GetRunRequest:
type: object
title: GetRunRequest
properties: {}
RunArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
RunStatus:
type: string
enum:
- PENDING
- STARTING
- RUNNING
- STOPPING
- COMPLETED
- DELETED
- CANCELLED
- FAILED
minLength: 1
maxLength: 64
WorkflowType:
type: string
enum:
- PRIVATE
- READY2RUN
minLength: 1
maxLength: 64
RunRoleArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
RunName:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
GetRunResponsePriorityInteger:
type: integer
minimum: 0
maximum: 100000
WorkflowDigest:
type: string
minLength: 1
maxLength: 64
RunParameters:
type: object
properties: {}
GetRunResponseStorageCapacityInteger:
type: integer
minimum: 0
maximum: 100000
RunOutputUri:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
RunLogLevel:
type: string
enum:
- 'OFF'
- FATAL
- ERROR
- ALL
minLength: 1
maxLength: 64
RunResourceDigests:
type: object
additionalProperties:
$ref: '#/components/schemas/RunResourceDigest'
RunStartedBy:
type: string
minLength: 1
maxLength: 128
RunTimestamp:
type: string
format: date-time
RunStatusMessage:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
TaskId:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
GetRunTaskRequest:
type: object
title: GetRunTaskRequest
properties: {}
TaskStatus:
type: string
enum:
- PENDING
- STARTING
- RUNNING
- STOPPING
- COMPLETED
- CANCELLED
- FAILED
minLength: 1
maxLength: 64
TaskName:
type: string
minLength: 1
maxLength: 128
GetRunTaskResponseCpusInteger:
type: integer
minimum: 1
GetRunTaskResponseMemoryInteger:
type: integer
minimum: 1
TaskTimestamp:
type: string
format: date-time
TaskStatusMessage:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
TaskLogStream:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
GetRunTaskResponseGpusInteger:
type: integer
minimum: 0
GetSequenceStoreRequest:
type: object
title: GetSequenceStoreRequest
properties: {}
GetVariantImportRequest:
type: object
title: GetVariantImportRequest
properties: {}
VariantImportItemDetails:
type: array
items:
$ref: '#/components/schemas/VariantImportItemDetail'
minItems: 1
GetVariantStoreRequest:
type: object
title: GetVariantStoreRequest
properties: {}
WorkflowExportList:
type: array
items:
$ref: '#/components/schemas/WorkflowExport'
minItems: 0
maxItems: 32
GetWorkflowRequest:
type: object
title: GetWorkflowRequest
properties: {}
GetWorkflowResponseStorageCapacityInteger:
type: integer
minimum: 0
maximum: 100000
WorkflowTimestamp:
type: string
format: date-time
WorkflowStatusMessage:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
WorkflowMetadata:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkflowMetadataValue'
Header:
type: boolean
ImportReadSetFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReadSetImportJobStatus'
- description: A status to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
description: A filter for import read set jobs.
ImportReadSetJobItem:
type: object
required:
- id
- sequenceStoreId
- roleArn
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ImportJobId'
- description: The job's ID.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The job's sequence store ID.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/ReadSetImportJobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
completionTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job completed.
description: An import read set job.
ImportReadSetJobList:
type: array
items:
$ref: '#/components/schemas/ImportReadSetJobItem'
SourceFiles:
type: object
required:
- source1
properties:
source1:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The location of the first file in Amazon S3.
source2:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The location of the second file in Amazon S3.
description: Source files for a sequence.
ReadSetImportJobItemStatus:
type: string
enum:
- NOT_STARTED
- IN_PROGRESS
- FINISHED
- FAILED
ImportReadSetSourceItem:
type: object
required:
- sourceFiles
- sourceFileType
- status
- subjectId
- sampleId
properties:
sourceFiles:
allOf:
- $ref: '#/components/schemas/SourceFiles'
- description: The source files' location in Amazon S3.
sourceFileType:
allOf:
- $ref: '#/components/schemas/FileType'
- description: The source's file type.
status:
allOf:
- $ref: '#/components/schemas/ReadSetImportJobItemStatus'
- description: The source's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMessage'
- description: The source's status message.
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: The source's subject ID.
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: The source's sample ID.
generatedFrom:
allOf:
- $ref: '#/components/schemas/GeneratedFrom'
- description: Where the source originated.
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The source's genome reference ARN.
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: The source's name.
description:
allOf:
- $ref: '#/components/schemas/ReadSetDescription'
- description: The source's description.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The source's tags.
description: A source for an import read set job.
ImportReferenceFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReferenceImportJobStatus'
- description: A status to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
description: A filter for import references.
ImportReferenceJobItem:
type: object
required:
- id
- referenceStoreId
- roleArn
- status
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ImportJobId'
- description: The job's ID.
referenceStoreId:
allOf:
- $ref: '#/components/schemas/ReferenceStoreId'
- description: The job's reference store ID.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/ReferenceImportJobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job was created.
completionTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the job completed.
description: An import reference job.
ImportReferenceJobList:
type: array
items:
$ref: '#/components/schemas/ImportReferenceJobItem'
ReferenceImportJobItemStatus:
type: string
enum:
- NOT_STARTED
- IN_PROGRESS
- FINISHED
- FAILED
ImportReferenceSourceItem:
type: object
required:
- status
properties:
sourceFile:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The source file's location in Amazon S3.
status:
allOf:
- $ref: '#/components/schemas/ReferenceImportJobItemStatus'
- description: The source's status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMessage'
- description: The source's status message.
name:
allOf:
- $ref: '#/components/schemas/ReferenceName'
- description: The source's name.
description:
allOf:
- $ref: '#/components/schemas/ReferenceDescription'
- description: The source's description.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The source's tags.
description: An genome reference source.
LineSep:
type: string
minLength: 1
maxLength: 20
ListAnnotationImportJobsFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: A status to filter on.
storeName:
allOf:
- $ref: '#/components/schemas/String'
- description: A store name to filter on.
description: A filter for annotation import jobs.
ListAnnotationImportJobsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListAnnotationImportJobsRequestIdsList:
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
minItems: 1
maxItems: 20
ListAnnotationImportJobsRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListAnnotationImportJobsRequest:
type: object
title: ListAnnotationImportJobsRequest
properties:
ids:
allOf:
- $ref: '#/components/schemas/ListAnnotationImportJobsRequestIdsList'
- description: IDs of annotation import jobs to retrieve.
filter:
allOf:
- $ref: '#/components/schemas/ListAnnotationImportJobsFilter'
- description: A filter to apply to the list.
ListAnnotationStoresFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: A status to filter on.
description: A filter for annotation stores.
ListAnnotationStoresRequestIdsList:
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
minItems: 1
maxItems: 20
ListAnnotationStoresRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListAnnotationStoresRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListAnnotationStoresRequest:
type: object
title: ListAnnotationStoresRequest
properties:
ids:
allOf:
- $ref: '#/components/schemas/ListAnnotationStoresRequestIdsList'
- description: IDs of stores to list.
filter:
allOf:
- $ref: '#/components/schemas/ListAnnotationStoresFilter'
- description: A filter to apply to the list.
ListMultipartReadSetUploadsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
NextToken:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 6144
ListMultipartReadSetUploadsRequest:
type: object
title: ListMultipartReadSetUploadsRequest
properties: {}
MultipartReadSetUploadList:
type: array
items:
$ref: '#/components/schemas/MultipartReadSetUploadListItem'
ListReadSetActivationJobsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListReadSetActivationJobsRequest:
type: object
title: ListReadSetActivationJobsRequest
properties:
filter:
allOf:
- $ref: '#/components/schemas/ActivateReadSetFilter'
- description: A filter to apply to the list.
ListReadSetExportJobsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListReadSetExportJobsRequest:
type: object
title: ListReadSetExportJobsRequest
properties:
filter:
allOf:
- $ref: '#/components/schemas/ExportReadSetFilter'
- description: A filter to apply to the list.
ListReadSetImportJobsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListReadSetImportJobsRequest:
type: object
title: ListReadSetImportJobsRequest
properties:
filter:
allOf:
- $ref: '#/components/schemas/ImportReadSetFilter'
- description: A filter to apply to the list.
ListReadSetUploadPartsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ReadSetUploadPartListFilter:
type: object
properties:
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: ' Filters for read set uploads after a specified time. '
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: ' Filters for read set part uploads before a specified time. '
description: ' Filter settings that select for read set upload parts of interest. '
ListReadSetUploadPartsRequest:
type: object
required:
- partSource
title: ListReadSetUploadPartsRequest
properties:
partSource:
allOf:
- $ref: '#/components/schemas/ReadSetPartSource'
- description: ' The source file for the upload part. '
filter:
allOf:
- $ref: '#/components/schemas/ReadSetUploadPartListFilter'
- description: ' Attributes used to filter for a specific subset of read set part uploads. '
ReadSetUploadPartList:
type: array
items:
$ref: '#/components/schemas/ReadSetUploadPartListItem'
ListReadSetsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ReadSetFilter:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: A name to filter on.
status:
allOf:
- $ref: '#/components/schemas/ReadSetStatus'
- description: A status to filter on.
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: A genome reference ARN to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: ' The read set source''s sample ID. '
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: ' The read set source''s subject ID. '
generatedFrom:
allOf:
- $ref: '#/components/schemas/GeneratedFrom'
- description: ' Where the source originated. '
creationType:
allOf:
- $ref: '#/components/schemas/CreationType'
- description: ' The creation type of the read set. '
description: A filter for read sets.
ListReadSetsRequest:
type: object
title: ListReadSetsRequest
properties:
filter:
allOf:
- $ref: '#/components/schemas/ReadSetFilter'
- description: A filter to apply to the list.
ReadSetList:
type: array
items:
$ref: '#/components/schemas/ReadSetListItem'
ListReferenceImportJobsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListReferenceImportJobsRequest:
type: object
title: ListReferenceImportJobsRequest
properties:
filter:
allOf:
- $ref: '#/components/schemas/ImportReferenceFilter'
- description: A filter to apply to the list.
ListReferenceStoresRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ReferenceStoreFilter:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ReferenceStoreName'
- description: The name to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
description: A filter for reference stores.
ListReferenceStoresRequest:
type: object
title: ListReferenceStoresRequest
properties:
filter:
allOf:
- $ref: '#/components/schemas/ReferenceStoreFilter'
- description: A filter to apply to the list.
ReferenceStoreDetailList:
type: array
items:
$ref: '#/components/schemas/ReferenceStoreDetail'
ListReferencesRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ReferenceFilter:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ReferenceName'
- description: A name to filter on.
md5:
allOf:
- $ref: '#/components/schemas/Md5'
- description: An MD5 checksum to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
description: A filter for references.
ListReferencesRequest:
type: object
title: ListReferencesRequest
properties:
filter:
allOf:
- $ref: '#/components/schemas/ReferenceFilter'
- description: A filter to apply to the list.
ReferenceList:
type: array
items:
$ref: '#/components/schemas/ReferenceListItem'
RunGroupListToken:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
ListRunGroupsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListRunGroupsRequest:
type: object
title: ListRunGroupsRequest
properties: {}
RunGroupList:
type: array
items:
$ref: '#/components/schemas/RunGroupListItem'
TaskListToken:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
ListRunTasksRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListRunTasksRequest:
type: object
title: ListRunTasksRequest
properties: {}
TaskList:
type: array
items:
$ref: '#/components/schemas/TaskListItem'
RunListToken:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
ListRunsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListRunsRequest:
type: object
title: ListRunsRequest
properties: {}
RunList:
type: array
items:
$ref: '#/components/schemas/RunListItem'
ListSequenceStoresRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
SequenceStoreFilter:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/SequenceStoreName'
- description: A name to filter on.
createdAfter:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's start date.
createdBefore:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: The filter's end date.
description: A filter for a sequence store.
ListSequenceStoresRequest:
type: object
title: ListSequenceStoresRequest
properties:
filter:
allOf:
- $ref: '#/components/schemas/SequenceStoreFilter'
- description: A filter to apply to the list.
SequenceStoreDetailList:
type: array
items:
$ref: '#/components/schemas/SequenceStoreDetail'
TagArn:
type: string
pattern: 'arn:.+'
minLength: 1
maxLength: 128
ListTagsForResourceRequest:
type: object
title: ListTagsForResourceRequest
properties: {}
ListVariantImportJobsFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: A status to filter on.
storeName:
allOf:
- $ref: '#/components/schemas/String'
- description: A store name to filter on.
description: A filter for variant import jobs.
ListVariantImportJobsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListVariantImportJobsRequestIdsList:
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
minItems: 1
maxItems: 20
ListVariantImportJobsRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListVariantImportJobsRequest:
type: object
title: ListVariantImportJobsRequest
properties:
ids:
allOf:
- $ref: '#/components/schemas/ListVariantImportJobsRequestIdsList'
- description: A list of job IDs.
filter:
allOf:
- $ref: '#/components/schemas/ListVariantImportJobsFilter'
- description: A filter to apply to the list.
VariantImportJobItems:
type: array
items:
$ref: '#/components/schemas/VariantImportJobItem'
ListVariantStoresFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: A status to filter on.
description: A filter for variant stores.
ListVariantStoresRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListVariantStoresRequestIdsList:
type: array
items:
$ref: '#/components/schemas/ResourceIdentifier'
minItems: 1
maxItems: 20
ListVariantStoresRequestNextTokenString:
type: string
minLength: 1
maxLength: 10000
ListVariantStoresRequest:
type: object
title: ListVariantStoresRequest
properties:
ids:
allOf:
- $ref: '#/components/schemas/ListVariantStoresRequestIdsList'
- description: A list of store IDs.
filter:
allOf:
- $ref: '#/components/schemas/ListVariantStoresFilter'
- description: A filter to apply to the list.
VariantStoreItems:
type: array
items:
$ref: '#/components/schemas/VariantStoreItem'
WorkflowListToken:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
ListWorkflowsRequestMaxResultsInteger:
type: integer
minimum: 1
maximum: 100
ListWorkflowsRequest:
type: object
title: ListWorkflowsRequest
properties: {}
WorkflowList:
type: array
items:
$ref: '#/components/schemas/WorkflowListItem'
MultipartReadSetUploadListItem:
type: object
required:
- sequenceStoreId
- uploadId
- sourceFileType
- subjectId
- sampleId
- generatedFrom
- referenceArn
- creationTime
properties:
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: ' The sequence store ID used for the multipart upload. '
uploadId:
allOf:
- $ref: '#/components/schemas/UploadId'
- description: ' The ID for the initiated multipart upload. '
sourceFileType:
allOf:
- $ref: '#/components/schemas/FileType'
- description: ' The type of file the read set originated from. '
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: ' The read set source''s subject ID. '
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: ' The read set source''s sample ID. '
generatedFrom:
allOf:
- $ref: '#/components/schemas/GeneratedFrom'
- description: ' The source of an uploaded part. '
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: ' The source''s reference ARN. '
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: ' The name of a read set. '
description:
allOf:
- $ref: '#/components/schemas/ReadSetDescription'
- description: ' The description of a read set. '
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: ' Any tags you wish to add to a read set. '
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: ' The time stamp for when a direct upload was created. '
description: ' Part of the response to ListMultipartReadSetUploads, excluding completed and aborted multipart uploads. '
Quote:
type: string
minLength: 1
maxLength: 1
QuoteAll:
type: boolean
Separator:
type: string
minLength: 1
maxLength: 20
ReadOptions:
type: object
properties:
sep:
allOf:
- $ref: '#/components/schemas/Separator'
- description: The file's field separator.
encoding:
allOf:
- $ref: '#/components/schemas/Encoding'
- description: The file's encoding.
quote:
allOf:
- $ref: '#/components/schemas/Quote'
- description: The file's quote character.
quoteAll:
allOf:
- $ref: '#/components/schemas/QuoteAll'
- description: 'Whether all values need to be quoted, or just those that contain quotes.'
escape:
allOf:
- $ref: '#/components/schemas/EscapeChar'
- description: A character for escaping quotes in the file.
escapeQuotes:
allOf:
- $ref: '#/components/schemas/EscapeQuotes'
- description: Whether quotes need to be escaped in the file.
comment:
allOf:
- $ref: '#/components/schemas/CommentChar'
- description: The file's comment character.
header:
allOf:
- $ref: '#/components/schemas/Header'
- description: Whether the file has a header row.
lineSep:
allOf:
- $ref: '#/components/schemas/LineSep'
- description: A line separator for the file.
description: Read options for an annotation import job.
ReadSetBatchError:
type: object
required:
- id
- code
- message
properties:
id:
allOf:
- $ref: '#/components/schemas/ReadSetId'
- description: The error's ID.
code:
allOf:
- $ref: '#/components/schemas/String'
- description: The error's code.
message:
allOf:
- $ref: '#/components/schemas/String'
- description: The error's message.
description: An error from a batch read set operation.
ReadSetListItem:
type: object
required:
- id
- arn
- sequenceStoreId
- status
- fileType
- creationTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ReadSetId'
- description: The read set's ID.
arn:
allOf:
- $ref: '#/components/schemas/ReadSetArn'
- description: The read set's ARN.
sequenceStoreId:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The read set's sequence store ID.
subjectId:
allOf:
- $ref: '#/components/schemas/SubjectId'
- description: The read set's subject ID.
sampleId:
allOf:
- $ref: '#/components/schemas/SampleId'
- description: The read set's sample ID.
status:
allOf:
- $ref: '#/components/schemas/ReadSetStatus'
- description: The read set's status.
name:
allOf:
- $ref: '#/components/schemas/ReadSetName'
- description: The read set's name.
description:
allOf:
- $ref: '#/components/schemas/ReadSetDescription'
- description: The read set's description.
referenceArn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The read set's genome reference ARN.
fileType:
allOf:
- $ref: '#/components/schemas/FileType'
- description: The read set's file type.
sequenceInformation:
$ref: '#/components/schemas/SequenceInformation'
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the read set was created.
statusMessage:
allOf:
- $ref: '#/components/schemas/ReadSetStatusMessage'
- description: ' The status for a read set. It provides more detail as to why the read set has a status. '
creationType:
allOf:
- $ref: '#/components/schemas/CreationType'
- description: ' The creation type of the read set. '
description: A read set.
ReadSetPartStreamingBlob:
type: string
ReadSetUploadPartListItem:
type: object
required:
- partNumber
- partSize
- partSource
- checksum
properties:
partNumber:
allOf:
- $ref: '#/components/schemas/ReadSetUploadPartListItemPartNumberInteger'
- description: ' The number identifying the part in an upload. '
partSize:
allOf:
- $ref: '#/components/schemas/ReadSetUploadPartListItemPartSizeLong'
- description: ' The size of the the part in an upload. '
partSource:
allOf:
- $ref: '#/components/schemas/ReadSetPartSource'
- description: ' The origin of the part being direct uploaded. '
checksum:
allOf:
- $ref: '#/components/schemas/String'
- description: ' A unique identifier used to confirm that parts are being added to the correct upload. '
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: ' The time stamp for when a direct upload was created. '
lastUpdatedTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: ' The time stamp for the most recent update to an uploaded part. '
description: ' 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. '
ReadSetUploadPartListItemPartNumberInteger:
type: integer
minimum: 1
maximum: 10000
ReadSetUploadPartListItemPartSizeLong:
type: integer
minimum: 1
maximum: 5368709120
ReferenceListItem:
type: object
required:
- id
- arn
- referenceStoreId
- md5
- creationTime
- updateTime
properties:
id:
allOf:
- $ref: '#/components/schemas/ReferenceId'
- description: The reference's ID.
arn:
allOf:
- $ref: '#/components/schemas/ReferenceArn'
- description: The reference's ARN.
referenceStoreId:
allOf:
- $ref: '#/components/schemas/ReferenceStoreId'
- description: The reference's store ID.
md5:
allOf:
- $ref: '#/components/schemas/Md5'
- description: The reference's MD5 checksum.
status:
allOf:
- $ref: '#/components/schemas/ReferenceStatus'
- description: The reference's status.
name:
allOf:
- $ref: '#/components/schemas/ReferenceName'
- description: The reference's name.
description:
allOf:
- $ref: '#/components/schemas/ReferenceDescription'
- description: The reference's description.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the reference was created.
updateTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the reference was updated.
description: A genome reference.
ReferenceStoreDetail:
type: object
required:
- arn
- id
- creationTime
properties:
arn:
allOf:
- $ref: '#/components/schemas/ReferenceStoreArn'
- description: The store's ARN.
id:
allOf:
- $ref: '#/components/schemas/ReferenceStoreId'
- description: The store's ID.
name:
allOf:
- $ref: '#/components/schemas/ReferenceStoreName'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/ReferenceStoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's server-side encryption (SSE) settings.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the store was created.
description: Details about a reference store.
RunGroupListItem:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/RunGroupArn'
- description: The group's ARN.
id:
allOf:
- $ref: '#/components/schemas/RunGroupId'
- description: The group's ID.
name:
allOf:
- $ref: '#/components/schemas/RunGroupName'
- description: The group's name.
maxCpus:
allOf:
- $ref: '#/components/schemas/RunGroupListItemMaxCpusInteger'
- description: The group's maximum CPU count setting.
maxRuns:
allOf:
- $ref: '#/components/schemas/RunGroupListItemMaxRunsInteger'
- description: The group's maximum concurrent run setting.
maxDuration:
allOf:
- $ref: '#/components/schemas/RunGroupListItemMaxDurationInteger'
- description: The group's maximum duration setting in minutes.
creationTime:
allOf:
- $ref: '#/components/schemas/RunGroupTimestamp'
- description: When the group was created.
maxGpus:
allOf:
- $ref: '#/components/schemas/RunGroupListItemMaxGpusInteger'
- description: ' The maximum GPUs that can be used by a run group. '
description: A run group.
RunGroupListItemMaxCpusInteger:
type: integer
minimum: 1
maximum: 100000
RunGroupListItemMaxRunsInteger:
type: integer
minimum: 1
maximum: 100000
RunGroupListItemMaxDurationInteger:
type: integer
minimum: 1
maximum: 100000
RunGroupListItemMaxGpusInteger:
type: integer
minimum: 1
maximum: 100000
RunListItem:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/RunArn'
- description: The run's ARN.
id:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The run's ID.
status:
allOf:
- $ref: '#/components/schemas/RunStatus'
- description: The run's status.
workflowId:
allOf:
- $ref: '#/components/schemas/WorkflowId'
- description: The run's workflow ID.
name:
allOf:
- $ref: '#/components/schemas/RunName'
- description: The run's name.
priority:
allOf:
- $ref: '#/components/schemas/RunListItemPriorityInteger'
- description: The run's priority.
storageCapacity:
allOf:
- $ref: '#/components/schemas/RunListItemStorageCapacityInteger'
- description: The run's storage capacity.
creationTime:
allOf:
- $ref: '#/components/schemas/RunTimestamp'
- description: When the run was created.
startTime:
allOf:
- $ref: '#/components/schemas/RunTimestamp'
- description: When the run started.
stopTime:
allOf:
- $ref: '#/components/schemas/RunTimestamp'
- description: When the run stopped.
description: A workflow run.
RunListItemPriorityInteger:
type: integer
minimum: 0
maximum: 100000
RunListItemStorageCapacityInteger:
type: integer
minimum: 0
maximum: 100000
RunRequestId:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
RunResourceDigest:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 0
maxLength: 64
RunResourceDigestKey:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 256
SchemaValueType:
type: string
enum:
- LONG
- INT
- STRING
- FLOAT
- DOUBLE
- BOOLEAN
SchemaItem:
type: object
minProperties: 1
maxProperties: 1
additionalProperties:
$ref: '#/components/schemas/SchemaValueType'
SchemaItemKeyString:
type: string
pattern: '[a-z0-9_]{1,255}'
SequenceStoreDetail:
type: object
required:
- arn
- id
- creationTime
properties:
arn:
allOf:
- $ref: '#/components/schemas/SequenceStoreArn'
- description: The store's ARN.
id:
allOf:
- $ref: '#/components/schemas/SequenceStoreId'
- description: The store's ID.
name:
allOf:
- $ref: '#/components/schemas/SequenceStoreName'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/SequenceStoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's server-side encryption (SSE) settings.
creationTime:
allOf:
- $ref: '#/components/schemas/SyntheticTimestamp_date_time'
- description: When the store was created.
fallbackLocation:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: ' An S3 location that is used to store files that have failed a direct upload. '
description: Details about a sequence store.
StartAnnotationImportRequest:
type: object
required:
- destinationName
- roleArn
- items
title: StartAnnotationImportRequest
properties:
destinationName:
allOf:
- $ref: '#/components/schemas/StoreName'
- description: A destination annotation store for the job.
roleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: A service role for the job.
items:
allOf:
- $ref: '#/components/schemas/AnnotationImportItemSources'
- description: Items to import.
formatOptions:
allOf:
- $ref: '#/components/schemas/FormatOptions'
- description: Formatting options for the annotation file.
runLeftNormalization:
allOf:
- $ref: '#/components/schemas/RunLeftNormalization'
- description: The job's left normalization setting.
annotationFields:
allOf:
- $ref: '#/components/schemas/AnnotationFieldMap'
- description: ' The annotation schema generated by the parsed annotation data. '
StartReadSetActivationJobRequestSourcesList:
type: array
items:
$ref: '#/components/schemas/StartReadSetActivationJobSourceItem'
minItems: 1
maxItems: 20
StartReadSetActivationJobRequest:
type: object
required:
- sources
title: StartReadSetActivationJobRequest
properties:
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 'To ensure that jobs don''t run multiple times, specify a unique token for each job.'
sources:
allOf:
- $ref: '#/components/schemas/StartReadSetActivationJobRequestSourcesList'
- description: The job's source files.
StartReadSetExportJobRequestSourcesList:
type: array
items:
$ref: '#/components/schemas/ExportReadSet'
minItems: 1
maxItems: 100
StartReadSetExportJobRequest:
type: object
required:
- destination
- roleArn
- sources
title: StartReadSetExportJobRequest
properties:
destination:
allOf:
- $ref: '#/components/schemas/S3Destination'
- description: A location for exported files in Amazon S3.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: A service role for the job.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 'To ensure that jobs don''t run multiple times, specify a unique token for each job.'
sources:
allOf:
- $ref: '#/components/schemas/StartReadSetExportJobRequestSourcesList'
- description: The job's source files.
StartReadSetImportJobRequestSourcesList:
type: array
items:
$ref: '#/components/schemas/StartReadSetImportJobSourceItem'
minItems: 1
maxItems: 100
StartReadSetImportJobRequest:
type: object
required:
- roleArn
- sources
title: StartReadSetImportJobRequest
properties:
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: A service role for the job.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 'To ensure that jobs don''t run multiple times, specify a unique token for each job.'
sources:
allOf:
- $ref: '#/components/schemas/StartReadSetImportJobRequestSourcesList'
- description: The job's source files.
StartReferenceImportJobRequestSourcesList:
type: array
items:
$ref: '#/components/schemas/StartReferenceImportJobSourceItem'
minItems: 1
maxItems: 100
StartReferenceImportJobRequest:
type: object
required:
- roleArn
- sources
title: StartReferenceImportJobRequest
properties:
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: A service role for the job.
clientToken:
allOf:
- $ref: '#/components/schemas/ClientToken'
- description: 'To ensure that jobs don''t run multiple times, specify a unique token for each job.'
sources:
allOf:
- $ref: '#/components/schemas/StartReferenceImportJobRequestSourcesList'
- description: The job's source files.
StartRunRequestPriorityInteger:
type: integer
minimum: 0
maximum: 100000
StartRunRequestStorageCapacityInteger:
type: integer
minimum: 0
maximum: 100000
StartRunRequest:
type: object
required:
- roleArn
- requestId
title: StartRunRequest
properties:
workflowId:
allOf:
- $ref: '#/components/schemas/WorkflowId'
- description: The run's workflow ID.
workflowType:
allOf:
- $ref: '#/components/schemas/WorkflowType'
- description: The run's workflows type.
runId:
allOf:
- $ref: '#/components/schemas/RunId'
- description: The run's ID.
roleArn:
allOf:
- $ref: '#/components/schemas/RunRoleArn'
- description: A service role for the run.
name:
allOf:
- $ref: '#/components/schemas/RunName'
- description: A name for the run.
runGroupId:
allOf:
- $ref: '#/components/schemas/RunGroupId'
- description: The run's group ID.
priority:
allOf:
- $ref: '#/components/schemas/StartRunRequestPriorityInteger'
- description: A priority for the run.
parameters:
allOf:
- $ref: '#/components/schemas/RunParameters'
- description: Parameters for the run.
storageCapacity:
allOf:
- $ref: '#/components/schemas/StartRunRequestStorageCapacityInteger'
- description: A storage capacity for the run in gigabytes.
outputUri:
allOf:
- $ref: '#/components/schemas/RunOutputUri'
- description: An output URI for the run.
logLevel:
allOf:
- $ref: '#/components/schemas/RunLogLevel'
- description: A log level for the run.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags for the run.
requestId:
allOf:
- $ref: '#/components/schemas/RunRequestId'
- description: 'To ensure that requests don''t run multiple times, specify a unique ID for each request.'
VariantImportItemSources:
type: array
items:
$ref: '#/components/schemas/VariantImportItemSource'
minItems: 1
StartVariantImportRequest:
type: object
required:
- destinationName
- roleArn
- items
title: StartVariantImportRequest
properties:
destinationName:
allOf:
- $ref: '#/components/schemas/StoreName'
- description: The destination variant store for the job.
roleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: A service role for the job.
items:
allOf:
- $ref: '#/components/schemas/VariantImportItemSources'
- description: Items to import.
runLeftNormalization:
allOf:
- $ref: '#/components/schemas/RunLeftNormalization'
- description: The job's left normalization setting.
annotationFields:
allOf:
- $ref: '#/components/schemas/AnnotationFieldMap'
- description: ' The annotation schema generated by the parsed annotation data. '
TagKeyList:
type: array
items:
$ref: '#/components/schemas/TagKey'
minItems: 0
maxItems: 50
TagResourceRequestTagsMap:
type: object
minProperties: 0
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
TagResourceRequest:
type: object
required:
- tags
title: TagResourceRequest
properties:
tags:
allOf:
- $ref: '#/components/schemas/TagResourceRequestTagsMap'
- description: Tags for the resource.
TaskListItem:
type: object
properties:
taskId:
allOf:
- $ref: '#/components/schemas/TaskId'
- description: The task's ID.
status:
allOf:
- $ref: '#/components/schemas/TaskStatus'
- description: The task's status.
name:
allOf:
- $ref: '#/components/schemas/TaskName'
- description: The task's name.
cpus:
allOf:
- $ref: '#/components/schemas/TaskListItemCpusInteger'
- description: The task's CPU count.
memory:
allOf:
- $ref: '#/components/schemas/TaskListItemMemoryInteger'
- description: The task's memory use in gigabyes.
creationTime:
allOf:
- $ref: '#/components/schemas/TaskTimestamp'
- description: When the task was created.
startTime:
allOf:
- $ref: '#/components/schemas/TaskTimestamp'
- description: When the task started.
stopTime:
allOf:
- $ref: '#/components/schemas/TaskTimestamp'
- description: When the task stopped.
gpus:
allOf:
- $ref: '#/components/schemas/TaskListItemGpusInteger'
- description: ' The number of Graphics Processing Units (GPU) specified for the task. '
description: A workflow run task.
TaskListItemCpusInteger:
type: integer
minimum: 1
TaskListItemMemoryInteger:
type: integer
minimum: 1
TaskListItemGpusInteger:
type: integer
minimum: 0
TsvStoreOptionsSchemaList:
type: array
items:
$ref: '#/components/schemas/SchemaItem'
minItems: 1
maxItems: 5000
UntagResourceRequest:
type: object
title: UntagResourceRequest
properties: {}
UpdateAnnotationStoreRequest:
type: object
title: UpdateAnnotationStoreRequest
properties:
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: A description for the store.
UpdateRunGroupRequestMaxCpusInteger:
type: integer
minimum: 1
maximum: 100000
UpdateRunGroupRequestMaxRunsInteger:
type: integer
minimum: 1
maximum: 100000
UpdateRunGroupRequestMaxDurationInteger:
type: integer
minimum: 1
maximum: 100000
UpdateRunGroupRequestMaxGpusInteger:
type: integer
minimum: 1
maximum: 100000
UpdateRunGroupRequest:
type: object
title: UpdateRunGroupRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/RunGroupName'
- description: A name for the group.
maxCpus:
allOf:
- $ref: '#/components/schemas/UpdateRunGroupRequestMaxCpusInteger'
- description: The maximum number of CPUs to use.
maxRuns:
allOf:
- $ref: '#/components/schemas/UpdateRunGroupRequestMaxRunsInteger'
- description: The maximum number of concurrent runs for the group.
maxDuration:
allOf:
- $ref: '#/components/schemas/UpdateRunGroupRequestMaxDurationInteger'
- description: A maximum run time for the group in minutes.
maxGpus:
allOf:
- $ref: '#/components/schemas/UpdateRunGroupRequestMaxGpusInteger'
- description: ' The maximum GPUs that can be used by a run group. '
UpdateVariantStoreRequest:
type: object
title: UpdateVariantStoreRequest
properties:
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: A description for the store.
UpdateWorkflowRequest:
type: object
title: UpdateWorkflowRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/WorkflowName'
- description: A name for the workflow.
description:
allOf:
- $ref: '#/components/schemas/WorkflowDescription'
- description: A description for the workflow.
UploadReadSetPartRequestPartNumberInteger:
type: integer
minimum: 1
maximum: 10000
UploadReadSetPartRequest:
type: object
required:
- payload
title: UploadReadSetPartRequest
properties:
payload:
allOf:
- $ref: '#/components/schemas/ReadSetPartStreamingBlob'
- description: ' The read set data to upload for a part. '
VariantImportItemDetail:
type: object
required:
- source
- jobStatus
properties:
source:
allOf:
- $ref: '#/components/schemas/S3Uri'
- description: The source file's location in Amazon S3.
jobStatus:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The item's job status.
statusMessage:
allOf:
- $ref: '#/components/schemas/JobStatusMsg'
- description: ' A message that provides additional context about a job '
description: Details about an imported variant item.
VariantImportJobItem:
type: object
required:
- id
- destinationName
- roleArn
- status
- creationTime
- updateTime
properties:
id:
allOf:
- $ref: '#/components/schemas/String'
- description: The job's ID.
destinationName:
allOf:
- $ref: '#/components/schemas/String'
- description: The job's destination variant store.
roleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The job's service role ARN.
status:
allOf:
- $ref: '#/components/schemas/JobStatus'
- description: The job's status.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the job was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the job was updated.
completionTime:
allOf:
- $ref: '#/components/schemas/CompletionTime'
- description: When the job completed.
runLeftNormalization:
allOf:
- $ref: '#/components/schemas/RunLeftNormalization'
- description: The job's left normalization setting.
annotationFields:
allOf:
- $ref: '#/components/schemas/AnnotationFieldMap'
- description: ' The annotation schema generated by the parsed annotation data. '
description: A variant import job.
VariantStoreItem:
type: object
required:
- id
- reference
- status
- storeArn
- name
- description
- sseConfig
- creationTime
- updateTime
- statusMessage
- storeSizeBytes
properties:
id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The store's ID.
reference:
allOf:
- $ref: '#/components/schemas/ReferenceItem'
- description: The store's genome reference.
status:
allOf:
- $ref: '#/components/schemas/StoreStatus'
- description: The store's status.
storeArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The store's ARN.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The store's name.
description:
allOf:
- $ref: '#/components/schemas/StoreDescription'
- description: The store's description.
sseConfig:
allOf:
- $ref: '#/components/schemas/SseConfig'
- description: The store's server-side encryption (SSE) settings.
creationTime:
allOf:
- $ref: '#/components/schemas/CreationTime'
- description: When the store was created.
updateTime:
allOf:
- $ref: '#/components/schemas/UpdateTime'
- description: When the store was updated.
statusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: The store's status message.
storeSizeBytes:
allOf:
- $ref: '#/components/schemas/Long'
- description: The store's size in bytes.
description: A variant store.
WorkflowListItem:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/WorkflowArn'
- description: The workflow's ARN.
id:
allOf:
- $ref: '#/components/schemas/WorkflowId'
- description: The workflow's ID.
name:
allOf:
- $ref: '#/components/schemas/WorkflowName'
- description: The workflow's name.
status:
allOf:
- $ref: '#/components/schemas/WorkflowStatus'
- description: The workflow's status.
type:
allOf:
- $ref: '#/components/schemas/WorkflowType'
- description: The workflow's type.
digest:
allOf:
- $ref: '#/components/schemas/WorkflowDigest'
- description: The workflow's digest.
creationTime:
allOf:
- $ref: '#/components/schemas/WorkflowTimestamp'
- description: When the workflow was created.
metadata:
allOf:
- $ref: '#/components/schemas/WorkflowMetadata'
- description: ' Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return. '
description: A workflow.
WorkflowMetadataValue:
type: string
minLength: 0
maxLength: 256
WorkflowMetadataKey:
type: string
minLength: 1
maxLength: 128
WorkflowParameterDescription:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 0
maxLength: 256
WorkflowParameterName:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
security:
- hmac: []