Class: AWS::SimpleWorkflow::Client

Inherits:
Core::Client show all
Extended by:
Core::Client::QueryJSON
Defined in:
lib/aws/simple_workflow/client.rb

Overview

Client class for Amazon Simple Workflow Service (SWF).

Constant Summary collapse

API_VERSION =
'2012-01-25'
TARGET_PREFIX =
"SimpleWorkflowService."
CACHEABLE_REQUESTS =
Set[
  :count_pending_activity_tasks,
  :count_pending_decision_tasks,
  :count_closed_workflow_executions,
  :count_open_workflow_executions,
  :describe_activity_type,
  :describe_domain,
  :describe_workflow_execution,
  :describe_workflow_type,
  :get_workflow_execution_history,
  #:poll_for_decision_task, # see below for expanded logic
  :list_activity_types,
  :list_domains,
  :list_closed_workfow_executions,
  :list_open_workfow_executions,
  :list_workfow_types,
]

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #endpoint, #port, #service_ruby_name, #signer

Instance Method Summary collapse

Methods included from Core::Client::QueryJSON

extended, option_parsers

Methods inherited from Core::Client

#initialize, #new_stub_for, #operations, #stub_for, #with_config, #with_http_handler, #with_options

Methods included from Core::Naming

#service_name, #service_ruby_name

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#count_closed_workflow_executions(options = {}) ⇒ Core::Response

Calls the CountClosedWorkflowExecutions API operation.

Options:

  • :domain - required - (String)

  • :start_time_filter - (Hash)

    • :oldest_date - required - (Integer<unix timestamp>)

    • :latest_date - (Integer<unix timestamp>)

  • :close_time_filter - (Hash)

    • :oldest_date - required - (Integer<unix timestamp>)

    • :latest_date - (Integer<unix timestamp>)

  • :execution_filter - (Hash)

    • :workflow_id - required - (String)

  • :type_filter - (Hash)

    • :name - required - (String)

    • :version - (String)

  • :tag_filter - (Hash)

    • :tag - required - (String)

  • :close_status_filter - (Hash)

    • :status - required - (String)

Response Structure:

  • count - (Integer)

  • truncated - (Boolean)

Returns:


77
# File 'lib/aws/simple_workflow/client.rb', line 77

define_client_method :count_closed_workflow_executions, 'CountClosedWorkflowExecutions'

#count_open_workflow_executions(options = {}) ⇒ Core::Response

Calls the CountOpenWorkflowExecutions API operation.

Options:

  • :domain - required - (String)

  • :start_time_filter - required - (Hash)

    • :oldest_date - required - (Integer<unix timestamp>)

    • :latest_date - (Integer<unix timestamp>)

  • :type_filter - (Hash)

    • :name - required - (String)

    • :version - (String)

  • :tag_filter - (Hash)

    • :tag - required - (String)

  • :execution_filter - (Hash)

    • :workflow_id - required - (String)

Response Structure:

  • count - (Integer)

  • truncated - (Boolean)

Returns:


103
# File 'lib/aws/simple_workflow/client.rb', line 103

define_client_method :count_open_workflow_executions, 'CountOpenWorkflowExecutions'

#count_pending_activity_tasks(options = {}) ⇒ Core::Response

Calls the CountPendingActivityTasks API operation.

Options:

  • :domain - required - (String)

  • :task_list - required - (Hash)

    • :name - required - (String)

Response Structure:

  • count - (Integer)

  • truncated - (Boolean)

Returns:


121
# File 'lib/aws/simple_workflow/client.rb', line 121

define_client_method :count_pending_activity_tasks, 'CountPendingActivityTasks'

#count_pending_decision_tasks(options = {}) ⇒ Core::Response

Calls the CountPendingDecisionTasks API operation.

Options:

  • :domain - required - (String)

  • :task_list - required - (Hash)

    • :name - required - (String)

Response Structure:

  • count - (Integer)

  • truncated - (Boolean)

Returns:


139
# File 'lib/aws/simple_workflow/client.rb', line 139

define_client_method :count_pending_decision_tasks, 'CountPendingDecisionTasks'

#deprecate_activity_type(options = {}) ⇒ Core::Response

Calls the DeprecateActivityType API operation.

Options:

  • :domain - required - (String)

  • :activity_type - required - (Hash)

    • :name - required - (String)

    • :version - required - (String)

Response Structure:

This method returns no response data.

Returns:


157
# File 'lib/aws/simple_workflow/client.rb', line 157

define_client_method :deprecate_activity_type, 'DeprecateActivityType'

#deprecate_domain(options = {}) ⇒ Core::Response

Calls the DeprecateDomain API operation.

Options:

  • :name - required - (String)

Response Structure:

This method returns no response data.

Returns:


172
# File 'lib/aws/simple_workflow/client.rb', line 172

define_client_method :deprecate_domain, 'DeprecateDomain'

#deprecate_workflow_type(options = {}) ⇒ Core::Response

