Struct aws_sdk_swf::client::fluent_builders::SignalWorkflowExecution

pub struct SignalWorkflowExecution<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to SignalWorkflowExecution.

Records a WorkflowExecutionSignaled 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).

If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

If the specified workflow execution isn't open, this method fails with UnknownResource.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• You cannot use an IAM policy to constrain this action's parameters.

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 cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Implementations

impl<C, M, R> SignalWorkflowExecution<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<SignalWorkflowExecutionOutput, SdkError<SignalWorkflowExecutionError>> where
    R::Policy: SmithyRetryPolicy<SignalWorkflowExecutionInputOperationOutputAlias, SignalWorkflowExecutionOutput, SignalWorkflowExecutionError, SignalWorkflowExecutionInputOperationRetryAlias>, 

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, which can be set when configuring the client.

pub fn domain(self, input: impl Into<String>) -> Self

The name of the domain containing the workflow execution to signal.

pub fn set_domain(self, input: Option<String>) -> Self

The name of the domain containing the workflow execution to signal.

pub fn workflow_id(self, input: impl Into<String>) -> Self

The workflowId of the workflow execution to signal.

pub fn set_workflow_id(self, input: Option<String>) -> Self

The workflowId of the workflow execution to signal.

pub fn run_id(self, input: impl Into<String>) -> Self

The runId of the workflow execution to signal.

pub fn set_run_id(self, input: Option<String>) -> Self

The runId of the workflow execution to signal.

pub fn signal_name(self, input: impl Into<String>) -> Self

The name of the signal. This name must be meaningful to the target workflow.

pub fn set_signal_name(self, input: Option<String>) -> Self

The name of the signal. This name must be meaningful to the target workflow.

pub fn input(self, input: impl Into<String>) -> Self

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

pub fn set_input(self, input: Option<String>) -> Self

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for SignalWorkflowExecution<C, M, R>

fn clone(&self) -> SignalWorkflowExecution<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for SignalWorkflowExecution<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.