Skip to content

GetRunResponse

Source code in docs_src/capo_omics/types/get_run_response.py
class GetRunResponse(TypedDict, closed=True):
    arn: NotRequired["capo_omics.types.run_arn.RunArn"]
    """<p>The run's ARN.</p>"""
    id: NotRequired["capo_omics.types.run_id.RunId"]
    """<p>The run's ID.</p>"""
    cache_id: NotRequired["capo_omics.types.numeric_id_in_arn.NumericIdInArn"]
    """<p>The run cache associated with the run.</p>"""
    cache_behavior: NotRequired["capo_omics.types.cache_behavior.CacheBehavior"]
    """<p>The run cache behavior for the run.</p>"""
    engine_version: NotRequired["capo_omics.types.engine_version.EngineVersion"]
    """<p>The actual Nextflow engine version that Amazon Web Services HealthOmics used for the run. The other workflow definition languages don't provide a value for this field.</p>"""
    status: NotRequired["capo_omics.types.run_status.RunStatus"]
    """<p>The run's status.</p>"""
    workflow_id: NotRequired["capo_omics.types.workflow_id.WorkflowId"]
    """<p>The run's workflow ID.</p>"""
    workflow_type: NotRequired["capo_omics.types.workflow_type.WorkflowType"]
    """<p>The run's workflow type.</p>"""
    run_id: NotRequired["capo_omics.types.run_id.RunId"]
    """<p>The run's ID.</p>"""
    role_arn: NotRequired["capo_omics.types.run_role_arn.RunRoleArn"]
    """<p>The run's service role ARN.</p>"""
    name: NotRequired["capo_omics.types.run_name.RunName"]
    """<p>The run's name.</p>"""
    run_group_id: NotRequired["capo_omics.types.run_group_id.RunGroupId"]
    """<p>The run's group ID.</p>"""
    batch_id: NotRequired["capo_omics.types.batch_id.BatchId"]
    """<p>The run's batch ID.</p>"""
    priority: NotRequired["int"]
    """<p>The run's priority.</p>"""
    definition: NotRequired["capo_omics.types.workflow_definition.WorkflowDefinition"]
    """<p>The run's definition.</p>"""
    digest: NotRequired["capo_omics.types.workflow_digest.WorkflowDigest"]
    """<p>The run's digest.</p>"""
    parameters: NotRequired["capo_omics.types.run_parameters.RunParameters"]
    """<p>The run's parameters.</p>"""
    storage_capacity: NotRequired["int"]
    """<p>The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.</p>"""
    output_uri: NotRequired["capo_omics.types.run_output_uri.RunOutputUri"]
    """<p>The run's output URI.</p>"""
    log_level: NotRequired["capo_omics.types.run_log_level.RunLogLevel"]
    """<p>The run's log level.</p>"""
    resource_digests: NotRequired[
        "capo_omics.types.run_resource_digests.RunResourceDigests"
    ]
    """<p>The run's resource digests.</p>"""
    started_by: NotRequired["capo_omics.types.run_started_by.RunStartedBy"]
    """<p>Who started the run.</p>"""
    creation_time: NotRequired["capo_omics.types.run_timestamp.RunTimestamp"]
    """<p>When the run was created.</p>"""
    start_time: NotRequired["capo_omics.types.run_timestamp.RunTimestamp"]
    """<p>When the run started.</p>"""
    stop_time: NotRequired["capo_omics.types.run_timestamp.RunTimestamp"]
    """<p>The run's stop time.</p>"""
    status_message: NotRequired["capo_omics.types.run_status_message.RunStatusMessage"]
    """<p>The run's status message.</p>"""
    tags: NotRequired["capo_omics.types.tag_map.TagMap"]
    """<p>The run's tags.</p>"""
    accelerators: NotRequired["capo_omics.types.accelerators.Accelerators"]
    """<p>The computational accelerator used to run the workflow.</p>"""
    retention_mode: NotRequired["capo_omics.types.run_retention_mode.RunRetentionMode"]
    """<p>The run's retention mode.</p>"""
    failure_reason: NotRequired["capo_omics.types.run_failure_reason.RunFailureReason"]
    """<p>The reason a run has failed.</p>"""
    log_location: NotRequired["capo_omics.types.run_log_location.RunLogLocation"]
    """<p>The location of the run log.</p>"""
    uuid: NotRequired["capo_omics.types.run_uuid.RunUuid"]
    """<p>The universally unique identifier for a run.</p>"""
    run_output_uri: NotRequired["capo_omics.types.run_output_uri.RunOutputUri"]
    """<p>The destination for workflow outputs.</p>"""
    storage_type: NotRequired["capo_omics.types.storage_type.StorageType"]
    """<p>The run's storage type.</p>"""
    workflow_owner_id: NotRequired["capo_omics.types.workflow_owner_id.WorkflowOwnerId"]
    """<p>The ID of the workflow owner.</p>"""
    workflow_version_name: NotRequired[
        "capo_omics.types.workflow_version_name.WorkflowVersionName"
    ]
    """<p>The workflow version name.</p>"""
    workflow_uuid: NotRequired["capo_omics.types.workflow_uuid.WorkflowUuid"]
    """<p>The universally unique identifier (UUID) value for the workflow.</p>"""
    networking_mode: NotRequired["capo_omics.types.networking_mode.NetworkingMode"]
    """<p>Configuration for run networking behavior. If absent, this will default to RESTRICTED.</p>"""
    scratch_storage_mode: NotRequired[
        "capo_omics.types.scratch_storage_mode.ScratchStorageMode"
    ]
    """<p>Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If absent, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.</p>"""
    configuration: NotRequired[
        "capo_omics.types.configuration_details.ConfigurationDetails"
    ]
    """<p>Configuration details for the workflow run.</p>"""
    vpc_config: NotRequired["capo_omics.types.vpc_config_response.VpcConfigResponse"]
    """<p>VPC configuration for the workflow run.</p>"""
    engine_settings: NotRequired["capo_omics.types.engine_settings.EngineSettings"]
    """<p>The engine-specific settings for the workflow run.</p>"""
    session_policy: NotRequired["capo_omics.types.session_policy.SessionPolicy"]
    """<p>Inline policy json for scoping down permissions via a session policy on the IAM role.</p>"""