Calls the DeprecateWorkflowType API operation.

Options:

  • :domain - required - (String)

  • :workflow_type - required - (Hash)

    • :name - required - (String)

    • :version - required - (String)

Response Structure:

This method returns no response data.

Returns:


190
# File 'lib/aws/simple_workflow/client.rb', line 190

define_client_method :deprecate_workflow_type, 'DeprecateWorkflowType'

#describe_activity_type(options = {}) ⇒ Core::Response

Calls the DescribeActivityType API operation.

Options:

  • :domain - required - (String)

  • :activity_type - required - (Hash)

    • :name - required - (String)

    • :version - required - (String)

Response Structure:

  • typeInfo - (Hash)

    • activityType - (Hash)

      • name - (String)

      • version - (String)

    • status - (String)

    • description - (String)

    • creationDate - (Time)

    • deprecationDate - (Time)

  • configuration - (Hash)

    • defaultTaskStartToCloseTimeout - (String)

    • defaultTaskHeartbeatTimeout - (String)

    • defaultTaskList - (Hash)

      • name - (String)

    • defaultTaskScheduleToStartTimeout - (String)

    • defaultTaskScheduleToCloseTimeout - (String)

Returns:


222
# File 'lib/aws/simple_workflow/client.rb', line 222

define_client_method :describe_activity_type, 'DescribeActivityType'

#describe_domain(options = {}) ⇒ Core::Response

Calls the DescribeDomain API operation.

Options:

  • :name - required - (String)

Response Structure:

  • domainInfo - (Hash)

    • name - (String)

    • status - (String)

    • description - (String)

  • configuration - (Hash)

    • workflowExecutionRetentionPeriodInDays - (String)

Returns:


242
# File 'lib/aws/simple_workflow/client.rb', line 242

define_client_method :describe_domain, 'DescribeDomain'

#describe_workflow_execution(options = {}) ⇒ Core::Response

Calls the DescribeWorkflowExecution API operation.

Options:

  • :domain - required - (String)

  • :execution - required - (Hash)

    • :workflow_id - required - (String)

    • :run_id - required - (String)

Response Structure:

  • executionInfo - (Hash)

    • execution - (Hash)

      • workflowId - (String)

      • runId - (String)

    • workflowType - (Hash)

      • name - (String)

      • version - (String)

    • startTimestamp - (Time)

    • closeTimestamp - (Time)

    • executionStatus - (String)

    • closeStatus - (String)

    • parent - (Hash)

      • workflowId - (String)

      • runId - (String)

    • tagList - (Array<String>)

    • cancelRequested - (Boolean)

  • executionConfiguration - (Hash)

    • taskStartToCloseTimeout - (String)

    • executionStartToCloseTimeout - (String)

    • taskList - (Hash)

      • name - (String)

    • childPolicy - (String)

  • openCounts - (Hash)

    • openActivityTasks - (Integer)

    • openDecisionTasks - (Integer)

    • openTimers - (Integer)

    • openChildWorkflowExecutions - (Integer)

  • latestActivityTaskTimestamp - (Time)

  • latestExecutionContext - (String)

Returns:


288
# File 'lib/aws/simple_workflow/client.rb', line 288

define_client_method :describe_workflow_execution, 'DescribeWorkflowExecution'

#describe_workflow_type(options = {}) ⇒ Core::Response

Calls the DescribeWorkflowType API operation.

Options:

  • :domain - required - (String)

  • :workflow_type - required - (Hash)

    • :name - required - (String)

    • :version - required - (String)

Response Structure:

  • typeInfo - (Hash)

    • workflowType - (Hash)

      • name - (String)

      • version - (String)

    • status - (String)

    • description - (String)

    • creationDate - (Time)

    • deprecationDate - (Time)

  • configuration - (Hash)

    • defaultTaskStartToCloseTimeout - (String)

    • defaultExecutionStartToCloseTimeout - (String)

    • defaultTaskList - (Hash)

      • name - (String)

    • defaultChildPolicy - (String)

Returns:


319
# File 'lib/aws/simple_workflow/client.rb', line 319

define_client_method :describe_workflow_type, 'DescribeWorkflowType'

#get_workflow_execution_history(options = {}) ⇒ Core::Response

Calls the GetWorkflowExecutionHistory API operation.

Options:

  • :domain - required - (String)

  • :execution - required - (Hash)

    • :workflow_id - required - (String)

    • :run_id - required - (String)

  • :next_page_token - (String)

  • :maximum_page_size - (Integer)

  • :reverse_order - (Boolean)

