aws_sdk_omics/client/
get_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 [`GetWorkflow`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_id):<br>required: **true**<br><p>The workflow's ID.</p><br>
7    ///   - [`r#type(WorkflowType)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::type) / [`set_type(Option<WorkflowType>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_type):<br>required: **false**<br><p>The workflow's type.</p><br>
8    ///   - [`export(WorkflowExport)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::export) / [`set_export(Option<Vec::<WorkflowExport>>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_export):<br>required: **false**<br><p>The export format for the workflow.</p><br>
9    ///   - [`workflow_owner_id(impl Into<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::workflow_owner_id) / [`set_workflow_owner_id(Option<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_workflow_owner_id):<br>required: **false**<br><p>The ID of the workflow owner.</p><br>
10    /// - On success, responds with [`GetWorkflowOutput`](crate::operation::get_workflow::GetWorkflowOutput) with field(s):
11    ///   - [`arn(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::arn): <p>The workflow's ARN.</p>
12    ///   - [`id(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::id): <p>The workflow's ID.</p>
13    ///   - [`status(Option<WorkflowStatus>)`](crate::operation::get_workflow::GetWorkflowOutput::status): <p>The workflow's status.</p>
14    ///   - [`r#type(Option<WorkflowType>)`](crate::operation::get_workflow::GetWorkflowOutput::type): <p>The workflow's type.</p>
15    ///   - [`name(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::name): <p>The workflow's name.</p>
16    ///   - [`description(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::description): <p>The workflow's description.</p>
17    ///   - [`engine(Option<WorkflowEngine>)`](crate::operation::get_workflow::GetWorkflowOutput::engine): <p>The workflow's engine.</p>
18    ///   - [`definition(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::definition): <p>The workflow's definition.</p>
19    ///   - [`main(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::main): <p>The path of the main definition file for the workflow.</p>
20    ///   - [`digest(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::digest): <p>The workflow's digest.</p>
21    ///   - [`parameter_template(Option<HashMap::<String, WorkflowParameter>>)`](crate::operation::get_workflow::GetWorkflowOutput::parameter_template): <p>The workflow's parameter template.</p>
22    ///   - [`storage_capacity(Option<i32>)`](crate::operation::get_workflow::GetWorkflowOutput::storage_capacity): <p>The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.</p>
23    ///   - [`creation_time(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::creation_time): <p>When the workflow was created.</p>
24    ///   - [`status_message(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::status_message): <p>The workflow's status message.</p>
25    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_workflow::GetWorkflowOutput::tags): <p>The workflow's tags.</p>
26    ///   - [`metadata(Option<HashMap::<String, String>>)`](crate::operation::get_workflow::GetWorkflowOutput::metadata): <p>Gets metadata for the workflow.</p>
27    ///   - [`accelerators(Option<Accelerators>)`](crate::operation::get_workflow::GetWorkflowOutput::accelerators): <p>The computational accelerator specified to run the workflow.</p>
28    ///   - [`storage_type(Option<StorageType>)`](crate::operation::get_workflow::GetWorkflowOutput::storage_type): <p>The default storage type for runs using this workflow.</p>
29    ///   - [`uuid(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::uuid): <p>The universally unique identifier (UUID) value for this workflow.</p>
30    ///   - [`container_registry_map(Option<ContainerRegistryMap>)`](crate::operation::get_workflow::GetWorkflowOutput::container_registry_map): <p>The registry map that this workflow is using.</p>
31    ///   - [`readme(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::readme): <p>The README content for the workflow, providing documentation and usage information.</p>
32    ///   - [`definition_repository_details(Option<DefinitionRepositoryDetails>)`](crate::operation::get_workflow::GetWorkflowOutput::definition_repository_details): <p>Details about the source code repository that hosts the workflow definition files.</p>
33    ///   - [`readme_path(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::readme_path): <p>The path to the workflow 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>
34    /// - On failure, responds with [`SdkError<GetWorkflowError>`](crate::operation::get_workflow::GetWorkflowError)
35    pub fn get_workflow(&self) -> crate::operation::get_workflow::builders::GetWorkflowFluentBuilder {
36        crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::new(self.handle.clone())
37    }
38}
aws_sdk_omics/client/get_workflow.rs

aws_sdk_omics/client/
get_workflow.rs
