aws_sdk_omics/client/
get_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 [`GetWorkflowVersion`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workflow_id(impl Into<String>)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::workflow_id) / [`set_workflow_id(Option<String>)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::set_workflow_id):<br>required: **true**<br><p>The workflow's ID. The <code>workflowId</code> is not the UUID.</p><br>
7    ///   - [`version_name(impl Into<String>)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::version_name) / [`set_version_name(Option<String>)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::set_version_name):<br>required: **true**<br><p>The workflow version name.</p><br>
8    ///   - [`r#type(WorkflowType)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::type) / [`set_type(Option<WorkflowType>)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::set_type):<br>required: **false**<br><p>The workflow's type.</p><br>
9    ///   - [`export(WorkflowExport)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::export) / [`set_export(Option<Vec::<WorkflowExport>>)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::set_export):<br>required: **false**<br><p>The export format for the workflow.</p><br>
10    ///   - [`workflow_owner_id(impl Into<String>)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::workflow_owner_id) / [`set_workflow_owner_id(Option<String>)`](crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::set_workflow_owner_id):<br>required: **false**<br><p>The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the <code>GetShare</code> API operation. If you are the workflow owner, you do not need to include this ID.</p><br>
11    /// - On success, responds with [`GetWorkflowVersionOutput`](crate::operation::get_workflow_version::GetWorkflowVersionOutput) with field(s):
12    ///   - [`arn(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::arn): <p>ARN of the workflow version.</p>
13    ///   - [`workflow_id(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::workflow_id): <p>The workflow's ID.</p>
14    ///   - [`version_name(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::version_name): <p>The workflow version name.</p>
15    ///   - [`accelerators(Option<Accelerators>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::accelerators): <p>The accelerator for this workflow version.</p>
16    ///   - [`creation_time(Option<DateTime>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::creation_time): <p>When the workflow version was created.</p>
17    ///   - [`description(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::description): <p>Description of the workflow version.</p>
18    ///   - [`definition(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::definition): <p>Definition of the workflow version.</p>
19    ///   - [`digest(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::digest): <p>The workflow version's digest.</p>
20    ///   - [`engine(Option<WorkflowEngine>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::engine): <p>The workflow engine for this workflow version.</p>
21    ///   - [`main(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::main): <p>The path of the main definition file for the workflow.</p>
22    ///   - [`metadata(Option<HashMap::<String, String>>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::metadata): <p>The metadata for the workflow version.</p>
23    ///   - [`parameter_template(Option<HashMap::<String, WorkflowParameter>>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::parameter_template): <p>The parameter template for the workflow version.</p>
24    ///   - [`status(Option<WorkflowStatus>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::status): <p>The workflow version status</p>
25    ///   - [`status_message(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::status_message): <p>The workflow version status message</p>
26    ///   - [`storage_type(Option<StorageType>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::storage_type): <p>The default storage type for the run.</p>
27    ///   - [`storage_capacity(Option<i32>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::storage_capacity): <p>The default run storage capacity for static storage.</p>
28    ///   - [`r#type(Option<WorkflowType>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::type): <p>The workflow version type</p>
29    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::tags): <p>The workflow version tags</p>
30    ///   - [`uuid(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::uuid): <p>The universally unique identifier (UUID) value for this workflow version</p>
31    ///   - [`workflow_bucket_owner_id(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::workflow_bucket_owner_id): <p>Amazon Web Services Id of the owner of the bucket.</p>
32    ///   - [`container_registry_map(Option<ContainerRegistryMap>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::container_registry_map): <p>The registry map that this workflow version uses.</p>
33    ///   - [`readme(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::readme): <p>The README content for the workflow version, providing documentation and usage information specific to this version.</p>
34    ///   - [`definition_repository_details(Option<DefinitionRepositoryDetails>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::definition_repository_details): <p>Details about the source code repository that hosts the workflow version definition files.</p>
35    ///   - [`readme_path(Option<String>)`](crate::operation::get_workflow_version::GetWorkflowVersionOutput::readme_path): <p>The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the <code>README.md</code> file from the root directory of the repository will be used.</p>
36    /// - On failure, responds with [`SdkError<GetWorkflowVersionError>`](crate::operation::get_workflow_version::GetWorkflowVersionError)
37    pub fn get_workflow_version(&self) -> crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder {
38        crate::operation::get_workflow_version::builders::GetWorkflowVersionFluentBuilder::new(self.handle.clone())
39    }
40}
aws_sdk_omics/client/get_workflow_version.rs

aws_sdk_omics/client/
get_workflow_version.rs