Response Structure:

  • events - (Array<Hash>)

    • eventTimestamp - (Time)

    • eventType - (String)

    • eventId - (Integer)

    • workflowExecutionStartedEventAttributes - (Hash)

      • input - (String)

      • executionStartToCloseTimeout - (String)

      • taskStartToCloseTimeout - (String)

      • childPolicy - (String)

      • taskList - (Hash)

        • name - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • tagList - (Array<String>)

      • continuedExecutionRunId - (String)

      • parentWorkflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • parentInitiatedEventId - (Integer)

    • workflowExecutionCompletedEventAttributes - (Hash)

      • result - (String)

      • decisionTaskCompletedEventId - (Integer)

    • completeWorkflowExecutionFailedEventAttributes - (Hash)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • workflowExecutionFailedEventAttributes - (Hash)

      • reason - (String)

      • details - (String)

      • decisionTaskCompletedEventId - (Integer)

    • failWorkflowExecutionFailedEventAttributes - (Hash)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • workflowExecutionTimedOutEventAttributes - (Hash)

      • timeoutType - (String)

      • childPolicy - (String)

    • workflowExecutionCanceledEventAttributes - (Hash)

      • details - (String)

      • decisionTaskCompletedEventId - (Integer)

    • cancelWorkflowExecutionFailedEventAttributes - (Hash)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • workflowExecutionContinuedAsNewEventAttributes - (Hash)

      • input - (String)

      • decisionTaskCompletedEventId - (Integer)

      • newExecutionRunId - (String)

      • executionStartToCloseTimeout - (String)

      • taskList - (Hash)

        • name - (String)

      • taskStartToCloseTimeout - (String)

      • childPolicy - (String)

      • tagList - (Array<String>)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

    • continueAsNewWorkflowExecutionFailedEventAttributes - (Hash)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • workflowExecutionTerminatedEventAttributes - (Hash)

      • reason - (String)

      • details - (String)

      • childPolicy - (String)

      • cause - (String)

    • workflowExecutionCancelRequestedEventAttributes - (Hash)

      • externalWorkflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • externalInitiatedEventId - (Integer)

      • cause - (String)

    • decisionTaskScheduledEventAttributes - (Hash)

      • taskList - (Hash)

        • name - (String)

      • startToCloseTimeout - (String)

    • decisionTaskStartedEventAttributes - (Hash)

      • identity - (String)

      • scheduledEventId - (Integer)

    • decisionTaskCompletedEventAttributes - (Hash)

      • executionContext - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

    • decisionTaskTimedOutEventAttributes - (Hash)

      • timeoutType - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

    • activityTaskScheduledEventAttributes - (Hash)

      • activityType - (Hash)

        • name - (String)

        • version - (String)

      • activityId - (String)

      • input - (String)

      • control - (String)

      • scheduleToStartTimeout - (String)

      • scheduleToCloseTimeout - (String)

      • startToCloseTimeout - (String)

      • taskList - (Hash)

        • name - (String)

      • decisionTaskCompletedEventId - (Integer)

      • heartbeatTimeout - (String)

    • activityTaskStartedEventAttributes - (Hash)

      • identity - (String)

      • scheduledEventId - (Integer)

    • activityTaskCompletedEventAttributes - (Hash)

      • result - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

    • activityTaskFailedEventAttributes - (Hash)

      • reason - (String)

      • details - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

    • activityTaskTimedOutEventAttributes - (Hash)

      • timeoutType - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

      • details - (String)

    • activityTaskCanceledEventAttributes - (Hash)

      • details - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

      • latestCancelRequestedEventId - (Integer)

    • activityTaskCancelRequestedEventAttributes - (Hash)

      • decisionTaskCompletedEventId - (Integer)

      • activityId - (String)

    • workflowExecutionSignaledEventAttributes - (Hash)

      • signalName - (String)

      • input - (String)

      • externalWorkflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • externalInitiatedEventId - (Integer)

    • markerRecordedEventAttributes - (Hash)

      • markerName - (String)

      • details - (String)

      • decisionTaskCompletedEventId - (Integer)

    • timerStartedEventAttributes - (Hash)

      • timerId - (String)

      • control - (String)

      • startToFireTimeout - (String)

      • decisionTaskCompletedEventId - (Integer)

    • timerFiredEventAttributes - (Hash)

      • timerId - (String)

      • startedEventId - (Integer)

    • timerCanceledEventAttributes - (Hash)

      • timerId - (String)

      • startedEventId - (Integer)

      • decisionTaskCompletedEventId - (Integer)

    • startChildWorkflowExecutionInitiatedEventAttributes - (Hash)

      • workflowId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • control - (String)

      • input - (String)

      • executionStartToCloseTimeout - (String)

      • taskList - (Hash)

        • name - (String)

      • decisionTaskCompletedEventId - (Integer)

      • childPolicy - (String)

      • taskStartToCloseTimeout - (String)

      • tagList - (Array<String>)

    • childWorkflowExecutionStartedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • initiatedEventId - (Integer)

    • childWorkflowExecutionCompletedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • result - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • childWorkflowExecutionFailedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • reason - (String)

      • details - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • childWorkflowExecutionTimedOutEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • timeoutType - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • childWorkflowExecutionCanceledEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • details - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • childWorkflowExecutionTerminatedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • signalExternalWorkflowExecutionInitiatedEventAttributes - (Hash)

      • workflowId - (String)

      • runId - (String)

      • signalName - (String)

      • input - (String)

      • decisionTaskCompletedEventId - (Integer)

      • control - (String)

    • externalWorkflowExecutionSignaledEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • initiatedEventId - (Integer)

    • signalExternalWorkflowExecutionFailedEventAttributes - (Hash)

      • workflowId - (String)

      • runId - (String)

      • cause - (String)

      • initiatedEventId - (Integer)

      • decisionTaskCompletedEventId - (Integer)

    • externalWorkflowExecutionCancelRequestedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • initiatedEventId - (Integer)

    • requestCancelExternalWorkflowExecutionInitiatedEventAttributes - (Hash)

      • workflowId - (String)

      • runId - (String)

      • decisionTaskCompletedEventId - (Integer)

      • control - (String)

    • requestCancelExternalWorkflowExecutionFailedEventAttributes - (Hash)

      • workflowId - (String)

      • runId - (String)

      • cause - (String)

      • initiatedEventId - (Integer)

      • decisionTaskCompletedEventId - (Integer)

    • scheduleActivityTaskFailedEventAttributes - (Hash)

      • activityType - (Hash)

        • name - (String)

        • version - (String)

      • activityId - (String)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • requestCancelActivityTaskFailedEventAttributes - (Hash)

      • activityId - (String)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • startTimerFailedEventAttributes - (Hash)

      • timerId - (String)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • cancelTimerFailedEventAttributes - (Hash)

      • timerId - (String)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • startChildWorkflowExecutionFailedEventAttributes - (Hash)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • cause - (String)

      • workflowId - (String)

      • initiatedEventId - (Integer)

      • decisionTaskCompletedEventId - (Integer)

  • nextPageToken - (String)

