AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the SignalWorkflowExecution operation. 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:

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleWorkflow.AmazonSimpleWorkflowRequest
      Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionRequest

Namespace: Amazon.SimpleWorkflow.Model
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z

Syntax

C#
public class SignalWorkflowExecutionRequest : AmazonSimpleWorkflowRequest
         IAmazonWebServiceRequest

The SignalWorkflowExecutionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Domain System.String

Gets and sets the property Domain.

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

Public Property Input System.String

Gets and sets the property Input.

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

Public Property RunId System.String

Gets and sets the property RunId.

The runId of the workflow execution to signal.

Public Property SignalName System.String

Gets and sets the property SignalName.

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

Public Property WorkflowId System.String

Gets and sets the property WorkflowId.

The workflowId of the workflow execution to signal.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms