AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Omics CreateWorkflow API operation.

Syntax

New-OMICSWorkflow
-Accelerator <Accelerators>
-DefinitionRepository_ConnectionArn <String>
-ContainerRegistryMapUri <String>
-DefinitionUri <String>
-DefinitionZip <Byte[]>
-Description <String>
-Engine <WorkflowEngine>
-DefinitionRepository_ExcludeFilePattern <String[]>
-DefinitionRepository_FullRepositoryId <String>
-ContainerRegistryMap_ImageMapping <ImageMapping[]>
-Main <String>
-Name <String>
-ParameterTemplate <Hashtable>
-ParameterTemplatePath <String>
-ReadmeMarkdown <String>
-ReadmePath <String>
-ReadmeUri <String>
-ContainerRegistryMap_RegistryMapping <RegistryMapping[]>
-RequestId <String>
-StorageCapacity <Int32>
-StorageType <StorageType>
-Tag <Hashtable>
-SourceReference_Type <SourceReferenceType>
-SourceReference_Value <String>
-WorkflowBucketOwnerId <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonOmicsConfig>

Description

Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:
  • Workflow definition files: Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format.
  • (Optional) Parameter template: You can create a parameter template file that defines the run parameters, or Amazon Web Services HealthOmics can generate the parameter template for you.
  • ECR container images: Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository.
  • (Optional) Sentieon licenses: Request a Sentieon license if using the Sentieon software in a private workflow.
For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Parameters

-Accelerator <Accelerators>
The computational accelerator specified to run the workflow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccelerators
-ClientConfig <AmazonOmicsConfig>
Amazon.PowerShell.Cmdlets.OMICS.AmazonOmicsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerRegistryMap_ImageMapping <ImageMapping[]>
Image mappings specify path mappings between the ECR private repository and their corresponding external repositories. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainerRegistryMap_ImageMappings
-ContainerRegistryMap_RegistryMapping <RegistryMapping[]>
Mapping that provides the ECR repository path where upstream container images are pulled and synchronized. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainerRegistryMap_RegistryMappings
-ContainerRegistryMapUri <String>
(Optional) URI of the S3 location for the registry mapping file.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefinitionRepository_ConnectionArn <String>
The Amazon Resource Name (ARN) of the connection to the source code repository.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefinitionRepository_ExcludeFilePattern <String[]>
A list of file patterns to exclude when retrieving the workflow definition from the repository. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinitionRepository_ExcludeFilePatterns
-DefinitionRepository_FullRepositoryId <String>
The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefinitionUri <String>
The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefinitionZip <Byte[]>
A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the Amazon Web Services HealthOmics User Guide.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description for the workflow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Engine <WorkflowEngine>
The workflow engine for the workflow. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Main <String>
The path of the main definition file for the workflow. 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: workflow-definition/main-file.wdl.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParameterTemplate <Hashtable>
A parameter template for the workflow. 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 Parameter template files in the Amazon Web Services HealthOmics User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParameterTemplatePath <String>
The path to the workflow parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow. If not specified, the workflow will be created without a parameter template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReadmeMarkdown <String>
The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReadmePath <String>
The path to the workflow 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReadmeUri <String>
The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. Requirements include:
  • The S3 URI must begin with s3://USER-OWNED-BUCKET/
  • The requester must have access to the S3 bucket and object.
  • The max README content length is 500 KiB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequestId <String>
An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Omics.Model.CreateWorkflowResponse). Specifying the name of a property of type Amazon.Omics.Model.CreateWorkflowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceReference_Type <SourceReferenceType>
The type of source reference, such as branch, tag, or commit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinitionRepository_SourceReference_Type
-SourceReference_Value <String>
The value of the source reference, such as the branch name, tag name, or commit ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinitionRepository_SourceReference_Value
-StorageCapacity <Int32>
The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <StorageType>
The default storage type for runs that use this workflow. The storageType can be overridden at run time. DYNAMIC 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 Run storage types in the Amazon Web Services HealthOmics User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
Tags for the workflow. You can define up to 50 tags for the workflow. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-WorkflowBucketOwnerId <String>
The Amazon Web Services account ID of the expected owner of the S3 bucket that contains the workflow definition. If not specified, the service skips the validation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Omics.Model.CreateWorkflowResponse
This cmdlet returns an Amazon.Omics.Model.CreateWorkflowResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z