Class: Aws::SWF::Types::SignalExternalWorkflowExecutionDecisionAttributes

Inherits:

Struct

• Object
• Struct
• Aws::SWF::Types::SignalExternalWorkflowExecutionDecisionAttributes

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-swf/types.rb

Overview

Note:

When making an API call, you may pass SignalExternalWorkflowExecutionDecisionAttributes data as a hash:

{
  workflow_id: "WorkflowId", # required
  run_id: "WorkflowRunIdOptional",
  signal_name: "SignalName", # required
  input: "Data",
  control: "Data",
}

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*.

[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #run_id ⇒ String

  The ‘runId` of the workflow execution to be signaled.

• #signal_name ⇒ String

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

• #workflow_id ⇒ String

  The ‘workflowId` of the workflow execution to be signaled.

Instance Attribute Details

#control ⇒ String

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

# File 'lib/aws-sdk-swf/types.rb', line 5232

class SignalExternalWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_id,
  :run_id,
  :signal_name,
  :input,
  :control)
  SENSITIVE = []
  include Aws::Structure
end

#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.

# File 'lib/aws-sdk-swf/types.rb', line 5232

class SignalExternalWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_id,
  :run_id,
  :signal_name,
  :input,
  :control)
  SENSITIVE = []
  include Aws::Structure
end

#run_id ⇒ String

The ‘runId` of the workflow execution to be signaled.

# File 'lib/aws-sdk-swf/types.rb', line 5232

class SignalExternalWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_id,
  :run_id,
  :signal_name,
  :input,
  :control)
  SENSITIVE = []
  include Aws::Structure
end

#signal_name ⇒ String

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

# File 'lib/aws-sdk-swf/types.rb', line 5232

class SignalExternalWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_id,
  :run_id,
  :signal_name,
  :input,
  :control)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ String

The ‘workflowId` of the workflow execution to be signaled.

# File 'lib/aws-sdk-swf/types.rb', line 5232

class SignalExternalWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_id,
  :run_id,
  :signal_name,
  :input,
  :control)
  SENSITIVE = []
  include Aws::Structure
end