LogoLogo
  • Overview
  • publisher
    • Introduction
    • Getting Started
      • Logging in to Publisher
    • Data Sources
      • Connecting a Data Source
      • Managing a Data Source
      • Connectors
        • AWS S3 Permissions
        • Connecting to AWS S3 Storage
        • Google Cloud Storage (GCS) Permissions
        • Connecting to Google Cloud Storage
        • PostgreSQL Permissions
        • Connecting to PostgreSQL
        • PostgreSQL on Azure Permissions
        • Microsoft Azure Blob Storage Permissions
        • Connecting to Microsoft Azure Blob Storage
        • Connecting to HTTPS
        • Connecting to other sources via Trino
          • BigQuery
    • Collections
      • Creating a Collection
      • Sharing a Collection
      • Collection Filters
      • Editing Collection Metadata
      • Updating Collection Contents
    • Access Policies
      • Creating an Access Policy
      • Managing Access Policies
    • Questions
      • Adding Questions
      • Example Question
    • Settings
      • Viewing Current and Past Administrators
      • Adding an Administrator
      • Removing an Administrator
      • Setting Notification Preferences
  • Explorer
    • Introduction
    • Viewing a Collection
    • Browsing Collections
    • Asking Questions
    • Accessing a Private Collection
      • Requesting Access to a Private Collection
    • Filtering Data in Tables
      • Strings
      • Dates
      • Numbers
  • Workbench
    • Introduction
    • Getting Started
      • Logging into Workbench
      • Connecting an Engine
      • Finding or Importing a Workflow
      • Configuring Workflow Inputs
      • Running and Monitoring a Workflow
      • Locating Outputs
    • Engines
      • Adding and Updating an Engine
        • On AWS HealthOmics
        • On Microsoft Azure
        • On Google Cloud Platform
        • On Premises
      • Parameters
        • AWS HealthOmics
        • Google Cloud Platform
        • Microsoft Azure
        • On-Premises
        • Cromwell
        • Amazon Genomics CLI
    • Workflows
      • Finding Workflows
      • Adding a Workflow
      • Supported Languages
      • Repositories
        • Dockstore
    • Instruments
      • Getting Started with Instruments
      • Connecting a Storage Account
      • Using Sample Data in a Workflow
      • Running Workflows Using Samples
      • Family Based Analysis with Pedigree Information
      • Monitor the Workflow
      • CLI Reference
        • Instruments
        • Storage
        • Samples
        • OpenAPI Specification
    • Entities
    • Terminology
  • Passport
    • Introduction
    • Registering an Email Address for a Google Identity
  • Command Line Interface
    • Installation
    • Usage Examples
    • Working with JSON Data
    • Reference
      • workbench
        • runs submit
        • runs list
        • runs describe
        • runs cancel
        • runs delete
        • runs logs
        • runs tasks list
        • runs events list
        • engines list
        • engines describe
        • engines parameters list
        • engines parameters describe
        • engines health-checks list
        • workflows create
        • workflows list
        • workflows describe
        • workflows update
        • workflows delete
        • workflows versions create
        • workflows versions list
        • workflows versions describe
        • workflows versions files
        • workflows versions update
        • workflows versions delete
        • workflows versions defaults create
        • workflows versions defaults list
        • workflows versions defaults describe
        • workflows versions defaults update
        • workflows versions defaults delete
        • namespaces get-default
        • storage add
        • storage delete
        • storage describe
        • storage list
        • storage update
        • storage platforms add
        • storage platforms delete
        • storage platforms describe
        • storage platforms list
        • samples list
        • samples describe
        • samples files list
      • publisher
        • datasources list
  • Analysis
    • Python Library
    • Popular Environments
      • Cromwell
      • CWL Tool
      • Terra
      • Nextflow
      • DNAnexus
Powered by GitBook

© DNAstack. All rights reserved.

On this page
  • Synopsis
  • Update Workflow Defaults
  • Description
  • Examples
  • Positional Arguments
  • DEFAULT_ID=STRING
  • Flags
  • --namespace=STRING
  • --workflow=STRING
  • --version=STRING
  • --name=STRING
  • --engine=STRING
  • --provider=STRING
  • --region=STRING
  • --values=JSON

Was this helpful?

  1. Command Line Interface
  2. Reference
  3. workbench

workflows versions defaults update

Update workflow defaults for a given default ID

Synopsis

Update Workflow Defaults

omics workbench workflows versions defaults update DEFAULT_ID
[--namespace=NAMESPACE]
[--workflow=WORKFLOW_ID]
[--version=VERSION_ID]
[--name=NAME]
[--engine=ENGINE]
[--provider=PROVIDER]
[--region=REGION]
[--values=VALUES]

Description

Update an existing workflow default for a given default ID. Updating completely replaces the old defaults. You can modify properties like name, engine, provider, region, or values for the specified workflow default.

Examples

Update the name and values of a workflow default:

omics workbench workflows versions defaults update default-id-1 --name new-default-name --values '{"input1": "new_value"}'

Update the engine and provider of a workflow default:

omics workbench workflows versions defaults update default-id-1 --name "foo" --provider new-provider --values @defaults.json

Positional Arguments

DEFAULT_ID=STRING

The ID of the workflow default to be updated. This positional argument is required.

Flags

--namespace=STRING

An optional flag to define the namespace to connect to. By default, the namespace is extracted from the user's credentials.

--workflow=STRING

The ID of the workflow for which the defaults will be updated.

--version=STRING

The ID of the workflow version for which the defaults will be updated.

--name=STRING

The new name for the workflow default.

--engine=STRING

The selector to use when updating the defaults. This can be used to target a specific execution engine.

--provider=STRING

The provider selector to use when updating the defaults. This helps in specifying the backend provider.

--region=STRING

The region selector to use when updating the defaults. This helps in specifying the region for execution.

--values=JSON

The configuration values to use when updating the defaults. This must be a non-empty JSON object that contains key-value pairs for the workflow inputs.

Previousworkflows versions defaults describeNextworkflows versions defaults delete

Last updated 6 months ago

Was this helpful?