aws_sdk_codecatalyst/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    ///   - [`space_name(impl Into<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::space_name) / [`set_space_name(Option<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_space_name):<br>required: **true**<br><p>The name of the space.</p><br>
7    ///   - [`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 workflow. To rerieve a list of workflow IDs, use <code>ListWorkflows</code>.</p><br>
8    ///   - [`project_name(impl Into<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::project_name) / [`set_project_name(Option<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_project_name):<br>required: **true**<br><p>The name of the project in the space.</p><br>
9    /// - On success, responds with [`GetWorkflowOutput`](crate::operation::get_workflow::GetWorkflowOutput) with field(s):
10    ///   - [`space_name(String)`](crate::operation::get_workflow::GetWorkflowOutput::space_name): <p>The name of the space.</p>
11    ///   - [`project_name(String)`](crate::operation::get_workflow::GetWorkflowOutput::project_name): <p>The name of the project in the space.</p>
12    ///   - [`id(String)`](crate::operation::get_workflow::GetWorkflowOutput::id): <p>The ID of the workflow.</p>
13    ///   - [`name(String)`](crate::operation::get_workflow::GetWorkflowOutput::name): <p>The name of the workflow.</p>
14    ///   - [`source_repository_name(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::source_repository_name): <p>The name of the source repository where the workflow YAML is stored.</p>
15    ///   - [`source_branch_name(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::source_branch_name): <p>The name of the branch that contains the workflow YAML.</p>
16    ///   - [`definition(Option<WorkflowDefinition>)`](crate::operation::get_workflow::GetWorkflowOutput::definition): <p>Information about the workflow definition file for the workflow.</p>
17    ///   - [`created_time(DateTime)`](crate::operation::get_workflow::GetWorkflowOutput::created_time): <p>The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a></p>
18    ///   - [`last_updated_time(DateTime)`](crate::operation::get_workflow::GetWorkflowOutput::last_updated_time): <p>The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a></p>
19    ///   - [`run_mode(WorkflowRunMode)`](crate::operation::get_workflow::GetWorkflowOutput::run_mode): <p>The behavior to use when multiple workflows occur at the same time. For more information, see <a href="https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html">https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html</a> in the Amazon CodeCatalyst User Guide.</p>
20    ///   - [`status(WorkflowStatus)`](crate::operation::get_workflow::GetWorkflowOutput::status): <p>The status of the workflow.</p>
21    /// - On failure, responds with [`SdkError<GetWorkflowError>`](crate::operation::get_workflow::GetWorkflowError)
22    pub fn get_workflow(&self) -> crate::operation::get_workflow::builders::GetWorkflowFluentBuilder {
23        crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_codecatalyst/client/get_workflow.rs

aws_sdk_codecatalyst/client/
get_workflow.rs
