The Run API from Amazon HealthOmics — 5 operation(s) for run.
openapi: 3.0.0
info:
version: '2022-11-28'
x-release: v4
title: Amazon Omics AnnotationStore Run API
description: This is the <i>AWS HealthOmics API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/omics/latest/dev/">What is AWS HealthOmics?</a> in the <i>AWS HealthOmics User Guide</i>.
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
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)
security:
- hmac: []
tags:
- name: Run
paths:
/run/{id}/cancel:
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: 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
tags:
- Run
/run/{id}:
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'
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
tags:
- Run
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
tags:
- Run
/run/{id}/task/{taskId}:
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: 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
tags:
- Run
/run/{id}/task:
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: 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
tags:
- Run
/run:
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: 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
tags:
- Run
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
tags:
- Run
components:
schemas:
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.
TaskName:
type: string
minLength: 1
maxLength: 128
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.
ResourceNotFoundException: {}
RunStatus:
type: string
enum:
- PENDING
- STARTING
- RUNNING
- STOPPING
- COMPLETED
- DELETED
- CANCELLED
- FAILED
minLength: 1
maxLength: 64
TaskListItemMemoryInteger:
type: integer
minimum: 1
GetRunTaskResponseCpusInteger:
type: integer
minimum: 1
WorkflowId:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
RunArn:
type: string
pattern: arn:.+
minLength: 1
maxLength: 128
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.
RunLogLevel:
type: string
enum:
- 'OFF'
- FATAL
- ERROR
- ALL
minLength: 1
maxLength: 64
ConflictException: {}
TaskListItemCpusInteger:
type: integer
minimum: 1
RunExport:
type: string
enum:
- DEFINITION
minLength: 1
maxLength: 64
WorkflowType:
type: string
enum:
- PRIVATE
- READY2RUN
minLength: 1
maxLength: 64
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. '
GetRunResponsePriorityInteger:
type: integer
minimum: 0
maximum: 100000
RunRoleArn:
type: string
pattern: arn:.+
minLength: 1
maxLength: 128
RunResourceDigest:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 0
maxLength: 64
RunId:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
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.
TaskListToken:
type: string
pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+'
minLength: 1
maxLength: 128
TaskList:
type: array
items:
$ref: '#/components/schemas/TaskListItem'
TaskTimestamp:
type: string
format: date-time
TaskId:
type: string
pattern: '[0-9]+'
minLength: 1
maxLength: 18
GetRunResponse:
type: object
properties:
arn:
allOf:
- $ref: '#/componen
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-healthomics/refs/heads/main/openapi/amazon-healthomics-run-api-openapi.yml