Returns:


619
# File 'lib/aws/simple_workflow/client.rb', line 619

define_client_method :get_workflow_execution_history, 'GetWorkflowExecutionHistory'

#list_activity_types(options = {}) ⇒ Core::Response

Calls the ListActivityTypes API operation.

Options:

  • :domain - required - (String)

  • :name - (String)

  • :registration_status - required - (String)

  • :next_page_token - (String)

  • :maximum_page_size - (Integer)

  • :reverse_order - (Boolean)

Response Structure:

  • typeInfos - (Array<Hash>)

    • activityType - (Hash)

      • name - (String)

      • version - (String)

    • status - (String)

    • description - (String)

    • creationDate - (Time)

    • deprecationDate - (Time)

  • nextPageToken - (String)

Returns:


647
# File 'lib/aws/simple_workflow/client.rb', line 647

define_client_method :list_activity_types, 'ListActivityTypes'

#list_closed_workflow_executions(options = {}) ⇒ Core::Response

Calls the ListClosedWorkflowExecutions API operation.

Options:

  • :domain - required - (String)

  • :start_time_filter - (Hash)

    • :oldest_date - required - (Integer<unix timestamp>)

    • :latest_date - (Integer<unix timestamp>)

  • :close_time_filter - (Hash)

    • :oldest_date - required - (Integer<unix timestamp>)

    • :latest_date - (Integer<unix timestamp>)

  • :execution_filter - (Hash)

    • :workflow_id - required - (String)

  • :close_status_filter - (Hash)

    • :status - required - (String)

  • :type_filter - (Hash)

    • :name - required - (String)

    • :version - (String)

  • :tag_filter - (Hash)

    • :tag - required - (String)

  • :next_page_token - (String)

  • :maximum_page_size - (Integer)

  • :reverse_order - (Boolean)

Response Structure:

  • executionInfos - (Array<Hash>)

    • execution - (Hash)

      • workflowId - (String)

      • runId - (String)

    • workflowType - (Hash)

      • name - (String)

      • version - (String)

    • startTimestamp - (Time)

    • closeTimestamp - (Time)

    • executionStatus - (String)

    • closeStatus - (String)

    • parent - (Hash)

      • workflowId - (String)

      • runId - (String)

    • tagList - (Array<String>)

    • cancelRequested - (Boolean)

  • nextPageToken - (String)

Returns:


696
# File 'lib/aws/simple_workflow/client.rb', line 696

define_client_method :list_closed_workflow_executions, 'ListClosedWorkflowExecutions'

#list_domains(options = {}) ⇒ Core::Response

Calls the ListDomains API operation.

Options:

  • :next_page_token - (String)

  • :registration_status - required - (String)

  • :maximum_page_size - (Integer)

  • :reverse_order - (Boolean)

Response Structure:

  • domainInfos - (Array<Hash>)

    • name - (String)

    • status - (String)

    • description - (String)

  • nextPageToken - (String)

Returns:


718
# File 'lib/aws/simple_workflow/client.rb', line 718

define_client_method :list_domains, 'ListDomains'

