aws_sdk_sfn/client/
stop_execution.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 [`StopExecution`](crate::operation::stop_execution::builders::StopExecutionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`execution_arn(impl Into<String>)`](crate::operation::stop_execution::builders::StopExecutionFluentBuilder::execution_arn) / [`set_execution_arn(Option<String>)`](crate::operation::stop_execution::builders::StopExecutionFluentBuilder::set_execution_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the execution to stop.</p><br>
7    ///   - [`error(impl Into<String>)`](crate::operation::stop_execution::builders::StopExecutionFluentBuilder::error) / [`set_error(Option<String>)`](crate::operation::stop_execution::builders::StopExecutionFluentBuilder::set_error):<br>required: **false**<br><p>The error code of the failure.</p><br>
8    ///   - [`cause(impl Into<String>)`](crate::operation::stop_execution::builders::StopExecutionFluentBuilder::cause) / [`set_cause(Option<String>)`](crate::operation::stop_execution::builders::StopExecutionFluentBuilder::set_cause):<br>required: **false**<br><p>A more detailed explanation of the cause of the failure.</p><br>
9    /// - On success, responds with [`StopExecutionOutput`](crate::operation::stop_execution::StopExecutionOutput) with field(s):
10    ///   - [`stop_date(DateTime)`](crate::operation::stop_execution::StopExecutionOutput::stop_date): <p>The date the execution is stopped.</p>
11    /// - On failure, responds with [`SdkError<StopExecutionError>`](crate::operation::stop_execution::StopExecutionError)
12    pub fn stop_execution(&self) -> crate::operation::stop_execution::builders::StopExecutionFluentBuilder {
13        crate::operation::stop_execution::builders::StopExecutionFluentBuilder::new(self.handle.clone())
14    }
15}