Amazon HealthOmics Sequencestores API

The Sequencestores API from Amazon HealthOmics — 1 operation(s) for sequencestores.

GitHub OpenAPI

Operations 5

POST /sequencestore Create Sequence Store #
GET /sequencestore/{id} Get Sequence Store #
PATCH /sequencestore/{id} Update Sequence Store #
DELETE /sequencestore/{id} Delete Sequence Store #
POST /sequencestores List Sequence Stores #

Documentation

Specifications

Schemas & Data

Other Resources

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-sequencestores-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.

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

OpenAPI Specification

amazon-healthomics-sequencestores-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Omics Sequencestores API
  version: '2022-11-28'
  description: Generated from AWS's published Smithy model for Amazon Omics. 5 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: []
paths:
  /sequencestore:
    post:
      operationId: CreateSequenceStore
      summary: Create Sequence Store
      description: 'Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files
        called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence
        store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required.
        You can create multiple sequence stores per region per account. The following are optional parameters you can specify
        for your sequence store: Use s3AccessConfig to configure your sequence store with S3 access logs (recommended). Use
        sseConfig to define your own KMS key for encryption. Use eTagAlgorithmFamily to define which algorithm to use for
        the HealthOmics eTag on objects. Use fallbackLocation to define a backup location for storing files that have failed
        a direct upload. Use propagatedSetLevelTags to configure tags that propagate to all objects in your store. For more
        information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSequenceStoreResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '408':
          description: RequestTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimeoutException'
        '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/CreateSequenceStoreRequest'
      tags:
      - Sequencestores
  /sequencestore/{id}:
    get:
      operationId: GetSequenceStore
      summary: Get Sequence Store
      description: Retrieves metadata for a sequence store using its ID and returns it in JSON format.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSequenceStoreResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '408':
          description: RequestTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimeoutException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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/GetSequenceStoreRequest'
      tags:
      - Sequencestores
    patch:
      operationId: UpdateSequenceStore
      summary: Update Sequence Store
      description: Update one or more parameters for the sequence store.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSequenceStoreResponse'
        '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'
        '408':
          description: RequestTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimeoutException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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/UpdateSequenceStoreRequest'
      tags:
      - Sequencestores
    delete:
      operationId: DeleteSequenceStore
      summary: Delete Sequence Store
      description: Deletes a sequence store and returns a response with no body if the operation is successful. You can only
        delete a sequence store when it does not contain any read sets. Use the BatchDeleteReadSet API operation to ensure
        that all read sets in the sequence store are deleted. When a sequence store is deleted, all tags associated with the
        store are also deleted. For more information, see Deleting HealthOmics reference and sequence stores in the Amazon
        Web Services HealthOmics User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSequenceStoreResponse'
        '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'
        '408':
          description: RequestTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimeoutException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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/DeleteSequenceStoreRequest'
      tags:
      - Sequencestores
  /sequencestores:
    post:
      operationId: ListSequenceStores
      summary: List Sequence Stores
      description: Retrieves a list of sequence stores and returns each sequence store's metadata. For more information, see
        Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSequenceStoresResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '408':
          description: RequestTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTimeoutException'
        '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/ListSequenceStoresRequest'
      tags:
      - Sequencestores