#list_open_workflow_executions(options = {}) ⇒ Core::Response

Calls the ListOpenWorkflowExecutions API operation.

Options:

  • :domain - required - (String)

  • :start_time_filter - required - (Hash)

    • :oldest_date - required - (Integer<unix timestamp>)

    • :latest_date - (Integer<unix timestamp>)

  • :type_filter - (Hash)

    • :name - required - (String)

    • :version - (String)

  • :tag_filter - (Hash)

    • :tag - required - (String)

  • :next_page_token - (String)

  • :maximum_page_size - (Integer)

  • :reverse_order - (Boolean)

  • :execution_filter - (Hash)

    • :workflow_id - required - (String)

Response Structure:

  • executionInfos - (Array<Hash>)

    • execution - (Hash)

      • workflowId - (String)

      • runId - (String)

    • workflowType - (Hash)

      • name - (String)

      • version - (String)

    • startTimestamp - (Time)

    • closeTimestamp - (Time)

    • executionStatus - (String)

    • closeStatus - (String)

    • parent - (Hash)

      • workflowId - (String)

      • runId - (String)

    • tagList - (Array<String>)

    • cancelRequested - (Boolean)

  • nextPageToken - (String)

Returns:


762
# File 'lib/aws/simple_workflow/client.rb', line 762

define_client_method :list_open_workflow_executions, 'ListOpenWorkflowExecutions'

#list_workflow_types(options = {}) ⇒ Core::Response

Calls the ListWorkflowTypes API operation.

Options:

  • :domain - required - (String)

  • :name - (String)

  • :registration_status - required - (String)

  • :next_page_token - (String)

  • :maximum_page_size - (Integer)

  • :reverse_order - (Boolean)

Response Structure:

  • typeInfos - (Array<Hash>)

    • workflowType - (Hash)

      • name - (String)

      • version - (String)

    • status - (String)

    • description - (String)

    • creationDate - (Time)

    • deprecationDate - (Time)

  • nextPageToken - (String)

Returns:


790
# File 'lib/aws/simple_workflow/client.rb', line 790

define_client_method :list_workflow_types, 'ListWorkflowTypes'

#poll_for_activity_task(options = {}) ⇒ Core::Response

Calls the PollForActivityTask API operation.

Options:

  • :domain - required - (String)

  • :task_list - required - (Hash)

    • :name - required - (String)

  • :identity - (String)

Response Structure:

  • taskToken - (String)

  • activityId - (String)

  • startedEventId - (Integer)

  • workflowExecution - (Hash)

    • workflowId - (String)

    • runId - (String)

  • activityType - (Hash)

    • name - (String)

    • version - (String)

  • input - (String)

Returns:


817
# File 'lib/aws/simple_workflow/client.rb', line 817

define_client_method :poll_for_activity_task, 'PollForActivityTask'

#poll_for_decision_task(options = {}) ⇒ Core::Response

Calls the PollForDecisionTask API operation.

Options:

  • :domain - required - (String)

  • :task_list - required - (Hash)

    • :name - required - (String)

  • :identity - (String)

  • :next_page_token - (String)

  • :maximum_page_size - (Integer)

  • :reverse_order - (Boolean)

