- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateWorkflowCommand
Creates a workflow.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { OmicsClient, CreateWorkflowCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, CreateWorkflowCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // CreateWorkflowRequest
name: "STRING_VALUE",
description: "STRING_VALUE",
engine: "STRING_VALUE",
definitionZip: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
definitionUri: "STRING_VALUE",
main: "STRING_VALUE",
parameterTemplate: { // WorkflowParameterTemplate
"<keys>": { // WorkflowParameter
description: "STRING_VALUE",
optional: true || false,
},
},
storageCapacity: Number("int"),
tags: { // TagMap
"<keys>": "STRING_VALUE",
},
requestId: "STRING_VALUE", // required
accelerators: "STRING_VALUE",
};
const command = new CreateWorkflowCommand(input);
const response = await client.send(command);
// { // CreateWorkflowResponse
// arn: "STRING_VALUE",
// id: "STRING_VALUE",
// status: "STRING_VALUE",
// tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// };
CreateWorkflowCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
accelerators | Accelerators | undefined | The computational accelerator specified to run the workflow. |
definitionUri | string | undefined | The URI of a definition for the workflow. |
definitionZip | Uint8Array | undefined | A ZIP archive for the workflow. |
description | string | undefined | A description for the workflow. |
engine | WorkflowEngine | undefined | An engine for the workflow. |
main | string | undefined | The path of the main definition file for the workflow. |
name | string | undefined | A name for the workflow. |
parameterTemplate | Record<string, WorkflowParameter> | undefined | A parameter template for the workflow. |
requestId | string | undefined | To ensure that requests don't run multiple times, specify a unique ID for each request. |
storageCapacity | number | undefined | The default storage capacity for the workflow runs, in gibibytes. |
tags | Record<string, string> | undefined | Tags for the workflow. |
CreateWorkflowCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
arn | string | undefined | The workflow's ARN. |
id | string | undefined | The workflow's ID. |
status | WorkflowStatus | undefined | The workflow's status. |
tags | Record<string, string> | undefined | The workflow's tags. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | The request cannot be applied to the target resource in its current state. |
InternalServerException | server | An unexpected error occurred. Try the request again. |
RequestTimeoutException | client | The request timed out. |
ResourceNotFoundException | client | The target resource was not found in the current Region. |
ServiceQuotaExceededException | client | The request exceeds a service quota. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by an AWS service. |
OmicsServiceException | Base exception class for all service exceptions from Omics service. |