Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface SignalExternalWorkflowExecutionDecisionAttributes

Provides the details of the SignalExternalWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision'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.

Hierarchy

  • SignalExternalWorkflowExecutionDecisionAttributes

Properties

control?: string

The data attached to the event that can be used by the decider in subsequent decision tasks.

input?: string

The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.

runId?: string

The runId of the workflow execution to be signaled.

signalName: undefined | string

The name of the signal.The target workflow execution uses the signal name and input to process the signal.

workflowId: undefined | string

The workflowId of the workflow execution to be signaled.