DefaultRunSetting ¶

class DefaultRunSetting(TypedDict, closed=True):
    workflow_id: "capo_omics.types.workflow_id.WorkflowId"
    """<p>The identifier of the workflow to run.</p>"""
    workflow_type: NotRequired["capo_omics.types.workflow_type.WorkflowType"]
    """<p>The type of the originating workflow. Batch runs are not supported with <code>READY2RUN</code> workflows.</p>"""
    role_arn: "capo_omics.types.run_role_arn.RunRoleArn"
    """<p>The IAM role ARN that grants HealthOmics permissions to access required Amazon Web Services resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual <code>StartRun</code> calls.</p>"""
    name: NotRequired["capo_omics.types.run_name.RunName"]
    """<p>An optional user-friendly name applied to each workflow run. Can be overridden per run.</p>"""
    cache_id: NotRequired["capo_omics.types.numeric_id_in_arn.NumericIdInArn"]
    """<p>The identifier of the run cache to associate with the runs.</p>"""
    cache_behavior: NotRequired["capo_omics.types.cache_behavior.CacheBehavior"]
    """<p>The cache behavior for the runs. Requires <code>cacheId</code> to be set.</p>"""
    run_group_id: NotRequired["capo_omics.types.run_group_id.RunGroupId"]
    """<p>The ID of the run group to contain all workflow runs in the batch.</p>"""
    priority: NotRequired["int"]
    """<p>An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.</p>"""
    parameters: NotRequired["capo_omics.types.run_parameters.RunParameters"]
    """<p>Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.</p>"""
    storage_capacity: NotRequired["int"]
    """<p>The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.</p>"""
    output_uri: NotRequired["capo_omics.types.run_output_uri.RunOutputUri"]
    """<p>The destination S3 URI for workflow outputs. Must begin with <code>s3://</code>. The <code>roleArn</code> must grant write permissions to this bucket. Can be overridden per run.</p>"""
    log_level: NotRequired["capo_omics.types.run_log_level.RunLogLevel"]
    """<p>The verbosity level for CloudWatch Logs emitted during each run.</p>"""
    run_tags: NotRequired["capo_omics.types.tag_map.TagMap"]
    """<p>Amazon Web Services tags to associate with each workflow run. Merged with per-run <code>runTags</code>; run-specific values take precedence when keys overlap.</p>"""
    retention_mode: NotRequired["capo_omics.types.run_retention_mode.RunRetentionMode"]
    """<p>The retention behavior for runs after completion.</p>"""
    storage_type: NotRequired["capo_omics.types.storage_type.StorageType"]
    """<p>The storage type for the workflow runs.</p>"""
    workflow_owner_id: NotRequired["capo_omics.types.workflow_owner_id.WorkflowOwnerId"]
    """<p>The Amazon Web Services account ID of the workflow owner, used for cross-account workflow sharing.</p>"""
    output_bucket_owner_id: NotRequired["capo_omics.types.aws_account_id.AwsAccountId"]
    """<p>The expected Amazon Web Services account ID of the owner of the output S3 bucket. Can be overridden per run.</p>"""
    workflow_version_name: NotRequired[
        "capo_omics.types.workflow_version_name.WorkflowVersionName"
    ]
    """<p>The version name of the specified workflow.</p>"""
    networking_mode: NotRequired["capo_omics.types.networking_mode.NetworkingMode"]
    """<p>Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.</p>"""
    configuration_name: NotRequired[
        "capo_omics.types.configuration_name.ConfigurationName"
    ]
    """<p>Optional configuration name to use for the workflow run.</p>"""
    session_policy: NotRequired["capo_omics.types.session_policy.SessionPolicy"]
    """<p>Optional inline policy json for scoping down permissions via a session policy on the IAM role provided in the roleArn parameter.</p>"""
    engine_settings: NotRequired["capo_omics.types.engine_settings.EngineSettings"]
    """<p>Engine-specific settings for the workflow run. Use this field to specify configuration options that are specific to the workflow engine (for example, Nextflow profiles).</p>"""
    scratch_storage_mode: NotRequired[
        "capo_omics.types.scratch_storage_mode.ScratchStorageMode"
    ]
    """<p>Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If not specified, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.</p>"""