ExAws.SWF.Core

Amazon Simple Workflow Service

Amazon Simple Workflow Service

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon’s cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide.

Source

Summary

count_closed_workflow_executions!(client, input)

Same as count_closed_workflow_executions/2 but raise on error

count_closed_workflow_executions(client, input)

CountClosedWorkflowExecutions

count_open_workflow_executions!(client, input)

Same as count_open_workflow_executions/2 but raise on error

count_open_workflow_executions(client, input)

CountOpenWorkflowExecutions

count_pending_activity_tasks!(client, input)

Same as count_pending_activity_tasks/2 but raise on error

count_pending_activity_tasks(client, input)

CountPendingActivityTasks

count_pending_decision_tasks!(client, input)

Same as count_pending_decision_tasks/2 but raise on error

count_pending_decision_tasks(client, input)

CountPendingDecisionTasks

deprecate_activity_type!(client, input)

Same as deprecate_activity_type/2 but raise on error

deprecate_activity_type(client, input)

DeprecateActivityType

deprecate_domain!(client, input)

Same as deprecate_domain/2 but raise on error

deprecate_domain(client, input)

DeprecateDomain

deprecate_workflow_type!(client, input)

Same as deprecate_workflow_type/2 but raise on error

deprecate_workflow_type(client, input)

DeprecateWorkflowType

describe_activity_type!(client, input)

Same as describe_activity_type/2 but raise on error

describe_activity_type(client, input)

DescribeActivityType

describe_domain!(client, input)

Same as describe_domain/2 but raise on error

describe_domain(client, input)

DescribeDomain

describe_workflow_execution!(client, input)

Same as describe_workflow_execution/2 but raise on error

describe_workflow_execution(client, input)

DescribeWorkflowExecution

describe_workflow_type!(client, input)

Same as describe_workflow_type/2 but raise on error

describe_workflow_type(client, input)

DescribeWorkflowType

get_workflow_execution_history!(client, input)

Same as get_workflow_execution_history/2 but raise on error

get_workflow_execution_history(client, input)

GetWorkflowExecutionHistory

list_activity_types!(client, input)

Same as list_activity_types/2 but raise on error

list_activity_types(client, input)

ListActivityTypes

list_closed_workflow_executions!(client, input)

Same as list_closed_workflow_executions/2 but raise on error

list_closed_workflow_executions(client, input)

ListClosedWorkflowExecutions

list_domains!(client, input)

Same as list_domains/2 but raise on error

list_domains(client, input)

ListDomains

list_open_workflow_executions!(client, input)

Same as list_open_workflow_executions/2 but raise on error

list_open_workflow_executions(client, input)

ListOpenWorkflowExecutions

list_workflow_types!(client, input)

Same as list_workflow_types/2 but raise on error

list_workflow_types(client, input)

ListWorkflowTypes

poll_for_activity_task!(client, input)

Same as poll_for_activity_task/2 but raise on error

poll_for_activity_task(client, input)

PollForActivityTask

poll_for_decision_task!(client, input)

Same as poll_for_decision_task/2 but raise on error

poll_for_decision_task(client, input)

PollForDecisionTask

record_activity_task_heartbeat!(client, input)

Same as record_activity_task_heartbeat/2 but raise on error

record_activity_task_heartbeat(client, input)

RecordActivityTaskHeartbeat

register_activity_type!(client, input)

Same as register_activity_type/2 but raise on error

register_activity_type(client, input)

RegisterActivityType

register_domain!(client, input)

Same as register_domain/2 but raise on error

register_domain(client, input)

RegisterDomain

register_workflow_type!(client, input)

Same as register_workflow_type/2 but raise on error

register_workflow_type(client, input)

RegisterWorkflowType

request_cancel_workflow_execution!(client, input)

Same as request_cancel_workflow_execution/2 but raise on error

request_cancel_workflow_execution(client, input)

RequestCancelWorkflowExecution

respond_activity_task_canceled!(client, input)

Same as respond_activity_task_canceled/2 but raise on error

respond_activity_task_canceled(client, input)

RespondActivityTaskCanceled

respond_activity_task_completed!(client, input)

Same as respond_activity_task_completed/2 but raise on error

respond_activity_task_completed(client, input)

RespondActivityTaskCompleted

respond_activity_task_failed!(client, input)

Same as respond_activity_task_failed/2 but raise on error

respond_activity_task_failed(client, input)

RespondActivityTaskFailed

respond_decision_task_completed!(client, input)

Same as respond_decision_task_completed/2 but raise on error

respond_decision_task_completed(client, input)

RespondDecisionTaskCompleted

signal_workflow_execution!(client, input)

Same as signal_workflow_execution/2 but raise on error

signal_workflow_execution(client, input)

SignalWorkflowExecution

start_workflow_execution!(client, input)

Same as start_workflow_execution/2 but raise on error

start_workflow_execution(client, input)

StartWorkflowExecution

terminate_workflow_execution!(client, input)

Same as terminate_workflow_execution/2 but raise on error

terminate_workflow_execution(client, input)

TerminateWorkflowExecution

Types

task_list :: [{:name, name}]

page_size :: integer

list_activity_types_input :: [domain: domain_name, maximum_page_size: page_size, name: name, next_page_token: page_token, registration_status: registration_status, reverse_order: reverse_order]

failure_reason :: binary

execution_status :: binary

timer_fired_event_attributes :: [started_event_id: event_id, timer_id: timer_id]

version_optional :: binary

signal_external_workflow_execution_initiated_event_attributes :: [control: data, decision_task_completed_event_id: event_id, input: data, run_id: run_id_optional, signal_name: signal_name, workflow_id: workflow_id]

activity_type :: [name: name, version: version]

function_name :: binary

duration_in_days :: binary

start_workflow_execution_input :: [child_policy: child_policy, domain: domain_name, execution_start_to_close_timeout: duration_in_seconds_optional, input: data, lambda_role: arn, tag_list: tag_list, task_list: task_list, task_priority: task_priority, task_start_to_close_timeout: duration_in_seconds_optional, workflow_id: workflow_id, workflow_type: workflow_type]

error_message :: binary

workflow_type_info :: [creation_date: timestamp, deprecation_date: timestamp, description: description, status: registration_status, workflow_type: workflow_type]

task_priority :: binary

count :: integer

timer_id :: binary

cancel_timer_failed_event_attributes :: [cause: cancel_timer_failed_cause, decision_task_completed_event_id: event_id, timer_id: timer_id]

lambda_function_scheduled_event_attributes :: [decision_task_completed_event_id: event_id, id: function_id, input: function_input, name: function_name, start_to_close_timeout: duration_in_seconds_optional]

child_workflow_execution_canceled_event_attributes :: [details: data, initiated_event_id: event_id, started_event_id: event_id, workflow_execution: workflow_execution, workflow_type: workflow_type]

activity_type_info :: [activity_type: activity_type, creation_date: timestamp, deprecation_date: timestamp, description: description, status: registration_status]

workflow_execution_failed_event_attributes :: [decision_task_completed_event_id: event_id, details: data, reason: failure_reason]

workflow_execution_configuration :: [child_policy: child_policy, execution_start_to_close_timeout: duration_in_seconds, lambda_role: arn, task_list: task_list, task_priority: task_priority, task_start_to_close_timeout: duration_in_seconds]

domain_infos :: [domain_infos: domain_info_list, next_page_token: page_token]

marker_name :: binary

canceled :: boolean

task_token :: binary

signal_external_workflow_execution_decision_attributes :: [control: data, input: data, run_id: run_id_optional, signal_name: signal_name, workflow_id: workflow_id]

list_open_workflow_executions_input :: [domain: domain_name, execution_filter: workflow_execution_filter, maximum_page_size: page_size, next_page_token: page_token, reverse_order: reverse_order, start_time_filter: execution_time_filter, tag_filter: tag_filter, type_filter: workflow_type_filter]

start_timer_decision_attributes :: [control: data, start_to_fire_timeout: duration_in_seconds, timer_id: timer_id]

signal_external_workflow_execution_failed_event_attributes :: [cause: signal_external_workflow_execution_failed_cause, control: data, decision_task_completed_event_id: event_id, initiated_event_id: event_id, run_id: run_id_optional, workflow_id: workflow_id]

child_workflow_execution_completed_event_attributes :: [initiated_event_id: event_id, result: data, started_event_id: event_id, workflow_execution: workflow_execution, workflow_type: workflow_type]

decision_task_completed_event_attributes :: [execution_context: data, scheduled_event_id: event_id, started_event_id: event_id]

workflow_execution_completed_event_attributes :: [decision_task_completed_event_id: event_id, result: data]

name :: binary

start_timer_failed_event_attributes :: [cause: start_timer_failed_cause, decision_task_completed_event_id: event_id, timer_id: timer_id]

function_id :: binary

timer_started_event_attributes :: [control: data, decision_task_completed_event_id: event_id, start_to_fire_timeout: duration_in_seconds, timer_id: timer_id]

event_id :: integer

