Omics / Client / create_run_cache

create_run_cache#

Omics.Client.create_run_cache(**kwargs)#

You can create a run cache to save the task outputs from completed tasks in a run for a private workflow. Subsequent runs use the task outputs from the cache, rather than computing the task outputs again. You specify an Amazon S3 location where HealthOmics saves the cached data. This data must be immediately accessible (not in an archived state).

For more information, see Creating a run cache in the AWS HealthOmics User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_run_cache(
    cacheBehavior='CACHE_ON_FAILURE'|'CACHE_ALWAYS',
    cacheS3Location='string',
    description='string',
    name='string',
    requestId='string',
    tags={
        'string': 'string'
    },
    cacheBucketOwnerId='string'
)
Parameters:

  • cacheBehavior (string) –

    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 AWS HealthOmics User Guide.

  • cacheS3Location (string) –

    [REQUIRED]

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

  • description (string) – Enter a description of the run cache.

  • name (string) – Enter a user-friendly name for the run cache.

  • requestId (string) –

    [REQUIRED]

    A unique request token, to ensure idempotency. If you don’t specify a token, HealthOmics automatically generates a universally unique identifier (UUID) for the request.

    This field is autopopulated if not provided.

  • tags (dict) –

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

    • (string) –

      • (string) –

  • cacheBucketOwnerId (string) – The AWS 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.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'status': 'ACTIVE'|'DELETED'|'FAILED',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • arn (string) –

      Unique resource identifier for the run cache.

    • id (string) –

      Identifier for the run cache.

    • status (string) –

      Run cache status.

    • tags (dict) –

      The tags associated with this run cache.

      • (string) –

        • (string) –

Exceptions