1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::signal_workflow_execution::_signal_workflow_execution_output::SignalWorkflowExecutionOutputBuilder;
pub use crate::operation::signal_workflow_execution::_signal_workflow_execution_input::SignalWorkflowExecutionInputBuilder;
/// Fluent builder constructing a request to `SignalWorkflowExecution`.
///
/// <p>Records a <code>WorkflowExecutionSignaled</code> event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).</p> <note>
/// <p>If a runId isn't specified, then the <code>WorkflowExecutionSignaled</code> event is recorded in the history of the current open workflow with the matching workflowId in the domain.</p>
/// </note> <note>
/// <p>If the specified workflow execution isn't open, this method fails with <code>UnknownResource</code>.</p>
/// </note>
/// <p> <b>Access Control</b> </p>
/// <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>
/// <ul>
/// <li> <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p> </li>
/// <li> <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p> </li>
/// <li> <p>You cannot use an IAM policy to constrain this action's parameters.</p> </li>
/// </ul>
/// <p>If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>. For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SignalWorkflowExecutionFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner:
crate::operation::signal_workflow_execution::builders::SignalWorkflowExecutionInputBuilder,
}
impl SignalWorkflowExecutionFluentBuilder {
/// Creates a new `SignalWorkflowExecution`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::signal_workflow_execution::SignalWorkflowExecution,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::signal_workflow_execution::SignalWorkflowExecutionError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::signal_workflow_execution::SignalWorkflowExecutionOutput,
aws_smithy_http::result::SdkError<
crate::operation::signal_workflow_execution::SignalWorkflowExecutionError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The name of the domain containing the workflow execution to signal.</p>
pub fn domain(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.domain(input.into());
self
}
/// <p>The name of the domain containing the workflow execution to signal.</p>
pub fn set_domain(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_domain(input);
self
}
/// <p>The workflowId of the workflow execution to signal.</p>
pub fn workflow_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.workflow_id(input.into());
self
}
/// <p>The workflowId of the workflow execution to signal.</p>
pub fn set_workflow_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_workflow_id(input);
self
}
/// <p>The runId of the workflow execution to signal.</p>
pub fn run_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.run_id(input.into());
self
}
/// <p>The runId of the workflow execution to signal.</p>
pub fn set_run_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_run_id(input);
self
}
/// <p>The name of the signal. This name must be meaningful to the target workflow.</p>
pub fn signal_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.signal_name(input.into());
self
}
/// <p>The name of the signal. This name must be meaningful to the target workflow.</p>
pub fn set_signal_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_signal_name(input);
self
}
/// <p>Data to attach to the <code>WorkflowExecutionSignaled</code> event in the target workflow execution's history.</p>
pub fn input(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.input(input.into());
self
}
/// <p>Data to attach to the <code>WorkflowExecutionSignaled</code> event in the target workflow execution's history.</p>
pub fn set_input(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_input(input);
self
}
}