import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { StartRunRequest, StartRunResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link StartRunCommand}. */ export interface StartRunCommandInput extends StartRunRequest { } /** * @public * * The output of {@link StartRunCommand}. */ export interface StartRunCommandOutput extends StartRunResponse, __MetadataBearer { } declare const StartRunCommand_base: { new (input: StartRunCommandInput): import("@smithy/core/client").CommandImpl; new (input: StartRunCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation.

To start a new run, the following inputs are required:

StartRun can also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required:

To learn more about the optional parameters for StartRun, see Starting a run in the Amazon Web Services HealthOmics User Guide.

Use the retentionMode input to control how long the metadata for each run is stored in CloudWatch. There are two retention modes:

To learn more about the retention modes, see Run retention mode in the Amazon Web Services HealthOmics User Guide.

You can use Amazon Q CLI to analyze run logs and make performance optimization recommendations. To get started, see the Amazon Web Services HealthOmics MCP server on GitHub.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { OmicsClient, StartRunCommand } from "@aws-sdk/client-omics"; // ES Modules import * // const { OmicsClient, StartRunCommand } = require("@aws-sdk/client-omics"); // CommonJS import * // import type { OmicsClientConfig } from "@aws-sdk/client-omics"; * const config = {}; // type is OmicsClientConfig * const client = new OmicsClient(config); * const input = { // StartRunRequest * workflowId: "STRING_VALUE", * workflowType: "STRING_VALUE", * runId: "STRING_VALUE", * roleArn: "STRING_VALUE", // required * name: "STRING_VALUE", * cacheId: "STRING_VALUE", * cacheBehavior: "STRING_VALUE", * runGroupId: "STRING_VALUE", * priority: Number("int"), * parameters: "DOCUMENT_VALUE", * storageCapacity: Number("int"), * outputUri: "STRING_VALUE", // required * logLevel: "STRING_VALUE", * tags: { // TagMap * "": "STRING_VALUE", * }, * requestId: "STRING_VALUE", // required * retentionMode: "STRING_VALUE", * storageType: "STRING_VALUE", * workflowOwnerId: "STRING_VALUE", * workflowVersionName: "STRING_VALUE", * networkingMode: "STRING_VALUE", * scratchStorageMode: "STRING_VALUE", * configurationName: "STRING_VALUE", * engineSettings: "DOCUMENT_VALUE", * }; * const command = new StartRunCommand(input); * const response = await client.send(command); * // { // StartRunResponse * // arn: "STRING_VALUE", * // id: "STRING_VALUE", * // status: "STRING_VALUE", * // tags: { // TagMap * // "": "STRING_VALUE", * // }, * // uuid: "STRING_VALUE", * // runOutputUri: "STRING_VALUE", * // configuration: { // ConfigurationDetails * // name: "STRING_VALUE", * // arn: "STRING_VALUE", * // uuid: "STRING_VALUE", * // }, * // networkingMode: "STRING_VALUE", * // }; * * ``` * * @param StartRunCommandInput - {@link StartRunCommandInput} * @returns {@link StartRunCommandOutput} * @see {@link StartRunCommandInput} for command's `input` shape. * @see {@link StartRunCommandOutput} for command's `response` shape. * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

* * @throws {@link ConflictException} (client fault) *

The request cannot be applied to the target resource in its current state.

* * @throws {@link InternalServerException} (server fault) *

An unexpected error occurred. Try the request again.

* * @throws {@link RequestTimeoutException} (client fault) *

The request timed out.

* * @throws {@link ResourceNotFoundException} (client fault) *

The target resource was not found in the current Region.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

The request exceeds a service quota.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the constraints specified by an AWS service.

* * @throws {@link OmicsServiceException} *

Base exception class for all service exceptions from Omics service.

* * * @public */ export declare class StartRunCommand extends StartRunCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartRunRequest; output: StartRunResponse; }; sdk: { input: StartRunCommandInput; output: StartRunCommandOutput; }; }; }