aws_sdk_swf/client/signal_workflow_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 [`SignalWorkflowExecution`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain(impl Into<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain containing the workflow execution to signal.</p><br>
7 /// - [`workflow_id(impl Into<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::workflow_id) / [`set_workflow_id(Option<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::set_workflow_id):<br>required: **true**<br><p>The workflowId of the workflow execution to signal.</p><br>
8 /// - [`run_id(impl Into<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::run_id) / [`set_run_id(Option<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::set_run_id):<br>required: **false**<br><p>The runId of the workflow execution to signal.</p><br>
9 /// - [`signal_name(impl Into<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::signal_name) / [`set_signal_name(Option<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::set_signal_name):<br>required: **true**<br><p>The name of the signal. This name must be meaningful to the target workflow.</p><br>
10 /// - [`input(impl Into<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::input) / [`set_input(Option<String>)`](crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::set_input):<br>required: **false**<br><p>Data to attach to the <code>WorkflowExecutionSignaled</code> event in the target workflow execution's history.</p><br>
11 /// - On success, responds with [`SignalWorkflowExecutionOutput`](crate::operation::signal_workflow_execution::SignalWorkflowExecutionOutput)
12 /// - On failure, responds with [`SdkError<SignalWorkflowExecutionError>`](crate::operation::signal_workflow_execution::SignalWorkflowExecutionError)
13 pub fn signal_workflow_execution(&self) -> crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder {
14 crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionFluentBuilder::new(self.handle.clone())
15 }
16}