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

Class: Aws::SWF::Types::SignalWorkflowExecutionInput

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 SignalWorkflowExecutionInput data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#domainString

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

Returns:

  • (String)


5141
5142
5143
5144
5145
5146
5147
5148
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5141

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

#inputString

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

Returns:

  • (String)


5141
5142
5143
5144
5145
5146
5147
5148
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5141

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

#run_idString

The runId of the workflow execution to signal.

Returns:

  • (String)


5141
5142
5143
5144
5145
5146
5147
5148
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5141

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

#signal_nameString

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

Returns:

  • (String)


5141
5142
5143
5144
5145
5146
5147
5148
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5141

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

#workflow_idString

The workflowId of the workflow execution to signal.

Returns:

  • (String)


5141
5142
5143
5144
5145
5146
5147
5148
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5141

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