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-runcache-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

openapi: 3.2.0
info:
  title: Amazon Omics Runcache 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: []
tags:
- name: Runcache
paths:
  /runCache:
    post:
      operationId: CreateRunCache
      summary: Create Run Cache
      description: Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file. For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRunCacheResponse'
        '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'
        '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/CreateRunCacheRequest'
      tags:
      - Runcache
    get:
      operationId: ListRunCaches
      summary: List Run Caches
      description: Retrieves a list of your run caches and the metadata for each cache.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRunCachesResponse'
        '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'
        '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/ListRunCachesRequest'
      tags:
      - Runcache
  /runCache/{id}:
    get:
      operationId: GetRunCache
      summary: Get Run Cache
      description: Retrieves detailed information about the specified run cache using its ID. For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRunCacheResponse'
        '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'
        '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/GetRunCacheRequest'
      tags:
      - Runcache
    post:
      operationId: UpdateRunCache
      summary: Update Run Cache
      description: Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with CACHE_ON_FAILURE or CACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use the GetRunCache API operation. For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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'
        '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/UpdateRunCacheRequest'
      tags:
      - Runcache
    delete:
      operationId: DeleteRunCache
      summary: Delete Run Cache
      description: Deletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations. For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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'
        '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/DeleteRunCacheRequest'
      tags:
      - Runcache
components:
  schemas:
    GetRunCacheResponse:
      type: object
      properties:
        arn:
          type: string
          description: Unique resource identifier for the run cache.
        cacheBehavior:
          type: string
          description: The default cache behavior for runs using this cache.
        cacheBucketOwnerId:
          type: string
          description: The identifier of the bucket owner.
        cacheS3Uri:
          type: string
          description: The S3 URI where the cache data is stored.
        creationTime:
          type: string
          format: date-time
          description: Creation time of the run cache (an ISO 8601 formatted string).
        description:
          type: string
          description: The run cache description.
        id:
          type: string
          description: The run cache ID.
        name:
          type: string
          description: The run cache name.
        status:
          type: string
          description: The run cache status.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated with the run cache.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetRunCacheRequest:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the run cache to retrieve.
      required:
      - id
    ListRunCachesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/RunCacheListItem'
          description: Details about each run cache in the response.
        nextToken:
          type: string
          description: Pagination token to retrieve additional run caches. If the response does not have a nextTokenvalue, you have reached to the end of the list.
    RequestTimeoutException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListRunCachesRequest:
      type: object
      properties:
        maxResults:
          type: integer
          description: The maximum number of results to return.
        startingToken:
          type: string
          description: Optional pagination token returned from a prior call to the ListRunCaches API operation.
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateRunCacheRequest:
      type: object
      properties:
        cacheBehavior:
          type: string
          description: 'Default cache behavior for runs that use this cache. Supported values are: CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you''re debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run. CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting. If you don''t specify a '
        cacheS3Location:
          type: string
          description: Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).
        description:
          type: string
          description: Enter a description of the run cache.
        name:
          type: string
          description: Enter a user-friendly name for the run cache.
        requestId:
          type: string
          description: A unique request token, to ensure idempotency. If you don't specify a token, Amazon Web Services HealthOmics automatically generates a universally unique identifier (UUID) for the request.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Specify one or more tags to associate with this run cache.
        cacheBucketOwnerId:
          type: string
          description: The Amazon Web Services account ID of the expected owner of the S3 bucket for the run cache. If not provided, your account ID is set as the owner of the bucket.
      required:
      - cacheS3Location
      - requestId
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateRunCacheRequest:
      type: object
      properties:
        cacheBehavior:
          type: string
          description: Update the default run cache behavior.
        description:
          type: string
          description: Update the run cache description.
        id:
          type: string
          description: The identifier of the run cache you want to update.
        name:
          type: string
          description: Update the name of the run cache.
      required:
      - id
    CreateRunCacheResponse:
      type: object
      properties:
        arn:
          type: string
          description: Unique resource identifier for the run cache.
        id:
          type: string
          description: Identifier for the run cache.
        status:
          type: string
          description: Run cache status.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated with this run cache.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    RunCacheListItem:
      type: object
      properties:
        arn:
          type: string
          description: Unique resource identifier for the run cache.
        cacheBehavior:
          type: string
          description: Default cache behavior for the run cache.
        cacheS3Uri:
          type: string
          description: The S3 uri for the run cache data.
        creationTime:
          type: string
          format: date-time
          description: The time that this run cache was created (an ISO 8601 formatted string).
        id:
          type: string
          description: The identifier for this run cache.
        name:
          type: string
          description: The name of the run cache.
        status:
          type: string
          description: The run cache status.
    DeleteRunCacheRequest:
      type: object
      properties:
        id:
          type: string
          description: Run cache identifier for the cache you want to delete.
      required:
      - id
  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)