activity_task_scheduled_event_attributes :: [activity_id: activity_id, activity_type: activity_type, control: data, decision_task_completed_event_id: event_id, heartbeat_timeout: duration_in_seconds_optional, input: data, schedule_to_close_timeout: duration_in_seconds_optional, schedule_to_start_timeout: duration_in_seconds_optional, start_to_close_timeout: duration_in_seconds_optional, task_list: task_list, task_priority: task_priority]

activity_type_configuration :: [default_task_heartbeat_timeout: duration_in_seconds_optional, default_task_list: task_list, default_task_priority: task_priority, default_task_schedule_to_close_timeout: duration_in_seconds_optional, default_task_schedule_to_start_timeout: duration_in_seconds_optional, default_task_start_to_close_timeout: duration_in_seconds_optional]

list_workflow_types_input :: [domain: domain_name, maximum_page_size: page_size, name: name, next_page_token: page_token, registration_status: registration_status, reverse_order: reverse_order]

activity_task_started_event_attributes :: [identity: identity, scheduled_event_id: event_id]

decision :: [cancel_timer_decision_attributes: cancel_timer_decision_attributes, cancel_workflow_execution_decision_attributes: cancel_workflow_execution_decision_attributes, complete_workflow_execution_decision_attributes: complete_workflow_execution_decision_attributes, continue_as_new_workflow_execution_decision_attributes: continue_as_new_workflow_execution_decision_attributes, decision_type: decision_type, fail_workflow_execution_decision_attributes: fail_workflow_execution_decision_attributes, record_marker_decision_attributes: record_marker_decision_attributes, request_cancel_activity_task_decision_attributes: request_cancel_activity_task_decision_attributes, request_cancel_external_workflow_execution_decision_attributes: request_cancel_external_workflow_execution_decision_attributes, schedule_activity_task_decision_attributes: schedule_activity_task_decision_attributes, schedule_lambda_function_decision_attributes: schedule_lambda_function_decision_attributes, signal_external_workflow_execution_decision_attributes: signal_external_workflow_execution_decision_attributes, start_child_workflow_execution_decision_attributes: start_child_workflow_execution_decision_attributes, start_timer_decision_attributes: start_timer_decision_attributes]

workflow_execution_open_counts :: [open_activity_tasks: count, open_child_workflow_executions: count, open_decision_tasks: open_decision_tasks_count, open_lambda_functions: count, open_timers: count]

poll_for_activity_task_input :: [domain: domain_name, identity: identity, task_list: task_list]

workflow_execution_started_event_attributes :: [child_policy: child_policy, continued_execution_run_id: run_id_optional, execution_start_to_close_timeout: duration_in_seconds_optional, input: data, lambda_role: arn, parent_initiated_event_id: event_id, parent_workflow_execution: workflow_execution, tag_list: tag_list, task_list: task_list, task_priority: task_priority, task_start_to_close_timeout: duration_in_seconds_optional, workflow_type: workflow_type]

description :: binary

domain_configuration :: [{:workflow_execution_retention_period_in_days, duration_in_days}]

lambda_function_completed_event_attributes :: [result: data, scheduled_event_id: event_id, started_event_id: event_id]

decision_type :: binary

version :: binary

decision_task :: [events: history_event_list, next_page_token: page_token, previous_started_event_id: event_id, started_event_id: event_id, task_token: task_token, workflow_execution: workflow_execution, workflow_type: workflow_type]

count_closed_workflow_executions_input :: [close_status_filter: close_status_filter, close_time_filter: execution_time_filter, domain: domain_name, execution_filter: workflow_execution_filter, start_time_filter: execution_time_filter, tag_filter: tag_filter, type_filter: workflow_type_filter]

page_token :: binary

decision_task_started_event_attributes :: [identity: identity, scheduled_event_id: event_id]

record_marker_decision_attributes :: [details: data, marker_name: marker_name]

domain_name :: binary

tag :: binary

terminate_workflow_execution_input :: [child_policy: child_policy, details: data, domain: domain_name, reason: terminate_reason, run_id: run_id_optional, workflow_id: workflow_id]

terminate_reason :: binary

timestamp :: integer

register_activity_type_input :: [default_task_heartbeat_timeout: duration_in_seconds_optional, default_task_list: task_list, default_task_priority: task_priority, default_task_schedule_to_close_timeout: duration_in_seconds_optional, default_task_schedule_to_start_timeout: duration_in_seconds_optional, default_task_start_to_close_timeout: duration_in_seconds_optional, description: description, domain: domain_name, name: name, version: version]

child_workflow_execution_terminated_event_attributes :: [initiated_event_id: event_id, started_event_id: event_id, workflow_execution: workflow_execution, workflow_type: workflow_type]

request_cancel_external_workflow_execution_initiated_event_attributes :: [control: data, decision_task_completed_event_id: event_id, run_id: run_id_optional, workflow_id: workflow_id]

close_status :: binary

tag_filter :: [{:tag, tag}]

identity :: binary

execution_time_filter :: [latest_date: timestamp, oldest_date: timestamp]

activity_task_failed_event_attributes :: [details: data, reason: failure_reason, scheduled_event_id: event_id, started_event_id: event_id]

workflow_execution_info :: [cancel_requested: canceled, close_status: close_status, close_timestamp: timestamp, execution: workflow_execution, execution_status: execution_status, parent: workflow_execution, start_timestamp: timestamp, tag_list: tag_list, workflow_type: workflow_type]

tag_list :: [tag]

decision_task_scheduled_event_attributes :: [start_to_close_timeout: duration_in_seconds_optional, task_list: task_list, task_priority: task_priority]

pending_task_count :: [count: count, truncated: truncated]

limited_data :: binary

workflow_execution_detail :: [execution_configuration: workflow_execution_configuration, execution_info: workflow_execution_info, latest_activity_task_timestamp: timestamp, latest_execution_context: data, open_counts: workflow_execution_open_counts]

function_input :: binary

record_marker_failed_event_attributes :: [cause: record_marker_failed_cause, decision_task_completed_event_id: event_id, marker_name: marker_name]

run :: [{:run_id, run_id}]

list_domains_input :: [maximum_page_size: page_size, next_page_token: page_token, registration_status: registration_status, reverse_order: reverse_order]

workflow_type_infos :: [next_page_token: page_token, type_infos: workflow_type_info_list]

arn :: binary

domain_detail :: [configuration: domain_configuration, domain_info: domain_info]

activity_type_infos :: [next_page_token: page_token, type_infos: activity_type_info_list]

activity_task_timed_out_event_attributes :: [details: limited_data, scheduled_event_id: event_id, started_event_id: event_id, timeout_type: activity_task_timeout_type]

start_child_workflow_execution_initiated_event_attributes :: [child_policy: child_policy, control: data, decision_task_completed_event_id: event_id, execution_start_to_close_timeout: duration_in_seconds_optional, input: data, lambda_role: arn, tag_list: tag_list, task_list: task_list, task_priority: task_priority, task_start_to_close_timeout: duration_in_seconds_optional, workflow_id: workflow_id, workflow_type: workflow_type]

cause_message :: binary

workflow_execution :: [run_id: run_id, workflow_id: workflow_id]

schedule_activity_task_failed_event_attributes :: [activity_id: activity_id, activity_type: activity_type, cause: schedule_activity_task_failed_cause, decision_task_completed_event_id: event_id]

child_workflow_execution_started_event_attributes :: [initiated_event_id: event_id, workflow_execution: workflow_execution, workflow_type: workflow_type]

history :: [events: history_event_list, next_page_token: page_token]

respond_decision_task_completed_input :: [decisions: decision_list, execution_context: data, task_token: task_token]

poll_for_decision_task_input :: [domain: domain_name, identity: identity, maximum_page_size: page_size, next_page_token: page_token, reverse_order: reverse_order, task_list: task_list]

register_domain_input :: [description: description, name: domain_name, workflow_execution_retention_period_in_days: duration_in_days]

start_child_workflow_execution_decision_attributes :: [child_policy: child_policy, control: data, execution_start_to_close_timeout: duration_in_seconds_optional, input: data, lambda_role: arn, tag_list: tag_list, task_list: task_list, task_priority: task_priority, task_start_to_close_timeout: duration_in_seconds_optional, workflow_id: workflow_id, workflow_type: workflow_type]

workflow_execution_signaled_event_attributes :: [external_initiated_event_id: event_id, external_workflow_execution: workflow_execution, input: data, signal_name: signal_name]

workflow_id :: binary

workflow_execution_filter :: [{:workflow_id, workflow_id}]

workflow_execution_continued_as_new_event_attributes :: [child_policy: child_policy, decision_task_completed_event_id: event_id, execution_start_to_close_timeout: duration_in_seconds_optional, input: data, lambda_role: arn, new_execution_run_id: run_id, tag_list: tag_list, task_list: task_list, task_priority: task_priority, task_start_to_close_timeout: duration_in_seconds_optional, workflow_type: workflow_type]

workflow_type_configuration :: [default_child_policy: child_policy, default_execution_start_to_close_timeout: duration_in_seconds_optional, default_lambda_role: arn, default_task_list: task_list, default_task_priority: task_priority, default_task_start_to_close_timeout: duration_in_seconds_optional]

domain_info :: [description: description, name: domain_name, status: registration_status]

child_policy :: binary

activity_task_canceled_event_attributes :: [details: data, latest_cancel_requested_event_id: event_id, scheduled_event_id: event_id, started_event_id: event_id]

reverse_order :: boolean

activity_task_status :: [{:cancel_requested, canceled}]

workflow_execution_count :: [count: count, truncated: truncated]

activity_task_completed_event_attributes :: [result: data, scheduled_event_id: event_id, started_event_id: event_id]

truncated :: boolean

data :: binary

start_child_workflow_execution_failed_event_attributes :: [cause: start_child_workflow_execution_failed_cause, control: data, decision_task_completed_event_id: event_id, initiated_event_id: event_id, workflow_id: workflow_id, workflow_type: workflow_type]

register_workflow_type_input :: [default_child_policy: child_policy, default_execution_start_to_close_timeout: duration_in_seconds_optional, default_lambda_role: arn, default_task_list: task_list, default_task_priority: task_priority, default_task_start_to_close_timeout: duration_in_seconds_optional, description: description, domain: domain_name, name: name, version: version]

run_id :: binary

event_type :: binary

get_workflow_execution_history_input :: [domain: domain_name, execution: workflow_execution, maximum_page_size: page_size, next_page_token: page_token, reverse_order: reverse_order]

activity_id :: binary

signal_name :: binary

history_event :: [event_type: event_type, activity_task_canceled_event_attributes: activity_task_canceled_event_attributes, activity_task_completed_event_attributes: activity_task_completed_event_attributes, activity_task_failed_event_attributes: activity_task_failed_event_attributes, lambda_function_started_event_attributes: lambda_function_started_event_attributes, external_workflow_execution_cancel_requested_event_attributes: external_workflow_execution_cancel_requested_event_attributes, continue_as_new_workflow_execution_failed_event_attributes: continue_as_new_workflow_execution_failed_event_attributes, start_child_workflow_execution_initiated_event_attributes: start_child_workflow_execution_initiated_event_attributes, lambda_function_timed_out_event_attributes: lambda_function_timed_out_event_attributes, child_workflow_execution_canceled_event_attributes: child_workflow_execution_canceled_event_attributes, workflow_execution_continued_as_new_event_attributes: workflow_execution_continued_as_new_event_attributes, workflow_execution_started_event_attributes: workflow_execution_started_event_attributes, signal_external_workflow_execution_failed_event_attributes: signal_external_workflow_execution_failed_event_attributes, workflow_execution_signaled_event_attributes: workflow_execution_signaled_event_attributes, activity_task_started_event_attributes: activity_task_started_event_attributes, fail_workflow_execution_failed_event_attributes: fail_workflow_execution_failed_event_attributes, cancel_timer_failed_event_attributes: cancel_timer_failed_event_attributes, activity_task_timed_out_event_attributes: activity_task_timed_out_event_attributes, lambda_function_failed_event_attributes: lambda_function_failed_event_attributes, workflow_execution_timed_out_event_attributes: workflow_execution_timed_out_event_attributes, start_child_workflow_execution_failed_event_attributes: start_child_workflow_execution_failed_event_attributes, event_timestamp: timestamp, record_marker_failed_event_attributes: record_marker_failed_event_attributes, child_workflow_execution_started_event_attributes: child_workflow_execution_started_event_attributes, child_workflow_execution_completed_event_attributes: child_workflow_execution_completed_event_attributes, child_workflow_execution_failed_event_attributes: child_workflow_execution_failed_event_attributes, schedule_lambda_function_failed_event_attributes: schedule_lambda_function_failed_event_attributes, decision_task_scheduled_event_attributes: decision_task_scheduled_event_attributes, event_id: event_id, marker_recorded_event_attributes: marker_recorded_event_attributes, cancel_workflow_execution_failed_event_attributes: cancel_workflow_execution_failed_event_attributes, activity_task_cancel_requested_event_attributes: activity_task_cancel_requested_event_attributes, decision_task_timed_out_event_attributes: decision_task_timed_out_event_attributes, lambda_function_completed_event_attributes: lambda_function_completed_event_attributes, request_cancel_external_workflow_execution_failed_event_attributes: request_cancel_external_workflow_execution_failed_event_attributes, complete_workflow_execution_failed_event_attributes: complete_workflow_execution_failed_event_attributes, workflow_execution_failed_event_attributes: workflow_execution_failed_event_attributes, child_workflow_execution_timed_out_event_attributes: child_workflow_execution_timed_out_event_attributes, decision_task_started_event_attributes: decision_task_started_event_attributes, schedule_activity_task_failed_event_attributes: schedule_activity_task_failed_event_attributes, decision_task_completed_event_attributes: decision_task_completed_event_attributes, signal_external_workflow_execution_initiated_event_attributes: signal_external_workflow_execution_initiated_event_attributes, child_workflow_execution_terminated_event_attributes: child_workflow_execution_terminated_event_attributes, start_timer_failed_event_attributes: start_timer_failed_event_attributes, start_lambda_function_failed_event_attributes: start_lambda_function_failed_event_attributes, workflow_execution_terminated_event_attributes: workflow_execution_terminated_event_attributes, workflow_execution_canceled_event_attributes: workflow_execution_canceled_event_attributes, workflow_execution_cancel_requested_event_attributes: workflow_execution_cancel_requested_event_attributes, external_workflow_execution_signaled_event_attributes: external_workflow_execution_signaled_event_attributes, timer_canceled_event_attributes: timer_canceled_event_attributes, lambda_function_scheduled_event_attributes: lambda_function_scheduled_event_attributes, request_cancel_external_workflow_execution_initiated_event_attributes: request_cancel_external_workflow_execution_initiated_event_attributes, timer_started_event_attributes: timer_started_event_attributes, timer_fired_event_attributes: timer_fired_event_attributes, workflow_execution_completed_event_attributes: workflow_execution_completed_event_attributes, request_cancel_activity_task_failed_event_attributes: request_cancel_activity_task_failed_event_attributes, activity_task_scheduled_event_attributes: activity_task_scheduled_event_attributes]