Response Structure:

  • taskToken - (String)

  • startedEventId - (Integer)

  • workflowExecution - (Hash)

    • workflowId - (String)

    • runId - (String)

  • workflowType - (Hash)

    • name - (String)

    • version - (String)

  • events - (Array<Hash>)

    • eventTimestamp - (Time)

    • eventType - (String)

    • eventId - (Integer)

    • workflowExecutionStartedEventAttributes - (Hash)

      • input - (String)

      • executionStartToCloseTimeout - (String)

      • taskStartToCloseTimeout - (String)

      • childPolicy - (String)

      • taskList - (Hash)

        • name - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • tagList - (Array<String>)

      • continuedExecutionRunId - (String)

      • parentWorkflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • parentInitiatedEventId - (Integer)

    • workflowExecutionCompletedEventAttributes - (Hash)

      • result - (String)

      • decisionTaskCompletedEventId - (Integer)

    • completeWorkflowExecutionFailedEventAttributes - (Hash)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • workflowExecutionFailedEventAttributes - (Hash)

      • reason - (String)

      • details - (String)

      • decisionTaskCompletedEventId - (Integer)

    • failWorkflowExecutionFailedEventAttributes - (Hash)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • workflowExecutionTimedOutEventAttributes - (Hash)

      • timeoutType - (String)

      • childPolicy - (String)

    • workflowExecutionCanceledEventAttributes - (Hash)

      • details - (String)

      • decisionTaskCompletedEventId - (Integer)

    • cancelWorkflowExecutionFailedEventAttributes - (Hash)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • workflowExecutionContinuedAsNewEventAttributes - (Hash)

      • input - (String)

      • decisionTaskCompletedEventId - (Integer)

      • newExecutionRunId - (String)

      • executionStartToCloseTimeout - (String)

      • taskList - (Hash)

        • name - (String)

      • taskStartToCloseTimeout - (String)

      • childPolicy - (String)

      • tagList - (Array<String>)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

    • continueAsNewWorkflowExecutionFailedEventAttributes - (Hash)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • workflowExecutionTerminatedEventAttributes - (Hash)

      • reason - (String)

      • details - (String)

      • childPolicy - (String)

      • cause - (String)

    • workflowExecutionCancelRequestedEventAttributes - (Hash)

      • externalWorkflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • externalInitiatedEventId - (Integer)

      • cause - (String)

    • decisionTaskScheduledEventAttributes - (Hash)

      • taskList - (Hash)

        • name - (String)

      • startToCloseTimeout - (String)

    • decisionTaskStartedEventAttributes - (Hash)

      • identity - (String)

      • scheduledEventId - (Integer)

    • decisionTaskCompletedEventAttributes - (Hash)

      • executionContext - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

    • decisionTaskTimedOutEventAttributes - (Hash)

      • timeoutType - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

    • activityTaskScheduledEventAttributes - (Hash)

      • activityType - (Hash)

        • name - (String)

        • version - (String)

      • activityId - (String)

      • input - (String)

      • control - (String)

      • scheduleToStartTimeout - (String)

      • scheduleToCloseTimeout - (String)

      • startToCloseTimeout - (String)

      • taskList - (Hash)

        • name - (String)

      • decisionTaskCompletedEventId - (Integer)

      • heartbeatTimeout - (String)

    • activityTaskStartedEventAttributes - (Hash)

      • identity - (String)

      • scheduledEventId - (Integer)

    • activityTaskCompletedEventAttributes - (Hash)

      • result - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

    • activityTaskFailedEventAttributes - (Hash)

      • reason - (String)

      • details - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

    • activityTaskTimedOutEventAttributes - (Hash)

      • timeoutType - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

      • details - (String)

    • activityTaskCanceledEventAttributes - (Hash)

      • details - (String)

      • scheduledEventId - (Integer)

      • startedEventId - (Integer)

      • latestCancelRequestedEventId - (Integer)

    • activityTaskCancelRequestedEventAttributes - (Hash)

      • decisionTaskCompletedEventId - (Integer)

      • activityId - (String)

    • workflowExecutionSignaledEventAttributes - (Hash)

      • signalName - (String)

      • input - (String)

      • externalWorkflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • externalInitiatedEventId - (Integer)

    • markerRecordedEventAttributes - (Hash)

      • markerName - (String)

      • details - (String)

      • decisionTaskCompletedEventId - (Integer)

    • timerStartedEventAttributes - (Hash)

      • timerId - (String)

      • control - (String)

      • startToFireTimeout - (String)

      • decisionTaskCompletedEventId - (Integer)

    • timerFiredEventAttributes - (Hash)

      • timerId - (String)

      • startedEventId - (Integer)

    • timerCanceledEventAttributes - (Hash)

      • timerId - (String)

      • startedEventId - (Integer)

      • decisionTaskCompletedEventId - (Integer)

    • startChildWorkflowExecutionInitiatedEventAttributes - (Hash)

      • workflowId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • control - (String)

      • input - (String)

      • executionStartToCloseTimeout - (String)

      • taskList - (Hash)

        • name - (String)

      • decisionTaskCompletedEventId - (Integer)

      • childPolicy - (String)

      • taskStartToCloseTimeout - (String)

      • tagList - (Array<String>)

    • childWorkflowExecutionStartedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • initiatedEventId - (Integer)

    • childWorkflowExecutionCompletedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • result - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • childWorkflowExecutionFailedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • reason - (String)

      • details - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • childWorkflowExecutionTimedOutEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • timeoutType - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • childWorkflowExecutionCanceledEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • details - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • childWorkflowExecutionTerminatedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • initiatedEventId - (Integer)

      • startedEventId - (Integer)

    • signalExternalWorkflowExecutionInitiatedEventAttributes - (Hash)

      • workflowId - (String)

      • runId - (String)

      • signalName - (String)

      • input - (String)

      • decisionTaskCompletedEventId - (Integer)

      • control - (String)

    • externalWorkflowExecutionSignaledEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • initiatedEventId - (Integer)

    • signalExternalWorkflowExecutionFailedEventAttributes - (Hash)

      • workflowId - (String)

      • runId - (String)

      • cause - (String)

      • initiatedEventId - (Integer)

      • decisionTaskCompletedEventId - (Integer)

    • externalWorkflowExecutionCancelRequestedEventAttributes - (Hash)

      • workflowExecution - (Hash)

        • workflowId - (String)

        • runId - (String)

      • initiatedEventId - (Integer)

    • requestCancelExternalWorkflowExecutionInitiatedEventAttributes - (Hash)

      • workflowId - (String)

      • runId - (String)

      • decisionTaskCompletedEventId - (Integer)

      • control - (String)

    • requestCancelExternalWorkflowExecutionFailedEventAttributes - (Hash)

      • workflowId - (String)

      • runId - (String)

      • cause - (String)

      • initiatedEventId - (Integer)

      • decisionTaskCompletedEventId - (Integer)

    • scheduleActivityTaskFailedEventAttributes - (Hash)

      • activityType - (Hash)

        • name - (String)

        • version - (String)

      • activityId - (String)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • requestCancelActivityTaskFailedEventAttributes - (Hash)

      • activityId - (String)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • startTimerFailedEventAttributes - (Hash)

      • timerId - (String)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • cancelTimerFailedEventAttributes - (Hash)

      • timerId - (String)

      • cause - (String)

      • decisionTaskCompletedEventId - (Integer)

    • startChildWorkflowExecutionFailedEventAttributes - (Hash)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • cause - (String)

      • workflowId - (String)

      • initiatedEventId - (Integer)

      • decisionTaskCompletedEventId - (Integer)

  • nextPageToken - (String)

  • previousStartedEventId - (Integer)

