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 StartRun API operation.

Syntax

Start-OMICSRun
-RoleArn <String>
-CacheBehavior <CacheBehavior>
-CacheId <String>
-LogLevel <RunLogLevel>
-Name <String>
-OutputUri <String>
-Parameter <PSObject>
-Priority <Int32>
-RequestId <String>
-RetentionMode <RunRetentionMode>
-RunGroupId <String>
-RunId <String>
-StorageCapacity <Int32>
-StorageType <StorageType>
-Tag <Hashtable>
-WorkflowId <String>
-WorkflowOwnerId <String>
-WorkflowType <WorkflowType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonOmicsConfig>

Description

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run. StartRun will not support re-run for a workflow that is shared with you. HealthOmics stores a fixed number of runs that are available to the console and API. By default, HealthOmics doesn't any remove any runs. If HealthOmics reaches the maximum number of runs, you must manually remove runs. To have older runs removed automatically, set the retention mode to REMOVE. By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. You can set the storage type to DYNAMIC. You do not set storageCapacity, because HealthOmics dynamically scales the storage up or down as required. For more information about static and dynamic storage, see Running workflows in the AWS HealthOmics User Guide.

Parameters

-CacheBehavior <CacheBehavior>
The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the AWS HealthOmics User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheId <String>
Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonOmicsConfig>
Amazon.PowerShell.Cmdlets.OMICS.AmazonOmicsClientCmdlet.ClientConfig
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)
-LogLevel <RunLogLevel>
A log level for the run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
A name for the run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputUri <String>
An output URI for the run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Parameter <PSObject>
Parameters for the run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the RoleArn parameter. The -PassThru parameter is deprecated, use -Select '^RoleArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Priority <Int32>
A priority for the run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequestId <String>
To ensure that requests don't run multiple times, specify a unique ID for each request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RetentionMode <RunRetentionMode>
The retention mode for the run. The default value is RETAIN. HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.For more information about retention mode, see Specifying run retention mode in the AWS HealthOmics User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
A service role for the run.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-RunGroupId <String>
The run's group ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RunId <String>
The ID of a run to duplicate.
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.StartRunResponse). Specifying the name of a property of type Amazon.Omics.Model.StartRunResponse 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)
-StorageCapacity <Int32>
A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageType <StorageType>
The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
Tags for the run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-WorkflowId <String>
The run's workflow ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkflowOwnerId <String>
The ID of the workflow owner.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkflowType <WorkflowType>
The run's workflow type.
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.StartRunResponse
This cmdlet returns an Amazon.Omics.Model.StartRunResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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