marker_recorded_event_attributes :: [decision_task_completed_event_id: event_id, details: data, marker_name: marker_name]

lambda_function_failed_event_attributes :: [details: data, reason: failure_reason, scheduled_event_id: event_id, started_event_id: event_id]

workflow_execution_canceled_event_attributes :: [decision_task_completed_event_id: event_id, details: data]

run_id_optional :: binary

activity_task_cancel_requested_event_attributes :: [activity_id: activity_id, decision_task_completed_event_id: event_id]

workflow_execution_infos :: [execution_infos: workflow_execution_info_list, next_page_token: page_token]

list_closed_workflow_executions_input :: [close_status_filter: close_status_filter, close_time_filter: execution_time_filter, domain: domain_name, execution_filter: workflow_execution_filter, maximum_page_size: page_size, next_page_token: page_token, reverse_order: reverse_order, start_time_filter: execution_time_filter, tag_filter: tag_filter, type_filter: workflow_type_filter]

signal_workflow_execution_input :: [domain: domain_name, input: data, run_id: run_id_optional, signal_name: signal_name, workflow_id: workflow_id]

workflow_type :: [name: name, version: version]

schedule_activity_task_decision_attributes :: [activity_id: activity_id, activity_type: activity_type, control: data, heartbeat_timeout: duration_in_seconds_optional, input: data, schedule_to_close_timeout: duration_in_seconds_optional, schedule_to_start_timeout: duration_in_seconds_optional, start_to_close_timeout: duration_in_seconds_optional, task_list: task_list, task_priority: task_priority]

count_open_workflow_executions_input :: [domain: domain_name, execution_filter: workflow_execution_filter, start_time_filter: execution_time_filter, tag_filter: tag_filter, type_filter: workflow_type_filter]

child_workflow_execution_failed_event_attributes :: [details: data, initiated_event_id: event_id, reason: failure_reason, started_event_id: event_id, workflow_execution: workflow_execution, workflow_type: workflow_type]

activity_task :: [activity_id: activity_id, activity_type: activity_type, input: data, started_event_id: event_id, task_token: task_token, workflow_execution: workflow_execution]

continue_as_new_workflow_execution_decision_attributes :: [child_policy: child_policy, execution_start_to_close_timeout: duration_in_seconds_optional, input: data, lambda_role: arn, tag_list: tag_list, task_list: task_list, task_priority: task_priority, task_start_to_close_timeout: duration_in_seconds_optional, workflow_type_version: version]

child_workflow_execution_timed_out_event_attributes :: [initiated_event_id: event_id, started_event_id: event_id, timeout_type: workflow_execution_timeout_type, workflow_execution: workflow_execution, workflow_type: workflow_type]

timer_canceled_event_attributes :: [decision_task_completed_event_id: event_id, started_event_id: event_id, timer_id: timer_id]

decision_task_timed_out_event_attributes :: [scheduled_event_id: event_id, started_event_id: event_id, timeout_type: decision_task_timeout_type]

lambda_function_timed_out_event_attributes :: [scheduled_event_id: event_id, started_event_id: event_id, timeout_type: lambda_function_timeout_type]

