openapi: 3.0.0 info: version: '2022-11-28' x-release: v4 title: Amazon Omics AnnotationStore Workflow API 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 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: Workflow paths: /workflow: 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: 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 tags: - Workflow 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 tags: - Workflow /workflow/{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: 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 tags: - Workflow 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 tags: - Workflow 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 tags: - Workflow 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-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false schemas: ResourceNotFoundException: {} WorkflowParameterTemplate: type: object minProperties: 1 maxProperties: 1000 additionalProperties: $ref: '#/components/schemas/WorkflowParameter' WorkflowList: type: array items: $ref: '#/components/schemas/WorkflowListItem' 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. WorkflowId: type: string pattern: '[0-9]+' minLength: 1 maxLength: 18 WorkflowMetadata: type: object additionalProperties: $ref: '#/components/schemas/WorkflowMetadataValue' 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. WorkflowEngine: type: string enum: - WDL - NEXTFLOW - CWL minLength: 1 maxLength: 64 WorkflowTimestamp: type: string format: date-time WorkflowStatus: type: string enum: - CREATING - ACTIVE - UPDATING - DELETED - FAILED - INACTIVE minLength: 1 maxLength: 64 ConflictException: {} WorkflowName: type: string pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+' minLength: 1 maxLength: 128 WorkflowType: type: string enum: - PRIVATE - READY2RUN minLength: 1 maxLength: 64 WorkflowStatusMessage: type: string pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+' WorkflowParameterDescription: type: string pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+' minLength: 0 maxLength: 256 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. WorkflowMain: type: string pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+' minLength: 1 maxLength: 128 Boolean: type: boolean TagMap: type: object additionalProperties: $ref: '#/components/schemas/TagValue' WorkflowDefinition: type: string pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+' minLength: 1 maxLength: 256 TagValue: type: string minLength: 0 maxLength: 256 RequestTimeoutException: {} WorkflowArn: type: string pattern: arn:.+ minLength: 1 maxLength: 128 ThrottlingException: {} WorkflowDigest: type: string minLength: 1 maxLength: 64 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. WorkflowMetadataValue: type: string minLength: 0 maxLength: 256 WorkflowListToken: type: string pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+' minLength: 1 maxLength: 128 ValidationException: {} GetWorkflowResponseStorageCapacityInteger: type: integer minimum: 0 maximum: 100000 WorkflowExport: type: string enum: - DEFINITION minLength: 1 maxLength: 64 Accelerators: type: string enum: - GPU minLength: 1 maxLength: 64 ServiceQuotaExceededException: {} AccessDeniedException: {} InternalServerException: {} 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. ' WorkflowDescription: type: string pattern: '[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+' minLength: 1 maxLength: 256 securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/omics/ x-hasEquivalentPaths: true