Returns:


1126
# File 'lib/aws/simple_workflow/client.rb', line 1126

define_client_method :poll_for_decision_task, 'PollForDecisionTask'

#record_activity_task_heartbeat(options = {}) ⇒ Core::Response

Calls the RecordActivityTaskHeartbeat API operation.

Options:

  • :task_token - required - (String)

  • :details - (String)

Response Structure:

  • cancelRequested - (Boolean)

Returns:


1142
# File 'lib/aws/simple_workflow/client.rb', line 1142

define_client_method :record_activity_task_heartbeat, 'RecordActivityTaskHeartbeat'

#register_activity_type(options = {}) ⇒ Core::Response

Calls the RegisterActivityType API operation.

Options:

  • :domain - required - (String)

  • :name - required - (String)

  • :version - required - (String)

  • :description - (String)

  • :default_task_start_to_close_timeout - (String)

  • :default_task_heartbeat_timeout - (String)

  • :default_task_list - (Hash)

    • :name - required - (String)

  • :default_task_schedule_to_start_timeout - (String)

  • :default_task_schedule_to_close_timeout - (String)

Response Structure:

This method returns no response data.

Returns:


1166
# File 'lib/aws/simple_workflow/client.rb', line 1166

define_client_method :register_activity_type, 'RegisterActivityType'

#register_domain(options = {}) ⇒ Core::Response

Calls the RegisterDomain API operation.

Options:

  • :name - required - (String)

  • :description - (String)

  • :workflow_execution_retention_period_in_days - required - (String)

Response Structure:

This method returns no response data.

Returns:


1183
# File 'lib/aws/simple_workflow/client.rb', line 1183

define_client_method :register_domain, 'RegisterDomain'

#register_workflow_type(options = {}) ⇒ Core::Response

Calls the RegisterWorkflowType API operation.

Options:

  • :domain - required - (String)

  • :name - required - (String)

  • :version - required - (String)

  • :description - (String)

  • :default_task_start_to_close_timeout - (String)

  • :default_execution_start_to_close_timeout - (String)

  • :default_task_list - (Hash)

    • :name - required - (String)

  • :default_child_policy - (String)

Response Structure:

This method returns no response data.

Returns:


1206
# File 'lib/aws/simple_workflow/client.rb', line 1206

define_client_method :register_workflow_type, 'RegisterWorkflowType'

#request_cancel_workflow_execution(options = {}) ⇒ Core::Response

Calls the RequestCancelWorkflowExecution API operation.

Options:

  • :domain - required - (String)

  • :workflow_id - required - (String)

  • :run_id - (String)

Response Structure:

This method returns no response data.

Returns:


1223
# File 'lib/aws/simple_workflow/client.rb', line 1223

define_client_method :request_cancel_workflow_execution, 'RequestCancelWorkflowExecution'

#respond_activity_task_canceled(options = {}) ⇒ Core::Response

Calls the RespondActivityTaskCanceled API operation.

Options:

  • :task_token - required - (String)

  • :details - (String)

Response Structure:

This method returns no response data.

Returns:


1239
# File 'lib/aws/simple_workflow/client.rb', line 1239

define_client_method :respond_activity_task_canceled, 'RespondActivityTaskCanceled'

#respond_activity_task_completed(options = {}) ⇒ Core::Response

Calls the RespondActivityTaskCompleted API operation.

Options:

  • :task_token - required - (String)

  • :result - (String)

Response Structure:

This method returns no response data.

Returns:


1255
# File 'lib/aws/simple_workflow/client.rb', line 1255

define_client_method :respond_activity_task_completed, 'RespondActivityTaskCompleted'

#respond_activity_task_failed(options = {}) ⇒ Core::Response

Calls the RespondActivityTaskFailed API operation.

Options:

  • :task_token - required - (String)

  • :reason - (String)

  • :details - (String)

