Class: AWS::SimpleWorkflow::Client

Inherits:
Core::JSONClient show all
Defined in:
lib/aws/simple_workflow/client.rb

Overview

Client class for Amazon Simple Workflow Service (SWF).

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, operations, #with_http_handler, #with_options

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.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • count - (Integer)

    • truncated - (Boolean)



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

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

Calls the CountOpenWorkflowExecutions API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • count - (Integer)

    • truncated - (Boolean)



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

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

Calls the CountPendingActivityTasks API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :task_list - required - (Hash)

      • :name - required - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • count - (Integer)

    • truncated - (Boolean)



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

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

Calls the CountPendingDecisionTasks API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :task_list - required - (Hash)

      • :name - required - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • count - (Integer)

    • truncated - (Boolean)



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

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

Calls the DeprecateActivityType API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :activity_type - required - (Hash)

      • :name - required - (String)

      • :version - required - (String)

Returns:



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

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

Calls the DeprecateDomain API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :name - required - (String)

Returns:



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

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

Calls the DeprecateWorkflowType API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :workflow_type - required - (Hash)

      • :name - required - (String)

      • :version - required - (String)

Returns:



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

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

Calls the DescribeActivityType API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :activity_type - required - (Hash)

      • :name - required - (String)

      • :version - required - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following 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)



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

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

Calls the DescribeDomain API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :name - required - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • domainInfo - (Hash)

      • name - (String)

      • status - (String)

      • description - (String)

    • configuration - (Hash)

      • workflowExecutionRetentionPeriodInDays - (String)



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

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

Calls the DescribeWorkflowExecution API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :execution - required - (Hash)

      • :workflow_id - required - (String)

      • :run_id - required - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following 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)



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

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

Calls the DescribeWorkflowType API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :workflow_type - required - (Hash)

      • :name - required - (String)

      • :version - required - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following 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)



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

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

Calls the GetWorkflowExecutionHistory API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following 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)



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

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

Calls the ListActivityTypes API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :name - (String)

    • :registration_status - required - (String)

    • :next_page_token - (String)

    • :maximum_page_size - (Integer)

    • :reverse_order - (Boolean)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • typeInfos - (Array<Hash>)

      • activityType - (Hash)

        • name - (String)

        • version - (String)

      • status - (String)

      • description - (String)

      • creationDate - (Time)

      • deprecationDate - (Time)

    • nextPageToken - (String)



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

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

Calls the ListClosedWorkflowExecutions API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following 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)



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

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

Calls the ListDomains API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :next_page_token - (String)

    • :registration_status - required - (String)

    • :maximum_page_size - (Integer)

    • :reverse_order - (Boolean)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • domainInfos - (Array<Hash>)

      • name - (String)

      • status - (String)

      • description - (String)

    • nextPageToken - (String)



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

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

Calls the ListOpenWorkflowExecutions API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following 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)



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

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

Calls the ListWorkflowTypes API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :name - (String)

    • :registration_status - required - (String)

    • :next_page_token - (String)

    • :maximum_page_size - (Integer)

    • :reverse_order - (Boolean)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • typeInfos - (Array<Hash>)

      • workflowType - (Hash)

        • name - (String)

        • version - (String)

      • status - (String)

      • description - (String)

      • creationDate - (Time)

      • deprecationDate - (Time)

    • nextPageToken - (String)



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

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

Calls the PollForActivityTask API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :task_list - required - (Hash)

      • :name - required - (String)

    • :identity - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • taskToken - (String)

    • activityId - (String)

    • startedEventId - (Integer)

    • workflowExecution - (Hash)

      • workflowId - (String)

      • runId - (String)

    • activityType - (Hash)

      • name - (String)

      • version - (String)

    • input - (String)



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

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

Calls the PollForDecisionTask API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :task_list - required - (Hash)

      • :name - required - (String)

    • :identity - (String)

    • :next_page_token - (String)

    • :maximum_page_size - (Integer)

    • :reverse_order - (Boolean)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following 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)



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

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

Calls the RecordActivityTaskHeartbeat API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :task_token - required - (String)

    • :details - (String)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • cancelRequested - (Boolean)



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

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

Calls the RegisterActivityType API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:



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

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

Calls the RegisterDomain API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :name - required - (String)

    • :description - (String)

    • :workflow_execution_retention_period_in_days - required - (String)

Returns:



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

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

Calls the RegisterWorkflowType API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:



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

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

Calls the RequestCancelWorkflowExecution API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :workflow_id - required - (String)

    • :run_id - (String)

Returns:



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

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

Calls the RespondActivityTaskCanceled API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :task_token - required - (String)

    • :details - (String)

Returns:



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

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

Calls the RespondActivityTaskCompleted API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :task_token - required - (String)

    • :result - (String)

Returns:



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

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

Calls the RespondActivityTaskFailed API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :task_token - required - (String)

    • :reason - (String)

    • :details - (String)

Returns:



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

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

Calls the RespondDecisionTaskCompleted API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:



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

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

Calls the SignalWorkflowExecution API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :workflow_id - required - (String)

    • :run_id - (String)

    • :signal_name - required - (String)

    • :input - (String)

Returns:



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

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

Calls the StartWorkflowExecution API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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)

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • runId - (String)



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

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

Calls the TerminateWorkflowExecution API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :domain - required - (String)

    • :workflow_id - required - (String)

    • :run_id - (String)

    • :reason - (String)

    • :details - (String)

    • :child_policy - (String)

Returns:



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