accelerators instance-attribute

accelerators: NotRequired[Accelerators]

The computational accelerator used to run the workflow.

arn instance-attribute

arn: NotRequired[RunArn]

The run's ARN.

batch_id instance-attribute

batch_id: NotRequired[BatchId]

The run's batch ID.

cache_behavior instance-attribute

cache_behavior: NotRequired[CacheBehavior]

The run cache behavior for the run.

cache_id instance-attribute

cache_id: NotRequired[NumericIdInArn]

The run cache associated with the run.

configuration instance-attribute

configuration: NotRequired[ConfigurationDetails]

Configuration details for the workflow run.

creation_time instance-attribute

creation_time: NotRequired[RunTimestamp]

When the run was created.

definition instance-attribute

definition: NotRequired[WorkflowDefinition]

The run's definition.

digest instance-attribute

digest: NotRequired[WorkflowDigest]

The run's digest.

engine_settings instance-attribute

engine_settings: NotRequired[EngineSettings]

The engine-specific settings for the workflow run.

engine_version instance-attribute

engine_version: NotRequired[EngineVersion]

The actual Nextflow engine version that Amazon Web Services HealthOmics used for the run. The other workflow definition languages don't provide a value for this field.

failure_reason instance-attribute

failure_reason: NotRequired[RunFailureReason]

The reason a run has failed.

id instance-attribute

id: NotRequired[RunId]

The run's ID.

log_level instance-attribute

log_level: NotRequired[RunLogLevel]

The run's log level.

log_location instance-attribute

log_location: NotRequired[RunLogLocation]

The location of the run log.

name instance-attribute

name: NotRequired[RunName]

The run's name.

networking_mode instance-attribute

networking_mode: NotRequired[NetworkingMode]

Configuration for run networking behavior. If absent, this will default to RESTRICTED.

output_uri instance-attribute

output_uri: NotRequired[RunOutputUri]

The run's output URI.

parameters instance-attribute

parameters: NotRequired[RunParameters]

The run's parameters.

priority instance-attribute

priority: NotRequired[int]

The run's priority.

resource_digests instance-attribute

resource_digests: NotRequired[RunResourceDigests]

The run's resource digests.

retention_mode instance-attribute

retention_mode: NotRequired[RunRetentionMode]

The run's retention mode.

role_arn instance-attribute

role_arn: NotRequired[RunRoleArn]

The run's service role ARN.

run_group_id instance-attribute

run_group_id: NotRequired[RunGroupId]

The run's group ID.

run_id instance-attribute

run_id: NotRequired[RunId]

The run's ID.

run_output_uri instance-attribute

run_output_uri: NotRequired[RunOutputUri]

The destination for workflow outputs.

scratch_storage_mode instance-attribute

scratch_storage_mode: NotRequired[ScratchStorageMode]

Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If absent, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.

session_policy instance-attribute

session_policy: NotRequired[SessionPolicy]

Inline policy json for scoping down permissions via a session policy on the IAM role.

start_time instance-attribute

start_time: NotRequired[RunTimestamp]

When the run started.

started_by instance-attribute

started_by: NotRequired[RunStartedBy]

Who started the run.

status instance-attribute

status: NotRequired[RunStatus]

The run's status.

status_message instance-attribute

status_message: NotRequired[RunStatusMessage]

The run's status message.

stop_time instance-attribute

stop_time: NotRequired[RunTimestamp]

The run's stop time.

storage_capacity instance-attribute

storage_capacity: NotRequired[int]

The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

storage_type instance-attribute

storage_type: NotRequired[StorageType]

The run's storage type.

tags instance-attribute

tags: NotRequired[TagMap]

The run's tags.

uuid instance-attribute

uuid: NotRequired[RunUuid]

The universally unique identifier for a run.

vpc_config instance-attribute

vpc_config: NotRequired[VpcConfigResponse]

VPC configuration for the workflow run.

workflow_id instance-attribute

workflow_id: NotRequired[WorkflowId]

The run's workflow ID.

workflow_owner_id instance-attribute

workflow_owner_id: NotRequired[WorkflowOwnerId]

The ID of the workflow owner.

workflow_type instance-attribute

workflow_type: NotRequired[WorkflowType]

The run's workflow type.

workflow_uuid instance-attribute

workflow_uuid: NotRequired[WorkflowUuid]

The universally unique identifier (UUID) value for the workflow.

workflow_version_name instance-attribute

workflow_version_name: NotRequired[WorkflowVersionName]

The workflow version name.