components:
  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
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateSequenceStoreRequest:
      type: object
      properties:
        name:
          type: string
          description: A name for the store.
        description:
          type: string
          description: A description for the store.
        sseConfig:
          $ref: '#/components/schemas/SseConfig'
        tags:
          type: object
          additionalProperties:
            type: string
          description: Tags for the store. You can configure up to 50 tags.
        clientToken:
          type: string
          description: An idempotency token used to dedupe retry requests so that duplicate runs are not created.
        fallbackLocation:
          type: string
          description: An S3 location that is used to store files that have failed a direct upload. You can add or change
            the fallbackLocation after creating a sequence store. This is not required if you are uploading files from a different
            S3 bucket.
        eTagAlgorithmFamily:
          type: string
          description: The ETag algorithm family to use for ingested read sets. The default value is MD5up. For more information
            on ETags, see ETags and data provenance in the Amazon Web Services HealthOmics User Guide.
        propagatedSetLevelTags:
          type: array
          items:
            type: string
          description: The tags keys to propagate to the S3 objects associated with read sets in the sequence store. These
            tags can be used as input to add metadata to your read sets.
        s3AccessConfig:
          $ref: '#/components/schemas/S3AccessConfig'
      required:
      - name
    CreateSequenceStoreResponse:
      type: object
      properties:
        id:
          type: string
          description: The store's ID.
        arn:
          type: string
          description: The store's ARN.
        name:
          type: string
          description: The store's name.
        description:
          type: string
          description: The store's description.
        sseConfig:
          $ref: '#/components/schemas/SseConfig'
        creationTime:
          type: string
          description: When the store was created.
        fallbackLocation:
          type: string
          description: An S3 location that is used to store files that have failed a direct upload.
        eTagAlgorithmFamily:
          type: string
          description: The algorithm family of the ETag.
        status:
          type: string
          description: The status of the sequence store.
        statusMessage:
          type: string
          description: The status message of the sequence store.
        propagatedSetLevelTags:
          type: array
          items:
            type: string
          description: The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
        s3Access:
          $ref: '#/components/schemas/SequenceStoreS3Access'
      required:
      - id
      - arn
      - creationTime
    DeleteSequenceStoreRequest:
      type: object
      properties:
        id:
          type: string
          description: The sequence store's ID.
      required:
      - id
    DeleteSequenceStoreResponse:
      type: object
      properties: {}
    GetSequenceStoreRequest:
      type: object
      properties:
        id:
          type: string
          description: The store's ID.
      required:
      - id
    GetSequenceStoreResponse:
      type: object
      properties:
        id:
          type: string
          description: The store's ID.
        arn:
          type: string
          description: The store's ARN.
        name:
          type: string
          description: The store's name.
        description:
          type: string
          description: The store's description.
        sseConfig:
          $ref: '#/components/schemas/SseConfig'
        creationTime:
          type: string
          description: When the store was created.
        fallbackLocation:
          type: string
          description: An S3 location that is used to store files that have failed a direct upload.
        s3Access:
          $ref: '#/components/schemas/SequenceStoreS3Access'
        eTagAlgorithmFamily:
          type: string
          description: The algorithm family of the ETag.
        status:
          type: string
          description: The status of the sequence store.
        statusMessage:
          type: string
          description: The status message of the sequence store.
        propagatedSetLevelTags:
          type: array
          items:
            type: string
          description: The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
        updateTime:
          type: string
          description: The last-updated time of the sequence store.
      required:
      - id
      - arn
      - creationTime
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListSequenceStoresRequest:
      type: object
      properties:
        maxResults:
          type: integer
          description: The maximum number of stores to return in one page of results.
        nextToken:
          type: string
          description: Specify the pagination token from a previous request to retrieve the next page of results.
        filter:
          $ref: '#/components/schemas/SequenceStoreFilter'
    ListSequenceStoresResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: A pagination token that's included if more results are available.
        sequenceStores:
          type: array
          items:
            $ref: '#/components/schemas/SequenceStoreDetail'
          description: A list of sequence stores.
      required:
      - sequenceStores
    RequestTimeoutException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    S3AccessConfig:
      type: object
      properties:
        accessLogLocation:
          type: string
          description: Location of the access logs.
    SequenceStoreDetail:
      type: object
      properties:
        arn:
          type: string
          description: The store's ARN.
        id:
          type: string
          description: The store's ID.
        name:
          type: string
          description: The store's name.
        description:
          type: string
          description: The store's description.
        sseConfig:
          $ref: '#/components/schemas/SseConfig'
        creationTime:
          type: string
          description: When the store was created.
        fallbackLocation:
          type: string
          description: An S3 location that is used to store files that have failed a direct upload.
        eTagAlgorithmFamily:
          type: string
          description: The algorithm family of the ETag.
        status:
          type: string
          description: Status of the sequence store.
        statusMessage:
          type: string
          description: The status message of the sequence store.
        updateTime:
          type: string
          description: The last-updated time of the Sequence Store.
      required:
      - arn
      - id
      - creationTime
    SequenceStoreFilter:
      type: object
      properties:
        name:
          type: string
          description: A name to filter on.
        createdAfter:
          type: string
          description: The filter's start date.
        createdBefore:
          type: string
          description: The filter's end date.
        status:
          type: string
          description: Filter results based on status.
        updatedAfter:
          type: string
          description: Filter results based on stores updated after the specified time.
        updatedBefore:
          type: string
          description: Filter results based on stores updated before the specified time.
    SequenceStoreS3Access:
      type: object
      properties:
        s3Uri:
          type: string
          description: The S3 URI of the sequence store.
        s3AccessPointArn:
          type: string
          description: This is ARN of the access point associated with the S3 bucket storing read sets.
        accessLogLocation:
          type: string
          description: Location of the access logs.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    SseConfig:
      type: object
      properties:
        type:
          type: string
          description: The encryption type.
        keyArn:
          type: string
          description: An encryption key ARN.
      required:
      - type
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateSequenceStoreRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the sequence store.
        name:
          type: string
          description: A name for the sequence store.
        description:
          type: string
          description: A description for the sequence store.
        clientToken:
          type: string
          description: To ensure that requests don't run multiple times, specify a unique token for each request.
        fallbackLocation:
          type: string
          description: The S3 URI of a bucket and folder to store Read Sets that fail to upload.
        propagatedSetLevelTags:
          type: array
          items:
            type: string
          description: The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
        s3AccessConfig:
          $ref: '#/components/schemas/S3AccessConfig'
      required:
      - id
    UpdateSequenceStoreResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the sequence store.
        arn:
          type: string
          description: The ARN of the sequence store.
        name:
          type: string
          description: The name of the sequence store.
        description:
          type: string
          description: Description of the sequence store.
        sseConfig:
          $ref: '#/components/schemas/SseConfig'
        creationTime:
          type: string
          description: The time when the store was created.
        updateTime:
          type: string
          description: The last-updated time of the Sequence Store.
        propagatedSetLevelTags:
          type: array
          items:
            type: string
          description: The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
        status:
          type: string
          description: The status of the sequence store.
        statusMessage:
          type: string
          description: The status message of the sequence store.
        fallbackLocation:
          type: string
          description: The S3 URI of a bucket and folder to store Read Sets that fail to upload.
        s3Access:
          $ref: '#/components/schemas/SequenceStoreS3Access'
        eTagAlgorithmFamily:
          type: string
          description: The ETag algorithm family to use on ingested read sets.
      required:
      - id
      - arn
      - creationTime
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)