aws_sdk_mwaaserverless/client/
stop_workflow_run.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 [`StopWorkflowRun`](crate::operation::stop_workflow_run::builders::StopWorkflowRunFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workflow_arn(impl Into<String>)`](crate::operation::stop_workflow_run::builders::StopWorkflowRunFluentBuilder::workflow_arn) / [`set_workflow_arn(Option<String>)`](crate::operation::stop_workflow_run::builders::StopWorkflowRunFluentBuilder::set_workflow_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the workflow that contains the run you want to stop.</p><br>
7    ///   - [`run_id(impl Into<String>)`](crate::operation::stop_workflow_run::builders::StopWorkflowRunFluentBuilder::run_id) / [`set_run_id(Option<String>)`](crate::operation::stop_workflow_run::builders::StopWorkflowRunFluentBuilder::set_run_id):<br>required: **true**<br><p>The unique identifier of the workflow run to stop.</p><br>
8    /// - On success, responds with [`StopWorkflowRunOutput`](crate::operation::stop_workflow_run::StopWorkflowRunOutput) with field(s):
9    ///   - [`workflow_arn(Option<String>)`](crate::operation::stop_workflow_run::StopWorkflowRunOutput::workflow_arn): <p>The Amazon Resource Name (ARN) of the workflow that contains the stopped run.</p>
10    ///   - [`workflow_version(Option<String>)`](crate::operation::stop_workflow_run::StopWorkflowRunOutput::workflow_version): <p>The version of the workflow that was stopped.</p>
11    ///   - [`run_id(Option<String>)`](crate::operation::stop_workflow_run::StopWorkflowRunOutput::run_id): <p>The unique identifier of the stopped workflow run.</p>
12    ///   - [`status(Option<WorkflowRunStatus>)`](crate::operation::stop_workflow_run::StopWorkflowRunOutput::status): <p>The status of the workflow run after the stop operation. This is typically <code>STOPPING</code> or <code>STOPPED</code>.</p>
13    /// - On failure, responds with [`SdkError<StopWorkflowRunError>`](crate::operation::stop_workflow_run::StopWorkflowRunError)
14    pub fn stop_workflow_run(&self) -> crate::operation::stop_workflow_run::builders::StopWorkflowRunFluentBuilder {
15        crate::operation::stop_workflow_run::builders::StopWorkflowRunFluentBuilder::new(self.handle.clone())
16    }
17}