create_workflow_version ¶

def create_workflow_version(
    self,
    workflow_id: "capo_omics.types.workflow_id.WorkflowId",
    version_name: "capo_omics.types.workflow_version_name.WorkflowVersionName",
    request_id: "capo_omics.types.workflow_request_id.WorkflowRequestId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    definition_zip: Optional[bytes] = None,
    definition_uri: Optional[
        "capo_omics.types.workflow_definition.WorkflowDefinition"
    ] = None,
    accelerators: Optional["capo_omics.types.accelerators.Accelerators"] = None,
    description: Optional[
        "capo_omics.types.workflow_version_description.WorkflowVersionDescription"
    ] = None,
    engine: Optional["capo_omics.types.workflow_engine.WorkflowEngine"] = None,
    main: Optional["capo_omics.types.workflow_main.WorkflowMain"] = None,
    parameter_template: Optional[
        "capo_omics.types.workflow_parameter_template.WorkflowParameterTemplate"
    ] = None,
    storage_type: Optional["capo_omics.types.storage_type.StorageType"] = None,
    storage_capacity: Optional[int] = None,
    tags: Optional["capo_omics.types.tag_map.TagMap"] = None,
    workflow_bucket_owner_id: Optional[
        "capo_omics.types.workflow_bucket_owner_id.WorkflowBucketOwnerId"
    ] = None,
    container_registry_map: Optional[
        "capo_omics.types.container_registry_map.ContainerRegistryMap"
    ] = None,
    container_registry_map_uri: Optional["capo_omics.types.uri.Uri"] = None,
    readme_markdown: Optional[
        "capo_omics.types.readme_markdown.ReadmeMarkdown"
    ] = None,
    parameter_template_path: Optional[
        "capo_omics.types.parameter_template_path.ParameterTemplatePath"
    ] = None,
    readme_path: Optional["capo_omics.types.readme_path.ReadmePath"] = None,
    definition_repository: Optional[
        "capo_omics.types.definition_repository.DefinitionRepository"
    ] = None,
    readme_uri: Optional[
        "capo_omics.types.s3_uri_for_object.S3UriForObject"
    ] = None,
) -> "capo_omics.types.create_workflow_version_response.CreateWorkflowVersionResponse":
    """<p>Creates a new workflow version for the workflow that you specify with the <code>workflowId</code> parameter.</p> <p>When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.</p> <p>Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.</p> <note> <p>Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.</p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning in Amazon Web Services HealthOmics</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>

    Args:
        workflow_id: <p>The ID of the workflow where you are creating the new version. The <code>workflowId</code> is not the UUID.</p>
        version_name: <p>A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version. </p> <p>The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.</p>
        definition_zip: <p>A ZIP archive containing the main workflow definition file and dependencies that it imports for this workflow version. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
        definition_uri: <p>The S3 URI of a definition for this workflow version. The S3 bucket must be in the same region as this workflow version.</p>
        accelerators: <p>The computational accelerator for this workflow version.</p>
        description: <p>A description for this workflow version.</p>
        engine: <p>The workflow engine for this workflow version. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.</p>
        main: <p>The path of the main definition file for this workflow version. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: <code>workflow-definition/main-file.wdl</code>. </p>
        parameter_template: <p>A parameter template for this workflow version. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see <a href="https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html">Parameter template files</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
        request_id: <p>An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.</p>
        storage_type: <p>The default storage type for runs that use this workflow version. The <code>storageType</code> can be overridden at run time. <code>DYNAMIC</code> storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html">Run storage types</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
        storage_capacity: <p>The default static storage capacity (in gibibytes) for runs that use this workflow version. The <code>storageCapacity</code> can be overwritten at run time. The storage capacity is not required for runs with a <code>DYNAMIC</code> storage type.</p>
        tags: <p>Tags for this workflow version. You can define up to 50 tags for the workflow. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html">Adding a tag</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
        workflow_bucket_owner_id: <p>Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.</p>
        container_registry_map: <p>(Optional) Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html">Container images</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
        container_registry_map_uri: <p>(Optional) URI of the S3 location for the registry mapping file.</p>
        readme_markdown: <p>The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.</p>
        parameter_template_path: <p>The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.</p>
        readme_path: <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>
        definition_repository: <p>The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.</p>
        readme_uri: <p>The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include:</p> <ul> <li> <p>The S3 URI must begin with <code>s3://USER-OWNED-BUCKET/</code> </p> </li> <li> <p>The requester must have access to the S3 bucket and object.</p> </li> <li> <p>The max README content length is 500 KiB.</p> </li> </ul>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.conflict_exception.ConflictException: <p>The request cannot be applied to the target resource in its current state.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.create_workflow_version_request.CreateWorkflowVersionRequest]",
    ) -> OperationResponse[
        "capo_omics.types.create_workflow_version_response.CreateWorkflowVersionResponse"
    ]:
        import capo_omics._operations.omics.create_workflow_version

        output, http_response = (
            capo_omics._operations.omics.create_workflow_version.create_workflow_version(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateWorkflowVersion")
    )
    input_: capo_omics.types.create_workflow_version_request.CreateWorkflowVersionRequest = {
        "workflow_id": workflow_id,
        "version_name": version_name,
        "request_id": request_id,
    }
    if definition_zip is not None:
        input_["definition_zip"] = definition_zip
    if definition_uri is not None:
        input_["definition_uri"] = definition_uri
    if accelerators is not None:
        input_["accelerators"] = accelerators
    if description is not None:
        input_["description"] = description
    if engine is not None:
        input_["engine"] = engine
    if main is not None:
        input_["main"] = main
    if parameter_template is not None:
        input_["parameter_template"] = parameter_template
    if storage_type is not None:
        input_["storage_type"] = storage_type
    if storage_capacity is not None:
        input_["storage_capacity"] = storage_capacity
    if tags is not None:
        input_["tags"] = tags
    if workflow_bucket_owner_id is not None:
        input_["workflow_bucket_owner_id"] = workflow_bucket_owner_id
    if container_registry_map is not None:
        input_["container_registry_map"] = container_registry_map
    if container_registry_map_uri is not None:
        input_["container_registry_map_uri"] = container_registry_map_uri
    if readme_markdown is not None:
        input_["readme_markdown"] = readme_markdown
    if parameter_template_path is not None:
        input_["parameter_template_path"] = parameter_template_path
    if readme_path is not None:
        input_["readme_path"] = readme_path
    if definition_repository is not None:
        input_["definition_repository"] = definition_repository
    if readme_uri is not None:
        input_["readme_uri"] = readme_uri

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output