Response Structure:

This method returns no response data.

Returns:


1272
# File 'lib/aws/simple_workflow/client.rb', line 1272

define_client_method :respond_activity_task_failed, 'RespondActivityTaskFailed'

#respond_decision_task_completed(options = {}) ⇒ Core::Response

Calls the RespondDecisionTaskCompleted API operation.

Options:

  • :task_token - required - (String)

  • :decisions - (Array<Hash>)

    • :decision_type - required - (String)

    • :schedule_activity_task_decision_attributes - (Hash)

      • :activity_type - required - (Hash)

        • :name - required - (String)

        • :version - required - (String)

      • :activity_id - required - (String)

      • :control - (String)

      • :input - (String)

      • :schedule_to_close_timeout - (String)

      • :task_list - (Hash)

        • :name - required - (String)

      • :schedule_to_start_timeout - (String)

      • :start_to_close_timeout - (String)

      • :heartbeat_timeout - (String)

    • :request_cancel_activity_task_decision_attributes - (Hash)

      • :activity_id - required - (String)

    • :complete_workflow_execution_decision_attributes - (Hash)

      • :result - (String)

    • :fail_workflow_execution_decision_attributes - (Hash)

      • :reason - (String)

      • :details - (String)

    • :cancel_workflow_execution_decision_attributes - (Hash)

      • :details - (String)

    • :continue_as_new_workflow_execution_decision_attributes - (Hash)

      • :input - (String)

      • :execution_start_to_close_timeout - (String)

      • :task_list - (Hash)

        • :name - required - (String)

      • :task_start_to_close_timeout - (String)

      • :child_policy - (String)

      • :tag_list - (Array<String>)

      • :workflow_type_version - (String)

    • :record_marker_decision_attributes - (Hash)

      • :marker_name - required - (String)

      • :details - (String)

    • :start_timer_decision_attributes - (Hash)

      • :timer_id - required - (String)

      • :control - (String)

      • :start_to_fire_timeout - required - (String)

    • :cancel_timer_decision_attributes - (Hash)

      • :timer_id - required - (String)

    • :signal_external_workflow_execution_decision_attributes - (Hash)

      • :workflow_id - required - (String)

      • :run_id - (String)

      • :signal_name - required - (String)

      • :input - (String)

      • :control - (String)

    • :request_cancel_external_workflow_execution_decision_attributes - (Hash)

      • :workflow_id - required - (String)

      • :run_id - (String)

      • :control - (String)

    • :start_child_workflow_execution_decision_attributes - (Hash)

      • :workflow_type - required - (Hash)

        • :name - required - (String)

        • :version - required - (String)

      • :workflow_id - required - (String)

      • :control - (String)

      • :input - (String)

      • :execution_start_to_close_timeout - (String)

      • :task_list - (Hash)

        • :name - required - (String)

      • :task_start_to_close_timeout - (String)

      • :child_policy - (String)

      • :tag_list - (Array<String>)

  • :execution_context - (String)

Response Structure:

This method returns no response data.

Returns:


1353
# File 'lib/aws/simple_workflow/client.rb', line 1353

define_client_method :respond_decision_task_completed, 'RespondDecisionTaskCompleted'

#signal_workflow_execution(options = {}) ⇒ Core::Response

Calls the SignalWorkflowExecution API operation.

Options:

  • :domain - required - (String)

  • :workflow_id - required - (String)

  • :run_id - (String)

  • :signal_name - required - (String)

  • :input - (String)

Response Structure:

This method returns no response data.

Returns:


1372
# File 'lib/aws/simple_workflow/client.rb', line 1372

define_client_method :signal_workflow_execution, 'SignalWorkflowExecution'

#start_workflow_execution(options = {}) ⇒ Core::Response

Calls the StartWorkflowExecution API operation.

Options:

  • :domain - required - (String)

  • :workflow_id - required - (String)

  • :workflow_type - required - (Hash)

    • :name - required - (String)

    • :version - required - (String)

  • :task_list - (Hash)

    • :name - required - (String)

  • :input - (String)

  • :execution_start_to_close_timeout - (String)

  • :tag_list - (Array<String>)

  • :task_start_to_close_timeout - (String)

  • :child_policy - (String)

Response Structure:

  • runId - (String)

Returns:


1398
# File 'lib/aws/simple_workflow/client.rb', line 1398

define_client_method :start_workflow_execution, 'StartWorkflowExecution'

#terminate_workflow_execution(options = {}) ⇒ Core::Response

Calls the TerminateWorkflowExecution API operation.

Options:

  • :domain - required - (String)

  • :workflow_id - required - (String)

  • :run_id - (String)

  • :reason - (String)

  • :details - (String)

  • :child_policy - (String)

Response Structure:

This method returns no response data.

Returns:


1418
# File 'lib/aws/simple_workflow/client.rb', line 1418

define_client_method :terminate_workflow_execution, 'TerminateWorkflowExecution'