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

Syntax

Start-OMICSRunBatch
-BatchName <String>
-DefaultRunSetting_CacheBehavior <CacheBehavior>
-DefaultRunSetting_CacheId <String>
-BatchRunSettings_InlineSetting <InlineSetting[]>
-DefaultRunSetting_LogLevel <RunLogLevel>
-DefaultRunSetting_Name <String>
-DefaultRunSetting_OutputBucketOwnerId <String>
-DefaultRunSetting_OutputUri <String>
-DefaultRunSetting_Parameter <PSObject>
-DefaultRunSetting_Priority <Int32>
-RequestId <String>
-DefaultRunSetting_RetentionMode <RunRetentionMode>
-DefaultRunSetting_RoleArn <String>
-DefaultRunSetting_RunGroupId <String>
-DefaultRunSetting_RunTag <Hashtable>
-BatchRunSettings_S3UriSetting <String>
-DefaultRunSetting_StorageCapacity <Int32>
-DefaultRunSetting_StorageType <StorageType>
-Tag <Hashtable>
-DefaultRunSetting_WorkflowId <String>
-DefaultRunSetting_WorkflowOwnerId <String>
-DefaultRunSetting_WorkflowType <WorkflowType>
-DefaultRunSetting_WorkflowVersionName <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonOmicsConfig>

Description

Starts a batch of workflow runs. You can group up to 100,000 runs into a single batch that share a common configuration defined in defaultRunSetting. Per-run overrides can be provided either inline via inlineSettings (up to 100 runs) or via a JSON file stored in Amazon S3 via s3UriSettings (up to 100,000 runs). StartRunBatch validates common fields synchronously and returns immediately with a batch ID and status PENDING. Runs are submitted gradually and asynchronously at a rate governed by your StartRun throughput quota.

Parameters

-BatchName <String>
An optional user-friendly name for the run batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BatchRunSettings_InlineSetting <InlineSetting[]>
A list of per-run configurations provided inline in the request. Each entry must include a unique runSettingId. Supports up to 100 entries. For batches with more than 100 runs, use s3UriSettings. 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)
AliasesBatchRunSettings_InlineSettings
-BatchRunSettings_S3UriSetting <String>
An Amazon S3 URI pointing to a JSON file containing per-run configurations. The file must be a JSON array in the same format as inlineSettings. Supports up to 100,000 run configurations. The maximum file size is 6 GB.The IAM service role in roleArn must have read access to this S3 object. HealthOmics validates access to the file during the synchronous API call and records the file's ETag. If the file is modified after submission, the batch fails.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBatchRunSettings_S3UriSettings
-ClientConfig <AmazonOmicsConfig>
Amazon.PowerShell.Cmdlets.OMICS.AmazonOmicsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_CacheBehavior <CacheBehavior>
The cache behavior for the runs. Requires cacheId to be set.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_CacheId <String>
The identifier of the run cache to associate with the runs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_LogLevel <RunLogLevel>
The verbosity level for CloudWatch Logs emitted during each run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_Name <String>
An optional user-friendly name applied to each workflow run. Can be overridden per run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_OutputBucketOwnerId <String>
The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_OutputUri <String>
The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_Parameter <PSObject>
Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultRunSetting_Parameters
-DefaultRunSetting_Priority <Int32>
An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_RetentionMode <RunRetentionMode>
The retention behavior for runs after completion.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_RoleArn <String>
The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_RunGroupId <String>
The ID of the run group to contain all workflow runs in the batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_RunTag <Hashtable>
AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap. 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)
AliasesDefaultRunSetting_RunTags
-DefaultRunSetting_StorageCapacity <Int32>
The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_StorageType <StorageType>
The storage type for the workflow runs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_WorkflowId <String>
The identifier of the workflow to run.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_WorkflowOwnerId <String>
The AWS account ID of the workflow owner, used for cross-account workflow sharing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_WorkflowType <WorkflowType>
The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRunSetting_WorkflowVersionName <String>
The version name of the specified workflow.
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)
-RequestId <String>
A client token used to deduplicate retry requests and prevent duplicate batches from being created.
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.StartRunBatchResponse). Specifying the name of a property of type Amazon.Omics.Model.StartRunBatchResponse 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)
-Tag <Hashtable>
AWS tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use defaultRunSetting.runTags. 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

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.StartRunBatchResponse
This cmdlet returns an Amazon.Omics.Model.StartRunBatchResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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