aws_sdk_migrationhuborchestrator/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 ID of the migration workflow.</p><br>
7    /// - On success, responds with [`GetWorkflowOutput`](crate::operation::get_workflow::GetWorkflowOutput) with field(s):
8    ///   - [`id(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::id): <p>The ID of the migration workflow.</p>
9    ///   - [`arn(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::arn): <p>The Amazon Resource Name (ARN) of the migration workflow.</p>
10    ///   - [`name(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::name): <p>The name of the migration workflow.</p>
11    ///   - [`description(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::description): <p>The description of the migration workflow.</p>
12    ///   - [`template_id(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::template_id): <p>The ID of the template.</p>
13    ///   - [`ads_application_configuration_id(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::ads_application_configuration_id): <p>The configuration ID of the application configured in Application Discovery Service.</p>
14    ///   - [`ads_application_name(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::ads_application_name): <p>The name of the application configured in Application Discovery Service.</p>
15    ///   - [`status(Option<MigrationWorkflowStatusEnum>)`](crate::operation::get_workflow::GetWorkflowOutput::status): <p>The status of the migration workflow.</p>
16    ///   - [`status_message(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::status_message): <p>The status message of the migration workflow.</p>
17    ///   - [`creation_time(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::creation_time): <p>The time at which the migration workflow was created.</p>
18    ///   - [`last_start_time(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::last_start_time): <p>The time at which the migration workflow was last started.</p>
19    ///   - [`last_stop_time(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::last_stop_time): <p>The time at which the migration workflow was last stopped.</p>
20    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::last_modified_time): <p>The time at which the migration workflow was last modified.</p>
21    ///   - [`end_time(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::end_time): <p>The time at which the migration workflow ended.</p>
22    ///   - [`tools(Option<Vec::<Tool>>)`](crate::operation::get_workflow::GetWorkflowOutput::tools): <p>List of AWS services utilized in a migration workflow.</p>
23    ///   - [`total_steps(Option<i32>)`](crate::operation::get_workflow::GetWorkflowOutput::total_steps): <p>The total number of steps in the migration workflow.</p>
24    ///   - [`completed_steps(Option<i32>)`](crate::operation::get_workflow::GetWorkflowOutput::completed_steps): <p>Get a list of completed steps in the migration workflow.</p>
25    ///   - [`workflow_inputs(Option<HashMap::<String, StepInput>>)`](crate::operation::get_workflow::GetWorkflowOutput::workflow_inputs): <p>The inputs required for creating the migration workflow.</p>
26    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_workflow::GetWorkflowOutput::tags): <p>The tags added to the migration workflow.</p>
27    ///   - [`workflow_bucket(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::workflow_bucket): <p>The Amazon S3 bucket where the migration logs are stored.</p>
28    /// - On failure, responds with [`SdkError<GetWorkflowError>`](crate::operation::get_workflow::GetWorkflowError)
29    pub fn get_workflow(&self) -> crate::operation::get_workflow::builders::GetWorkflowFluentBuilder {
30        crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::new(self.handle.clone())
31    }
32}