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.

AutomationTask CoordinationWorkflow

Properties

Name	Type	Description
workflowId	object
runId	object
signalName	object
input	object
control	object

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "required": [
    "workflowId",
    "signalName"
  ],
  "properties": {
    "workflowId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowId"
        },
        {
          "description": " The <code>workflowId</code> of the workflow execution to be signaled."
        }
      ]
    },
    "runId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowRunIdOptional"
        },
        {
          "description": "The <code>runId</code> of the workflow execution to be signaled."
        }
      ]
    },
    "signalName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SignalName"
        },
        {
          "description": " The name of the signal.The target workflow execution uses the signal name and input to process the signal."
        }
      ]
    },
    "input": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": " The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal."
        }
      ]
    },
    "control": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": "The data attached to the event that can be used by the decider in subsequent decision tasks."
        }
      ]
    }
  },
  "description": "<p>Provides the details of the <code>SignalExternalWorkflowExecution</code> decision.</p> <p> <b>Access Control</b> </p> <p>You can use IAM policies to control this decision'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>",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SignalExternalWorkflowExecutionDecisionAttributes"
}