Functions

count_closed_workflow_executions(client, input)

Specs:

CountClosedWorkflowExecutions

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

Note:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

  • typeFilter.name: String constraint. The key is swf:typeFilter.name.

  • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
count_closed_workflow_executions!(client, input)

Specs:

Same as count_closed_workflow_executions/2 but raise on error.

Source
count_open_workflow_executions(client, input)

Specs:

CountOpenWorkflowExecutions

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

Note:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

  • typeFilter.name: String constraint. The key is swf:typeFilter.name.

  • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
count_open_workflow_executions!(client, input)

Specs:

Same as count_open_workflow_executions/2 but raise on error.

Source
count_pending_activity_tasks(client, input)

Specs:

CountPendingActivityTasks

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
count_pending_activity_tasks!(client, input)

Specs:

Same as count_pending_activity_tasks/2 but raise on error.

Source
count_pending_decision_tasks(client, input)

Specs:

CountPendingDecisionTasks

Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
count_pending_decision_tasks!(client, input)

Specs:

Same as count_pending_decision_tasks/2 but raise on error.

Source
deprecate_activity_type(client, input)

Specs:

DeprecateActivityType

Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.

Note:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • activityType.name: String constraint. The key is swf:activityType.name.

  • activityType.version: String constraint. The key is swf:activityType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
deprecate_activity_type!(client, input)

Specs:

Same as deprecate_activity_type/2 but raise on error.

Source
deprecate_domain(client, input)

Specs:

DeprecateDomain

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.

Note:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
deprecate_domain!(client, input)

Specs:

  • deprecate_domain!(client :: ExAws.SWF.t, input :: deprecate_domain_input) :: ExAws.Request.JSON.success_t | no_return

Same as deprecate_domain/2 but raise on error.

Source
deprecate_workflow_type(client, input)

Specs:

DeprecateWorkflowType

Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.

Note:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • workflowType.name: String constraint. The key is swf:workflowType.name.

  • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
deprecate_workflow_type!(client, input)

Specs:

Same as deprecate_workflow_type/2 but raise on error.

Source
describe_activity_type(client, input)

Specs:

DescribeActivityType

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • activityType.name: String constraint. The key is swf:activityType.name.

  • activityType.version: String constraint. The key is swf:activityType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
describe_activity_type!(client, input)

Specs:

Same as describe_activity_type/2 but raise on error.

Source
describe_domain(client, input)

Specs:

  • describe_domain(client :: ExAws.SWF.t, input :: describe_domain_input) :: ExAws.Request.JSON.response_t

DescribeDomain

Returns information about the specified domain, including description and status.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
describe_domain!(client, input)

