Skip to content

GetWorkflowVersionResponse

Source code in docs_src/capo_omics/types/get_workflow_version_response.py
class GetWorkflowVersionResponse(TypedDict, closed=True):
    arn: NotRequired["capo_omics.types.workflow_version_arn.WorkflowVersionArn"]
    """<p>ARN of the workflow version.</p>"""
    workflow_id: NotRequired["capo_omics.types.workflow_id.WorkflowId"]
    """<p>The workflow's ID.</p>"""
    version_name: NotRequired[
        "capo_omics.types.workflow_version_name.WorkflowVersionName"
    ]
    """<p>The workflow version name.</p>"""
    accelerators: NotRequired["capo_omics.types.accelerators.Accelerators"]
    """<p>The accelerator for this workflow version.</p>"""
    creation_time: NotRequired["capo_omics.types.workflow_timestamp.WorkflowTimestamp"]
    """<p>When the workflow version was created.</p>"""
    description: NotRequired[
        "capo_omics.types.workflow_version_description.WorkflowVersionDescription"
    ]
    """<p>Description of the workflow version.</p>"""
    definition: NotRequired["capo_omics.types.workflow_definition.WorkflowDefinition"]
    """<p>Definition of the workflow version.</p>"""
    digest: NotRequired["capo_omics.types.workflow_digest.WorkflowDigest"]
    """<p>The workflow version's digest.</p>"""
    engine: NotRequired["capo_omics.types.workflow_engine.WorkflowEngine"]
    """<p>The workflow engine for this workflow version.</p>"""
    main: NotRequired["capo_omics.types.workflow_main.WorkflowMain"]
    """<p>The path of the main definition file for the workflow.</p>"""
    metadata: NotRequired["capo_omics.types.workflow_metadata.WorkflowMetadata"]
    """<p>The metadata for the workflow version.</p>"""
    parameter_template: NotRequired[
        "capo_omics.types.workflow_parameter_template.WorkflowParameterTemplate"
    ]
    """<p>The parameter template for the workflow version.</p>"""
    status: NotRequired["capo_omics.types.workflow_status.WorkflowStatus"]
    """<p>The workflow version status</p>"""
    status_message: NotRequired[
        "capo_omics.types.workflow_status_message.WorkflowStatusMessage"
    ]
    """<p>The workflow version status message</p>"""
    storage_type: NotRequired["capo_omics.types.storage_type.StorageType"]
    """<p>The default storage type for the run.</p>"""
    storage_capacity: NotRequired["int"]
    """<p>The default run storage capacity for static storage.</p>"""
    type: NotRequired["capo_omics.types.workflow_type.WorkflowType"]
    """<p>The workflow version type</p>"""
    tags: NotRequired["capo_omics.types.tag_map.TagMap"]
    """<p>The workflow version tags</p>"""
    uuid: NotRequired["capo_omics.types.workflow_uuid.WorkflowUuid"]
    """<p>The universally unique identifier (UUID) value for this workflow version</p>"""
    workflow_bucket_owner_id: NotRequired[
        "capo_omics.types.workflow_bucket_owner_id.WorkflowBucketOwnerId"
    ]
    """<p>Amazon Web Services Id of the owner of the bucket.</p>"""
    container_registry_map: NotRequired[
        "capo_omics.types.container_registry_map.ContainerRegistryMap"
    ]
    """<p>The registry map that this workflow version uses.</p>"""
    readme: NotRequired["capo_omics.types.readme_s3_presigned_url.ReadmeS3PresignedUrl"]
    """<p>The README content for the workflow version, providing documentation and usage information specific to this version.</p>"""
    definition_repository_details: NotRequired[
        "capo_omics.types.definition_repository_details.DefinitionRepositoryDetails"
    ]
    """<p>Details about the source code repository that hosts the workflow version definition files.</p>"""
    readme_path: NotRequired["capo_omics.types.readme_path.ReadmePath"]
    """<p>The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the <code>README.md</code> file from the root directory of the repository will be used.</p>"""
    profiles: NotRequired["capo_omics.types.workflow_profile_list.WorkflowProfileList"]
    """<p>The list of Nextflow profiles that are available for this workflow version. Profiles allow you to select predefined configuration settings at runtime.</p>"""
    profile_parameter_templates: NotRequired[
        "capo_omics.types.workflow_profile_parameter_templates.WorkflowProfileParameterTemplates"
    ]
    """<p>A mapping of profile names to their parameter templates. Each profile defines its own set of parameters that you can use when starting a run with that profile.</p>"""

accelerators instance-attribute

accelerators: NotRequired[Accelerators]

The accelerator for this workflow version.

arn instance-attribute

arn: NotRequired[WorkflowVersionArn]

ARN of the workflow version.

container_registry_map instance-attribute

container_registry_map: NotRequired[ContainerRegistryMap]

The registry map that this workflow version uses.

creation_time instance-attribute

creation_time: NotRequired[WorkflowTimestamp]

When the workflow version was created.

definition instance-attribute

definition: NotRequired[WorkflowDefinition]

Definition of the workflow version.

definition_repository_details instance-attribute

definition_repository_details: NotRequired[DefinitionRepositoryDetails]

Details about the source code repository that hosts the workflow version definition files.

description instance-attribute

description: NotRequired[WorkflowVersionDescription]

Description of the workflow version.

digest instance-attribute

digest: NotRequired[WorkflowDigest]

The workflow version's digest.

engine instance-attribute

engine: NotRequired[WorkflowEngine]

The workflow engine for this workflow version.

main instance-attribute

main: NotRequired[WorkflowMain]

The path of the main definition file for the workflow.

metadata instance-attribute

metadata: NotRequired[WorkflowMetadata]

The metadata for the workflow version.

parameter_template instance-attribute

parameter_template: NotRequired[WorkflowParameterTemplate]

The parameter template for the workflow version.

profile_parameter_templates instance-attribute

profile_parameter_templates: NotRequired[WorkflowProfileParameterTemplates]

A mapping of profile names to their parameter templates. Each profile defines its own set of parameters that you can use when starting a run with that profile.

profiles instance-attribute

profiles: NotRequired[WorkflowProfileList]

The list of Nextflow profiles that are available for this workflow version. Profiles allow you to select predefined configuration settings at runtime.

readme instance-attribute

readme: NotRequired[ReadmeS3PresignedUrl]

The README content for the workflow version, providing documentation and usage information specific to this version.

readme_path instance-attribute

readme_path: NotRequired[ReadmePath]

The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

status instance-attribute

status: NotRequired[WorkflowStatus]

The workflow version status

status_message instance-attribute

status_message: NotRequired[WorkflowStatusMessage]

The workflow version status message

storage_capacity instance-attribute

storage_capacity: NotRequired[int]

The default run storage capacity for static storage.

storage_type instance-attribute

storage_type: NotRequired[StorageType]

The default storage type for the run.

tags instance-attribute

tags: NotRequired[TagMap]

The workflow version tags

type instance-attribute

type: NotRequired[WorkflowType]

The workflow version type

uuid instance-attribute

uuid: NotRequired[WorkflowUuid]

The universally unique identifier (UUID) value for this workflow version

version_name instance-attribute

version_name: NotRequired[WorkflowVersionName]

The workflow version name.

workflow_bucket_owner_id instance-attribute

workflow_bucket_owner_id: NotRequired[WorkflowBucketOwnerId]

Amazon Web Services Id of the owner of the bucket.

workflow_id instance-attribute

workflow_id: NotRequired[WorkflowId]

The workflow's ID.