aws_sdk_omics/client/
create_workflow.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateWorkflow`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_name):<br>required: **false**<br><p>A name for the workflow.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_description):<br>required: **false**<br><p>A description for the workflow.</p><br>
8    ///   - [`engine(WorkflowEngine)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::engine) / [`set_engine(Option<WorkflowEngine>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_engine):<br>required: **false**<br><p>The workflow engine for the workflow.</p><br>
9    ///   - [`definition_zip(Blob)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::definition_zip) / [`set_definition_zip(Option<Blob>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_definition_zip):<br>required: **false**<br><p>A ZIP archive for the workflow.</p><br>
10    ///   - [`definition_uri(impl Into<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::definition_uri) / [`set_definition_uri(Option<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_definition_uri):<br>required: **false**<br><p>The URI of a definition for the workflow.</p><br>
11    ///   - [`main(impl Into<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::main) / [`set_main(Option<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_main):<br>required: **false**<br><p>The path of the main definition file for the workflow.</p><br>
12    ///   - [`parameter_template(impl Into<String>, WorkflowParameter)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::parameter_template) / [`set_parameter_template(Option<HashMap::<String, WorkflowParameter>>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_parameter_template):<br>required: **false**<br><p>A parameter template for the workflow.</p><br>
13    ///   - [`storage_capacity(i32)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::storage_capacity) / [`set_storage_capacity(Option<i32>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_storage_capacity):<br>required: **false**<br><p>The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.</p><br>
14    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_tags):<br>required: **false**<br><p>Tags for the workflow.</p><br>
15    ///   - [`request_id(impl Into<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::request_id) / [`set_request_id(Option<String>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_request_id):<br>required: **true**<br><p>To ensure that requests don't run multiple times, specify a unique ID for each request.</p><br>
16    ///   - [`accelerators(Accelerators)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::accelerators) / [`set_accelerators(Option<Accelerators>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_accelerators):<br>required: **false**<br><p>The computational accelerator specified to run the workflow.</p><br>
17    ///   - [`storage_type(StorageType)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::storage_type) / [`set_storage_type(Option<StorageType>)`](crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::set_storage_type):<br>required: **false**<br><p>The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see <a href="https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html">Running workflows</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p><br>
18    /// - On success, responds with [`CreateWorkflowOutput`](crate::operation::create_workflow::CreateWorkflowOutput) with field(s):
19    ///   - [`arn(Option<String>)`](crate::operation::create_workflow::CreateWorkflowOutput::arn): <p>The workflow's ARN.</p>
20    ///   - [`id(Option<String>)`](crate::operation::create_workflow::CreateWorkflowOutput::id): <p>The workflow's ID.</p>
21    ///   - [`status(Option<WorkflowStatus>)`](crate::operation::create_workflow::CreateWorkflowOutput::status): <p>The workflow's status.</p>
22    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_workflow::CreateWorkflowOutput::tags): <p>The workflow's tags.</p>
23    ///   - [`uuid(Option<String>)`](crate::operation::create_workflow::CreateWorkflowOutput::uuid): <p>The universally unique identifier (UUID) value for this workflow.</p>
24    /// - On failure, responds with [`SdkError<CreateWorkflowError>`](crate::operation::create_workflow::CreateWorkflowError)
25    pub fn create_workflow(&self) -> crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder {
26        crate::operation::create_workflow::builders::CreateWorkflowFluentBuilder::new(self.handle.clone())
27    }
28}