Amazon HealthOmics

Amazon HealthOmics Healthomics Share API

The Healthomics Share API from Amazon HealthOmics — 2 operation(s) for healthomics share.

GitHub OpenAPI

Operations 4

POST /share Create Share #
GET /share/{shareId} Get Share #
POST /share/{shareId} Accept Share #
DELETE /share/{shareId} Delete Share #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-healthomics/openapi/amazon-healthomics-share-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-healthomics:amazon-healthomics-share-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-healthomics-share-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Omics Share API
  version: '2022-11-28'
  description: Generated from AWS's published Smithy model for Amazon Omics. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://omics.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Share
paths:
  /share:
    post:
      operationId: CreateShare
      summary: Create Share
      description: 'Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an Amazon Web Services user with a different account than the resource owner). The following resources support cross-account sharing: HealthOmics variant stores HealthOmics annotation stores Private workflows'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShareResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShareRequest'
      tags:
      - Share
  /share/{shareId}:
    get:
      operationId: GetShare
      summary: Get Share
      description: Retrieves the metadata for the specified resource share.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShareResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetShareRequest'
      tags:
      - Share
    post:
      operationId: AcceptShare
      summary: Accept Share
      description: Accept a resource share request.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptShareResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptShareRequest'
      tags:
      - Share
    delete:
      operationId: DeleteShare
      summary: Delete Share
      description: Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteShareResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteShareRequest'
      tags:
      - Share
components:
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetShareRequest:
      type: object
      properties:
        shareId:
          type: string
          description: The ID of the share.
      required:
      - shareId
    CreateShareRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The ARN of the resource to be shared.
        principalSubscriber:
          type: string
          description: The principal subscriber is the account being offered shared access to the resource.
        shareName:
          type: string
          description: A name that the owner defines for the share.
      required:
      - resourceArn
      - principalSubscriber
    CreateShareResponse:
      type: object
      properties:
        shareId:
          type: string
          description: The ID that HealthOmics generates for the share.
        status:
          type: string
          description: The status of the share.
        shareName:
          type: string
          description: The name of the share.
    AcceptShareResponse:
      type: object
      properties:
        status:
          type: string
          description: The status of the resource share.
    ShareDetails:
      type: object
      properties:
        shareId:
          type: string
          description: The ID of the resource share.
        resourceArn:
          type: string
          description: The Arn of the shared resource.
        resourceId:
          type: string
          description: The ID of the shared resource.
        principalSubscriber:
          type: string
          description: The principal subscriber is the account that is sharing the resource.
        ownerId:
          type: string
          description: The account ID for the data owner. The owner creates the resource share.
        status:
          type: string
          description: The status of the share.
        statusMessage:
          type: string
          description: The status message for a resource share. It provides additional details about the share status.
        shareName:
          type: string
          description: The name of the resource share.
        creationTime:
          type: string
          format: date-time
          description: The timestamp of when the resource share was created.
        updateTime:
          type: string
          format: date-time
          description: The timestamp of the resource share update.
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetShareResponse:
      type: object
      properties:
        share:
          $ref: '#/components/schemas/ShareDetails'
    AcceptShareRequest:
      type: object
      properties:
        shareId:
          type: string
          description: The ID of the resource share.
      required:
      - shareId
    DeleteShareResponse:
      type: object
      properties:
        status:
          type: string
          description: The status of the share being deleted.
    DeleteShareRequest:
      type: object
      properties:
        shareId:
          type: string
          description: The ID for the resource share to be deleted.
      required:
      - shareId
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: omics
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/omics/service/2022-11-28/omics-2022-11-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)