Create Run Cache

omics_create_run_cache

R Documentation

Creates a run cache to store and reference task outputs from completed private runs¶

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.

Usage¶

omics_create_run_cache(cacheBehavior, cacheS3Location, description,
  name, requestId, tags, cacheBucketOwnerId)

Arguments¶

cacheBehavior

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 value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

cacheS3Location

[required] Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).

description

Enter a description of the run cache.

name

Enter a user-friendly name for the run cache.

requestId

[required] 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

Specify one or more tags to associate with this run cache.

cacheBucketOwnerId

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.

Value¶

A list with the following syntax:

list(
  arn = "string",
  id = "string",
  status = "ACTIVE"|"DELETED"|"FAILED",
  tags = list(
    "string"
  )
)

Request syntax¶

svc$create_run_cache(
  cacheBehavior = "CACHE_ON_FAILURE"|"CACHE_ALWAYS",
  cacheS3Location = "string",
  description = "string",
  name = "string",
  requestId = "string",
  tags = list(
    "string"
  ),
  cacheBucketOwnerId = "string"
)