You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/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.

Instance Attribute Summary collapse

Instance Attribute Details

#controlString

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

Returns:

  • (String)


4995
4996
4997
4998
4999
5000
5001
5002
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4995

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

#inputString

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

Returns:

  • (String)


4995
4996
4997
4998
4999
5000
5001
5002
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4995

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

#run_idString

The runId of the workflow execution to be signaled.

Returns:

  • (String)


4995
4996
4997
4998
4999
5000
5001
5002
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4995

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

#signal_nameString

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

Returns:

  • (String)


4995
4996
4997
4998
4999
5000
5001
5002
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4995

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

#workflow_idString

The workflowId of the workflow execution to be signaled.

Returns:

  • (String)


4995
4996
4997
4998
4999
5000
5001
5002
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 4995

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