Specs:

  • describe_domain!(client :: ExAws.SWF.t, input :: describe_domain_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_domain/2 but raise on error.

Source
describe_workflow_execution(client, input)

Specs:

DescribeWorkflowExecution

Returns information about the specified workflow execution including its type and some statistics.

Note:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
describe_workflow_execution!(client, input)

Specs:

Same as describe_workflow_execution/2 but raise on error.

Source
describe_workflow_type(client, input)

Specs:

DescribeWorkflowType

Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • workflowType.name: String constraint. The key is swf:workflowType.name.

  • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
describe_workflow_type!(client, input)

Specs:

Same as describe_workflow_type/2 but raise on error.

Source
get_workflow_execution_history(client, input)

Specs:

GetWorkflowExecutionHistory

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Note:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
get_workflow_execution_history!(client, input)

Specs:

Same as get_workflow_execution_history/2 but raise on error.

Source
list_activity_types(client, input)

Specs:

ListActivityTypes

Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
list_activity_types!(client, input)

Specs:

  • list_activity_types!(client :: ExAws.SWF.t, input :: list_activity_types_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_activity_types/2 but raise on error.

Source
list_closed_workflow_executions(client, input)

Specs:

ListClosedWorkflowExecutions

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Note:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

  • typeFilter.name: String constraint. The key is swf:typeFilter.name.

  • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
list_closed_workflow_executions!(client, input)

Specs:

Same as list_closed_workflow_executions/2 but raise on error.

Source
list_domains(client, input)

Specs:

  • list_domains(client :: ExAws.SWF.t, input :: list_domains_input) :: ExAws.Request.JSON.response_t

ListDomains

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Note: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
list_domains!(client, input)

Specs:

  • list_domains!(client :: ExAws.SWF.t, input :: list_domains_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_domains/2 but raise on error.

Source
list_open_workflow_executions(client, input)

Specs:

ListOpenWorkflowExecutions

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Note: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

  • typeFilter.name: String constraint. The key is swf:typeFilter.name.

  • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
list_open_workflow_executions!(client, input)

Specs:

Same as list_open_workflow_executions/2 but raise on error.

Source
list_workflow_types(client, input)

Specs:

ListWorkflowTypes

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
list_workflow_types!(client, input)

Specs:

  • list_workflow_types!(client :: ExAws.SWF.t, input :: list_workflow_types_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_workflow_types/2 but raise on error.

Source
poll_for_activity_task(client, input)

Specs:

PollForActivityTask

Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request). Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
poll_for_activity_task!(client, input)

Specs:

Same as poll_for_activity_task/2 but raise on error.

Source
poll_for_decision_task(client, input)

Specs:

PollForDecisionTask

Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout). Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
poll_for_decision_task!(client, input)

Specs:

Same as poll_for_decision_task/2 but raise on error.

Source
record_activity_task_heartbeat(client, input)

Specs:

RecordActivityTaskHeartbeat

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

Note:The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. Note:This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
record_activity_task_heartbeat!(client, input)

Specs:

Same as record_activity_task_heartbeat/2 but raise on error.

Source
register_activity_type(client, input)

Specs:

RegisterActivityType

Registers a new activity type along with its configuration settings in the specified domain.

A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

  • name: String constraint. The key is swf:name.

  • version: String constraint. The key is swf:version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
register_activity_type!(client, input)

Specs:

Same as register_activity_type/2 but raise on error.

Source
register_domain(client, input)

Specs:

  • register_domain(client :: ExAws.SWF.t, input :: register_domain_input) :: ExAws.Request.JSON.response_t

RegisterDomain

Registers a new domain.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
register_domain!(client, input)

Specs:

  • register_domain!(client :: ExAws.SWF.t, input :: register_domain_input) :: ExAws.Request.JSON.success_t | no_return

Same as register_domain/2 but raise on error.

Source
register_workflow_type(client, input)

Specs:

RegisterWorkflowType

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

  • name: String constraint. The key is swf:name.

  • version: String constraint. The key is swf:version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
register_workflow_type!(client, input)

Specs:

Same as register_workflow_type/2 but raise on error.

Source
request_cancel_workflow_execution(client, input)

Specs:

RequestCancelWorkflowExecution

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

Note:If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Note:Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
request_cancel_workflow_execution!(client, input)

Specs:

Same as request_cancel_workflow_execution/2 but raise on error.

Source
respond_activity_task_canceled(client, input)

Specs:

RespondActivityTaskCanceled

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
respond_activity_task_canceled!(client, input)

Specs:

Same as respond_activity_task_canceled/2 but raise on error.

Source
respond_activity_task_completed(client, input)

Specs:

RespondActivityTaskCompleted

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

If the requested task does not complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled. A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
respond_activity_task_completed!(client, input)

Specs:

Same as respond_activity_task_completed/2 but raise on error.

Source
respond_activity_task_failed(client, input)

Specs:

RespondActivityTaskFailed

Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
respond_activity_task_failed!(client, input)

Specs:

Same as respond_activity_task_failed/2 but raise on error.

Source
respond_decision_task_completed(client, input)

Specs:

RespondDecisionTaskCompleted

Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
respond_decision_task_completed!(client, input)

Specs:

Same as respond_decision_task_completed/2 but raise on error.

Source
signal_workflow_execution(client, input)

Specs:

SignalWorkflowExecution

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

Note: If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. Note: If the specified workflow execution is not open, this method fails with UnknownResource. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
signal_workflow_execution!(client, input)

Specs:

Same as signal_workflow_execution/2 but raise on error.

Source
start_workflow_execution(client, input)

Specs:

StartWorkflowExecution

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

This action returns the newly started workflow execution.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

  • tagList.member.0: The key is swf:tagList.member.0.

  • tagList.member.1: The key is swf:tagList.member.1.

  • tagList.member.2: The key is swf:tagList.member.2.

  • tagList.member.3: The key is swf:tagList.member.3.

  • tagList.member.4: The key is swf:tagList.member.4.

  • taskList: String constraint. The key is swf:taskList.name.

  • workflowType.name: String constraint. The key is swf:workflowType.name.

  • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
start_workflow_execution!(client, input)

Specs:

Same as start_workflow_execution/2 but raise on error.

Source
terminate_workflow_execution(client, input)

Specs:

TerminateWorkflowExecution

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

If the identified workflow execution was in progress, it is terminated immediately. Note: If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. Note: You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not. Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Source
terminate_workflow_execution!(client, input)

Specs:

Same as terminate_workflow_execution/2 but raise on error.

Source