aws_sdk_omics/client/
create_workflow_version.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 [`CreateWorkflowVersion`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workflow_id(impl Into<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::workflow_id) / [`set_workflow_id(Option<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_workflow_id):<br>required: **true**<br><p>The ID of the workflow where you are creating the new version.</p><br>
7    ///   - [`version_name(impl Into<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::version_name) / [`set_version_name(Option<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_version_name):<br>required: **true**<br><p>A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.</p> <p>The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.</p><br>
8    ///   - [`definition_zip(Blob)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::definition_zip) / [`set_definition_zip(Option<Blob>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_definition_zip):<br>required: **false**<br><p>A zip archive containing the workflow definition for this workflow version.</p><br>
9    ///   - [`definition_uri(impl Into<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::definition_uri) / [`set_definition_uri(Option<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_definition_uri):<br>required: **false**<br><p>The URI specifies the location of the workflow definition for this workflow version.</p><br>
10    ///   - [`accelerators(Accelerators)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::accelerators) / [`set_accelerators(Option<Accelerators>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_accelerators):<br>required: **false**<br><p>The computational accelerator for this workflow version.</p><br>
11    ///   - [`description(impl Into<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_description):<br>required: **false**<br><p>A description for this workflow version.</p><br>
12    ///   - [`engine(WorkflowEngine)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::engine) / [`set_engine(Option<WorkflowEngine>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_engine):<br>required: **false**<br><p>The workflow engine for this workflow version.</p><br>
13    ///   - [`main(impl Into<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::main) / [`set_main(Option<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_main):<br>required: **false**<br><p>The path of the main definition file for this workflow version.</p><br>
14    ///   - [`parameter_template(impl Into<String>, WorkflowParameter)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::parameter_template) / [`set_parameter_template(Option<HashMap::<String, WorkflowParameter>>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_parameter_template):<br>required: **false**<br><p>The parameter template defines the input parameters for runs that use this workflow version.</p><br>
15    ///   - [`request_id(impl Into<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::request_id) / [`set_request_id(Option<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::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    ///   - [`storage_type(StorageType)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::storage_type) / [`set_storage_type(Option<StorageType>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::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>
17    ///   - [`storage_capacity(i32)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::storage_capacity) / [`set_storage_capacity(Option<i32>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::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>
18    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_tags):<br>required: **false**<br><p>Optional tags to associate with this workflow version.</p><br>
19    ///   - [`workflow_bucket_owner_id(impl Into<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::workflow_bucket_owner_id) / [`set_workflow_bucket_owner_id(Option<String>)`](crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::set_workflow_bucket_owner_id):<br>required: **false**<br><p>Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.</p><br>
20    /// - On success, responds with [`CreateWorkflowVersionOutput`](crate::operation::create_workflow_version::CreateWorkflowVersionOutput) with field(s):
21    ///   - [`arn(Option<String>)`](crate::operation::create_workflow_version::CreateWorkflowVersionOutput::arn): <p>ARN of the workflow version.</p>
22    ///   - [`workflow_id(Option<String>)`](crate::operation::create_workflow_version::CreateWorkflowVersionOutput::workflow_id): <p>The workflow's ID.</p>
23    ///   - [`version_name(Option<String>)`](crate::operation::create_workflow_version::CreateWorkflowVersionOutput::version_name): <p>The workflow version name.</p>
24    ///   - [`status(Option<WorkflowStatus>)`](crate::operation::create_workflow_version::CreateWorkflowVersionOutput::status): <p>The workflow version status.</p>
25    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_workflow_version::CreateWorkflowVersionOutput::tags): <p>The workflow version's tags.</p>
26    ///   - [`uuid(Option<String>)`](crate::operation::create_workflow_version::CreateWorkflowVersionOutput::uuid): <p>The universally unique identifier (UUID) value for this workflow version.</p>
27    /// - On failure, responds with [`SdkError<CreateWorkflowVersionError>`](crate::operation::create_workflow_version::CreateWorkflowVersionError)
28    pub fn create_workflow_version(&self) -> crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder {
29        crate::operation::create_workflow_version::builders::CreateWorkflowVersionFluentBuilder::new(self.handle.clone())
30    }
31}