Skip to content

CreateRunCacheRequest

Source code in docs_src/capo_omics/types/create_run_cache_request.py
class CreateRunCacheRequest(TypedDict, closed=True):
    cache_behavior: NotRequired["capo_omics.types.cache_behavior.CacheBehavior"]
    """<p>Default cache behavior for runs that use this cache. Supported values are:</p> <p> <code>CACHE_ON_FAILURE</code>: 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.</p> <p> <code>CACHE_ALWAYS</code>: 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.</p> <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior">Run cache behavior</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>"""
    cache_s3_location: (
        "capo_omics.types.s3_uri_for_bucket_or_object.S3UriForBucketOrObject"
    )
    """<p>Specify the S3 location for storing the cached task outputs. This data must be immediately accessible (not in an archived state).</p>"""
    description: NotRequired[
        "capo_omics.types.user_custom_description.UserCustomDescription"
    ]
    """<p>Enter a description of the run cache.</p>"""
    name: NotRequired["capo_omics.types.user_custom_name.UserCustomName"]
    """<p>Enter a user-friendly name for the run cache.</p>"""
    request_id: "capo_omics.types.run_cache_request_id.RunCacheRequestId"
    """<p>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.</p>"""
    tags: NotRequired["capo_omics.types.tag_map.TagMap"]
    """<p>Specify one or more tags to associate with this run cache.</p>"""
    cache_bucket_owner_id: NotRequired["capo_omics.types.aws_account_id.AwsAccountId"]
    """<p>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.</p>"""

cache_behavior instance-attribute

cache_behavior: NotRequired[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.

cache_bucket_owner_id instance-attribute

cache_bucket_owner_id: NotRequired[AwsAccountId]

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.

cache_s3_location instance-attribute

cache_s3_location: S3UriForBucketOrObject

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

description instance-attribute

description: NotRequired[UserCustomDescription]

Enter a description of the run cache.

name instance-attribute

name: NotRequired[UserCustomName]

Enter a user-friendly name for the run cache.

request_id instance-attribute

request_id: RunCacheRequestId

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 instance-attribute

tags: NotRequired[TagMap]

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