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

Class: Aws::SWF::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Simple Workflow Service. To construct a client, you need to configure a :region and :credentials.

swf = Aws::SWF::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::SWF::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::SWF::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#count_closed_workflow_executions(options = {}) ⇒ Types::WorkflowExecutionCount

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

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.count_closed_workflow_executions({
  domain: "DomainName", # required
  start_time_filter: {
    oldest_date: Time.now, # required
    latest_date: Time.now,
  },
  close_time_filter: {
    oldest_date: Time.now, # required
    latest_date: Time.now,
  },
  execution_filter: {
    workflow_id: "WorkflowId", # required
  },
  type_filter: {
    name: "Name", # required
    version: "VersionOptional",
  },
  tag_filter: {
    tag: "Tag", # required
  },
  close_status_filter: {
    status: "COMPLETED", # required, accepts COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
  },
})

Response structure


resp.count #=> Integer
resp.truncated #=> true/false

Options Hash (options):

  • :domain (required, String)

    The name of the domain containing the workflow executions to count.

  • :start_time_filter (Types::ExecutionTimeFilter)

    If specified, only workflow executions that meet the start time criteria of the filter are counted.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

  • :close_time_filter (Types::ExecutionTimeFilter)

    If specified, only workflow executions that meet the close time criteria of the filter are counted.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

  • :execution_filter (Types::WorkflowExecutionFilter)

    If specified, only workflow executions matching the WorkflowId in the filter are counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :type_filter (Types::WorkflowTypeFilter)

    If specified, indicates the type of the workflow executions to be counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :tag_filter (Types::TagFilter)

    If specified, only executions that have a tag that matches the filter are counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :close_status_filter (Types::CloseStatusFilter)

    If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

#count_open_workflow_executions(options = {}) ⇒ Types::WorkflowExecutionCount

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

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.count_open_workflow_executions({
  domain: "DomainName", # required
  start_time_filter: { # required
    oldest_date: Time.now, # required
    latest_date: Time.now,
  },
  type_filter: {
    name: "Name", # required
    version: "VersionOptional",
  },
  tag_filter: {
    tag: "Tag", # required
  },
  execution_filter: {
    workflow_id: "WorkflowId", # required
  },
})

Response structure


resp.count #=> Integer
resp.truncated #=> true/false

Options Hash (options):

  • :domain (required, String)

    The name of the domain containing the workflow executions to count.

  • :start_time_filter (required, Types::ExecutionTimeFilter)

    Specifies the start time criteria that workflow executions must meet in order to be counted.

  • :type_filter (Types::WorkflowTypeFilter)

    Specifies the type of the workflow executions to be counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :tag_filter (Types::TagFilter)

    If specified, only executions that have a tag that matches the filter are counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :execution_filter (Types::WorkflowExecutionFilter)

    If specified, only workflow executions matching the WorkflowId in the filter are counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

#count_pending_activity_tasks(options = {}) ⇒ Types::PendingTaskCount

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is 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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.count_pending_activity_tasks({
  domain: "DomainName", # required
  task_list: { # required
    name: "Name", # required
  },
})

Response structure


resp.count #=> Integer
resp.truncated #=> true/false

Options Hash (options):

  • :domain (required, String)

    The name of the domain that contains the task list.

  • :task_list (required, Types::TaskList)

    The name of the task list.

Returns:

#count_pending_decision_tasks(options = {}) ⇒ Types::PendingTaskCount

Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is 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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.count_pending_decision_tasks({
  domain: "DomainName", # required
  task_list: { # required
    name: "Name", # required
  },
})

Response structure


resp.count #=> Integer
resp.truncated #=> true/false

Options Hash (options):

  • :domain (required, String)

    The name of the domain that contains the task list.

  • :task_list (required, Types::TaskList)

    The name of the task list.

Returns:

#deprecate_activity_type(options = {}) ⇒ Struct

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 continue to run.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.deprecate_activity_type({
  domain: "DomainName", # required
  activity_type: { # required
    name: "Name", # required
    version: "Version", # required
  },
})

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which the activity type is registered.

  • :activity_type (required, Types::ActivityType)

    The activity type to deprecate.

Returns:

  • (Struct)

    Returns an empty response.

#deprecate_domain(options = {}) ⇒ Struct

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 continues to run.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.deprecate_domain({
  name: "DomainName", # required
})

Options Hash (options):

  • :name (required, String)

    The name of the domain to deprecate.

Returns:

  • (Struct)

    Returns an empty response.

#deprecate_workflow_type(options = {}) ⇒ Struct

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 continues to run. A deprecated workflow type may still be used when calling visibility actions.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.deprecate_workflow_type({
  domain: "DomainName", # required
  workflow_type: { # required
    name: "Name", # required
    version: "Version", # required
  },
})

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which the workflow type is registered.

  • :workflow_type (required, Types::WorkflowType)

    The workflow type to deprecate.

Returns:

  • (Struct)

    Returns an empty response.

#describe_activity_type(options = {}) ⇒ Types::ActivityTypeDetail

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_activity_type({
  domain: "DomainName", # required
  activity_type: { # required
    name: "Name", # required
    version: "Version", # required
  },
})

Response structure


resp.type_info.activity_type.name #=> String
resp.type_info.activity_type.version #=> String
resp.type_info.status #=> String, one of "REGISTERED", "DEPRECATED"
resp.type_info.description #=> String
resp.type_info.creation_date #=> Time
resp.type_info.deprecation_date #=> Time
resp.configuration.default_task_start_to_close_timeout #=> String
resp.configuration.default_task_heartbeat_timeout #=> String
resp.configuration.default_task_list.name #=> String
resp.configuration.default_task_priority #=> String
resp.configuration.default_task_schedule_to_start_timeout #=> String
resp.configuration.default_task_schedule_to_close_timeout #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which the activity type is registered.

  • :activity_type (required, Types::ActivityType)

    The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

Returns:

#describe_domain(options = {}) ⇒ Types::DomainDetail

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_domain({
  name: "DomainName", # required
})

Response structure


resp.domain_info.name #=> String
resp.domain_info.status #=> String, one of "REGISTERED", "DEPRECATED"
resp.domain_info.description #=> String
resp.configuration.workflow_execution_retention_period_in_days #=> String

Options Hash (options):

  • :name (required, String)

    The name of the domain to describe.

Returns:

#describe_workflow_execution(options = {}) ⇒ Types::WorkflowExecutionDetail

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

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_workflow_execution({
  domain: "DomainName", # required
  execution: { # required
    workflow_id: "WorkflowId", # required
    run_id: "WorkflowRunId", # required
  },
})

Response structure


resp.execution_info.execution.workflow_id #=> String
resp.execution_info.execution.run_id #=> String
resp.execution_info.workflow_type.name #=> String
resp.execution_info.workflow_type.version #=> String
resp.execution_info.start_timestamp #=> Time
resp.execution_info.close_timestamp #=> Time
resp.execution_info.execution_status #=> String, one of "OPEN", "CLOSED"
resp.execution_info.close_status #=> String, one of "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT"
resp.execution_info.parent.workflow_id #=> String
resp.execution_info.parent.run_id #=> String
resp.execution_info.tag_list #=> Array
resp.execution_info.tag_list[0] #=> String
resp.execution_info.cancel_requested #=> true/false
resp.execution_configuration.task_start_to_close_timeout #=> String
resp.execution_configuration.execution_start_to_close_timeout #=> String
resp.execution_configuration.task_list.name #=> String
resp.execution_configuration.task_priority #=> String
resp.execution_configuration.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.execution_configuration.lambda_role #=> String
resp.open_counts.open_activity_tasks #=> Integer
resp.open_counts.open_decision_tasks #=> Integer
resp.open_counts.open_timers #=> Integer
resp.open_counts.open_child_workflow_executions #=> Integer
resp.open_counts.open_lambda_functions #=> Integer
resp.latest_activity_task_timestamp #=> Time
resp.latest_execution_context #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain containing the workflow execution.

  • :execution (required, Types::WorkflowExecution)

    The workflow execution to describe.

Returns:

#describe_workflow_type(options = {}) ⇒ Types::WorkflowTypeDetail

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, etc.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_workflow_type({
  domain: "DomainName", # required
  workflow_type: { # required
    name: "Name", # required
    version: "Version", # required
  },
})

Response structure


resp.type_info.workflow_type.name #=> String
resp.type_info.workflow_type.version #=> String
resp.type_info.status #=> String, one of "REGISTERED", "DEPRECATED"
resp.type_info.description #=> String
resp.type_info.creation_date #=> Time
resp.type_info.deprecation_date #=> Time
resp.configuration.default_task_start_to_close_timeout #=> String
resp.configuration.default_execution_start_to_close_timeout #=> String
resp.configuration.default_task_list.name #=> String
resp.configuration.default_task_priority #=> String
resp.configuration.default_child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.configuration.default_lambda_role #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which this workflow type is registered.

  • :workflow_type (required, Types::WorkflowType)

    The workflow type to describe.

Returns:

#get_workflow_execution_history(options = {}) ⇒ Types::History

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.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.get_workflow_execution_history({
  domain: "DomainName", # required
  execution: { # required
    workflow_id: "WorkflowId", # required
    run_id: "WorkflowRunId", # required
  },
  next_page_token: "PageToken",
  maximum_page_size: 1,
  reverse_order: false,
})

Response structure


resp.events #=> Array
resp.events[0].event_timestamp #=> Time
resp.events[0].event_type #=> String, one of "WorkflowExecutionStarted", "WorkflowExecutionCancelRequested", "WorkflowExecutionCompleted", "CompleteWorkflowExecutionFailed", "WorkflowExecutionFailed", "FailWorkflowExecutionFailed", "WorkflowExecutionTimedOut", "WorkflowExecutionCanceled", "CancelWorkflowExecutionFailed", "WorkflowExecutionContinuedAsNew", "ContinueAsNewWorkflowExecutionFailed", "WorkflowExecutionTerminated", "DecisionTaskScheduled", "DecisionTaskStarted", "DecisionTaskCompleted", "DecisionTaskTimedOut", "ActivityTaskScheduled", "ScheduleActivityTaskFailed", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "ActivityTaskTimedOut", "ActivityTaskCanceled", "ActivityTaskCancelRequested", "RequestCancelActivityTaskFailed", "WorkflowExecutionSignaled", "MarkerRecorded", "RecordMarkerFailed", "TimerStarted", "StartTimerFailed", "TimerFired", "TimerCanceled", "CancelTimerFailed", "StartChildWorkflowExecutionInitiated", "StartChildWorkflowExecutionFailed", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed", "ChildWorkflowExecutionTimedOut", "ChildWorkflowExecutionCanceled", "ChildWorkflowExecutionTerminated", "SignalExternalWorkflowExecutionInitiated", "SignalExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionSignaled", "RequestCancelExternalWorkflowExecutionInitiated", "RequestCancelExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionCancelRequested", "LambdaFunctionScheduled", "LambdaFunctionStarted", "LambdaFunctionCompleted", "LambdaFunctionFailed", "LambdaFunctionTimedOut", "ScheduleLambdaFunctionFailed", "StartLambdaFunctionFailed"
resp.events[0].event_id #=> Integer
resp.events[0].workflow_execution_started_event_attributes.input #=> String
resp.events[0].workflow_execution_started_event_attributes.execution_start_to_close_timeout #=> String
resp.events[0].workflow_execution_started_event_attributes.task_start_to_close_timeout #=> String
resp.events[0].workflow_execution_started_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].workflow_execution_started_event_attributes.task_list.name #=> String
resp.events[0].workflow_execution_started_event_attributes.task_priority #=> String
resp.events[0].workflow_execution_started_event_attributes.workflow_type.name #=> String
resp.events[0].workflow_execution_started_event_attributes.workflow_type.version #=> String
resp.events[0].workflow_execution_started_event_attributes.tag_list #=> Array
resp.events[0].workflow_execution_started_event_attributes.tag_list[0] #=> String
resp.events[0].workflow_execution_started_event_attributes.continued_execution_run_id #=> String
resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.workflow_id #=> String
resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.run_id #=> String
resp.events[0].workflow_execution_started_event_attributes.parent_initiated_event_id #=> Integer
resp.events[0].workflow_execution_started_event_attributes.lambda_role #=> String
resp.events[0].workflow_execution_completed_event_attributes.result #=> String
resp.events[0].workflow_execution_completed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].complete_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
resp.events[0].complete_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_failed_event_attributes.reason #=> String
resp.events[0].workflow_execution_failed_event_attributes.details #=> String
resp.events[0].workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].fail_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
resp.events[0].fail_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
resp.events[0].workflow_execution_timed_out_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].workflow_execution_canceled_event_attributes.details #=> String
resp.events[0].workflow_execution_canceled_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].cancel_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
resp.events[0].cancel_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_continued_as_new_event_attributes.input #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_continued_as_new_event_attributes.new_execution_run_id #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.execution_start_to_close_timeout #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.task_list.name #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.task_priority #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.task_start_to_close_timeout #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].workflow_execution_continued_as_new_event_attributes.tag_list #=> Array
resp.events[0].workflow_execution_continued_as_new_event_attributes.tag_list[0] #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.workflow_type.name #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.workflow_type.version #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.lambda_role #=> String
resp.events[0].continue_as_new_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "WORKFLOW_TYPE_DEPRECATED", "WORKFLOW_TYPE_DOES_NOT_EXIST", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
resp.events[0].continue_as_new_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_terminated_event_attributes.reason #=> String
resp.events[0].workflow_execution_terminated_event_attributes.details #=> String
resp.events[0].workflow_execution_terminated_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].workflow_execution_terminated_event_attributes.cause #=> String, one of "CHILD_POLICY_APPLIED", "EVENT_LIMIT_EXCEEDED", "OPERATOR_INITIATED"
resp.events[0].workflow_execution_cancel_requested_event_attributes.external_workflow_execution.workflow_id #=> String
resp.events[0].workflow_execution_cancel_requested_event_attributes.external_workflow_execution.run_id #=> String
resp.events[0].workflow_execution_cancel_requested_event_attributes.external_initiated_event_id #=> Integer
resp.events[0].workflow_execution_cancel_requested_event_attributes.cause #=> String, one of "CHILD_POLICY_APPLIED"
resp.events[0].decision_task_scheduled_event_attributes.task_list.name #=> String
resp.events[0].decision_task_scheduled_event_attributes.task_priority #=> String
resp.events[0].decision_task_scheduled_event_attributes.start_to_close_timeout #=> String
resp.events[0].decision_task_started_event_attributes.identity #=> String
resp.events[0].decision_task_started_event_attributes.scheduled_event_id #=> Integer
resp.events[0].decision_task_completed_event_attributes.execution_context #=> String
resp.events[0].decision_task_completed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].decision_task_completed_event_attributes.started_event_id #=> Integer
resp.events[0].decision_task_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
resp.events[0].decision_task_timed_out_event_attributes.scheduled_event_id #=> Integer
resp.events[0].decision_task_timed_out_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_scheduled_event_attributes.activity_type.name #=> String
resp.events[0].activity_task_scheduled_event_attributes.activity_type.version #=> String
resp.events[0].activity_task_scheduled_event_attributes.activity_id #=> String
resp.events[0].activity_task_scheduled_event_attributes.input #=> String
resp.events[0].activity_task_scheduled_event_attributes.control #=> String
resp.events[0].activity_task_scheduled_event_attributes.schedule_to_start_timeout #=> String
resp.events[0].activity_task_scheduled_event_attributes.schedule_to_close_timeout #=> String
resp.events[0].activity_task_scheduled_event_attributes.start_to_close_timeout #=> String
resp.events[0].activity_task_scheduled_event_attributes.task_list.name #=> String
resp.events[0].activity_task_scheduled_event_attributes.task_priority #=> String
resp.events[0].activity_task_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].activity_task_scheduled_event_attributes.heartbeat_timeout #=> String
resp.events[0].activity_task_started_event_attributes.identity #=> String
resp.events[0].activity_task_started_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_completed_event_attributes.result #=> String
resp.events[0].activity_task_completed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_completed_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_failed_event_attributes.reason #=> String
resp.events[0].activity_task_failed_event_attributes.details #=> String
resp.events[0].activity_task_failed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_failed_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE", "SCHEDULE_TO_START", "SCHEDULE_TO_CLOSE", "HEARTBEAT"
resp.events[0].activity_task_timed_out_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_timed_out_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_timed_out_event_attributes.details #=> String
resp.events[0].activity_task_canceled_event_attributes.details #=> String
resp.events[0].activity_task_canceled_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_canceled_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_canceled_event_attributes.latest_cancel_requested_event_id #=> Integer
resp.events[0].activity_task_cancel_requested_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].activity_task_cancel_requested_event_attributes.activity_id #=> String
resp.events[0].workflow_execution_signaled_event_attributes.signal_name #=> String
resp.events[0].workflow_execution_signaled_event_attributes.input #=> String
resp.events[0].workflow_execution_signaled_event_attributes.external_workflow_execution.workflow_id #=> String
resp.events[0].workflow_execution_signaled_event_attributes.external_workflow_execution.run_id #=> String
resp.events[0].workflow_execution_signaled_event_attributes.external_initiated_event_id #=> Integer
resp.events[0].marker_recorded_event_attributes.marker_name #=> String
resp.events[0].marker_recorded_event_attributes.details #=> String
resp.events[0].marker_recorded_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].record_marker_failed_event_attributes.marker_name #=> String
resp.events[0].record_marker_failed_event_attributes.cause #=> String, one of "OPERATION_NOT_PERMITTED"
resp.events[0].record_marker_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].timer_started_event_attributes.timer_id #=> String
resp.events[0].timer_started_event_attributes.control #=> String
resp.events[0].timer_started_event_attributes.start_to_fire_timeout #=> String
resp.events[0].timer_started_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].timer_fired_event_attributes.timer_id #=> String
resp.events[0].timer_fired_event_attributes.started_event_id #=> Integer
resp.events[0].timer_canceled_event_attributes.timer_id #=> String
resp.events[0].timer_canceled_event_attributes.started_event_id #=> Integer
resp.events[0].timer_canceled_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_id #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_type.name #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_type.version #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.control #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.input #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.execution_start_to_close_timeout #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_list.name #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_priority #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_child_workflow_execution_initiated_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_start_to_close_timeout #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.tag_list #=> Array
resp.events[0].start_child_workflow_execution_initiated_event_attributes.tag_list[0] #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.lambda_role #=> String
resp.events[0].child_workflow_execution_started_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_started_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_started_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_started_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_started_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_completed_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.result #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_completed_event_attributes.started_event_id #=> Integer
resp.events[0].child_workflow_execution_failed_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.reason #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.details #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_failed_event_attributes.started_event_id #=> Integer
resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
resp.events[0].child_workflow_execution_timed_out_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_timed_out_event_attributes.started_event_id #=> Integer
resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.details #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_canceled_event_attributes.started_event_id #=> Integer
resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_terminated_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_terminated_event_attributes.started_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.workflow_id #=> String
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.run_id #=> String
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.signal_name #=> String
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.input #=> String
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.control #=> String
resp.events[0].external_workflow_execution_signaled_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].external_workflow_execution_signaled_event_attributes.workflow_execution.run_id #=> String
resp.events[0].external_workflow_execution_signaled_event_attributes.initiated_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_failed_event_attributes.workflow_id #=> String
resp.events[0].signal_external_workflow_execution_failed_event_attributes.run_id #=> String
resp.events[0].signal_external_workflow_execution_failed_event_attributes.cause #=> String, one of "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
resp.events[0].signal_external_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_failed_event_attributes.control #=> String
resp.events[0].external_workflow_execution_cancel_requested_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].external_workflow_execution_cancel_requested_event_attributes.workflow_execution.run_id #=> String
resp.events[0].external_workflow_execution_cancel_requested_event_attributes.initiated_event_id #=> Integer
resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.workflow_id #=> String
resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.run_id #=> String
resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.control #=> String
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.workflow_id #=> String
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.run_id #=> String
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.cause #=> String, one of "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.control #=> String
resp.events[0].schedule_activity_task_failed_event_attributes.activity_type.name #=> String
resp.events[0].schedule_activity_task_failed_event_attributes.activity_type.version #=> String
resp.events[0].schedule_activity_task_failed_event_attributes.activity_id #=> String
resp.events[0].schedule_activity_task_failed_event_attributes.cause #=> String, one of "ACTIVITY_TYPE_DEPRECATED", "ACTIVITY_TYPE_DOES_NOT_EXIST", "ACTIVITY_ID_ALREADY_IN_USE", "OPEN_ACTIVITIES_LIMIT_EXCEEDED", "ACTIVITY_CREATION_RATE_EXCEEDED", "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", "OPERATION_NOT_PERMITTED"
resp.events[0].schedule_activity_task_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].request_cancel_activity_task_failed_event_attributes.activity_id #=> String
resp.events[0].request_cancel_activity_task_failed_event_attributes.cause #=> String, one of "ACTIVITY_ID_UNKNOWN", "OPERATION_NOT_PERMITTED"
resp.events[0].request_cancel_activity_task_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_timer_failed_event_attributes.timer_id #=> String
resp.events[0].start_timer_failed_event_attributes.cause #=> String, one of "TIMER_ID_ALREADY_IN_USE", "OPEN_TIMERS_LIMIT_EXCEEDED", "TIMER_CREATION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
resp.events[0].start_timer_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].cancel_timer_failed_event_attributes.timer_id #=> String
resp.events[0].cancel_timer_failed_event_attributes.cause #=> String, one of "TIMER_ID_UNKNOWN", "OPERATION_NOT_PERMITTED"
resp.events[0].cancel_timer_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_type.name #=> String
resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_type.version #=> String
resp.events[0].start_child_workflow_execution_failed_event_attributes.cause #=> String, one of "WORKFLOW_TYPE_DOES_NOT_EXIST", "WORKFLOW_TYPE_DEPRECATED", "OPEN_CHILDREN_LIMIT_EXCEEDED", "OPEN_WORKFLOWS_LIMIT_EXCEEDED", "CHILD_CREATION_RATE_EXCEEDED", "WORKFLOW_ALREADY_RUNNING", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "OPERATION_NOT_PERMITTED"
resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_id #=> String
resp.events[0].start_child_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
resp.events[0].start_child_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_child_workflow_execution_failed_event_attributes.control #=> String
resp.events[0].lambda_function_scheduled_event_attributes.id #=> String
resp.events[0].lambda_function_scheduled_event_attributes.name #=> String
resp.events[0].lambda_function_scheduled_event_attributes.control #=> String
resp.events[0].lambda_function_scheduled_event_attributes.input #=> String
resp.events[0].lambda_function_scheduled_event_attributes.start_to_close_timeout #=> String
resp.events[0].lambda_function_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].lambda_function_started_event_attributes.scheduled_event_id #=> Integer
resp.events[0].lambda_function_completed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].lambda_function_completed_event_attributes.started_event_id #=> Integer
resp.events[0].lambda_function_completed_event_attributes.result #=> String
resp.events[0].lambda_function_failed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].lambda_function_failed_event_attributes.started_event_id #=> Integer
resp.events[0].lambda_function_failed_event_attributes.reason #=> String
resp.events[0].lambda_function_failed_event_attributes.details #=> String
resp.events[0].lambda_function_timed_out_event_attributes.scheduled_event_id #=> Integer
resp.events[0].lambda_function_timed_out_event_attributes.started_event_id #=> Integer
resp.events[0].lambda_function_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
resp.events[0].schedule_lambda_function_failed_event_attributes.id #=> String
resp.events[0].schedule_lambda_function_failed_event_attributes.name #=> String
resp.events[0].schedule_lambda_function_failed_event_attributes.cause #=> String, one of "ID_ALREADY_IN_USE", "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED", "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED", "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"
resp.events[0].schedule_lambda_function_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_lambda_function_failed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].start_lambda_function_failed_event_attributes.cause #=> String, one of "ASSUME_ROLE_FAILED"
resp.events[0].start_lambda_function_failed_event_attributes.message #=> String
resp.next_page_token #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain containing the workflow execution.

  • :execution (required, Types::WorkflowExecution)

    Specifies the workflow execution for which to return the history.

  • :next_page_token (String)

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

  • :maximum_page_size (Integer)

    The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

  • :reverse_order (Boolean)

    When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Returns:

#list_activity_types(options = {}) ⇒ Types::ActivityTypeInfos

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.list_activity_types({
  domain: "DomainName", # required
  name: "Name",
  registration_status: "REGISTERED", # required, accepts REGISTERED, DEPRECATED
  next_page_token: "PageToken",
  maximum_page_size: 1,
  reverse_order: false,
})

Response structure


resp.type_infos #=> Array
resp.type_infos[0].activity_type.name #=> String
resp.type_infos[0].activity_type.version #=> String
resp.type_infos[0].status #=> String, one of "REGISTERED", "DEPRECATED"
resp.type_infos[0].description #=> String
resp.type_infos[0].creation_date #=> Time
resp.type_infos[0].deprecation_date #=> Time
resp.next_page_token #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which the activity types have been registered.

  • :name (String)

    If specified, only lists the activity types that have this name.

  • :registration_status (required, String)

    Specifies the registration status of the activity types to list.

  • :next_page_token (String)

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

  • :maximum_page_size (Integer)

    The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

  • :reverse_order (Boolean)

    When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.

Returns:

#list_closed_workflow_executions(options = {}) ⇒ Types::WorkflowExecutionInfos

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.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.list_closed_workflow_executions({
  domain: "DomainName", # required
  start_time_filter: {
    oldest_date: Time.now, # required
    latest_date: Time.now,
  },
  close_time_filter: {
    oldest_date: Time.now, # required
    latest_date: Time.now,
  },
  execution_filter: {
    workflow_id: "WorkflowId", # required
  },
  close_status_filter: {
    status: "COMPLETED", # required, accepts COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
  },
  type_filter: {
    name: "Name", # required
    version: "VersionOptional",
  },
  tag_filter: {
    tag: "Tag", # required
  },
  next_page_token: "PageToken",
  maximum_page_size: 1,
  reverse_order: false,
})

Response structure


resp.execution_infos #=> Array
resp.execution_infos[0].execution.workflow_id #=> String
resp.execution_infos[0].execution.run_id #=> String
resp.execution_infos[0].workflow_type.name #=> String
resp.execution_infos[0].workflow_type.version #=> String
resp.execution_infos[0].start_timestamp #=> Time
resp.execution_infos[0].close_timestamp #=> Time
resp.execution_infos[0].execution_status #=> String, one of "OPEN", "CLOSED"
resp.execution_infos[0].close_status #=> String, one of "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT"
resp.execution_infos[0].parent.workflow_id #=> String
resp.execution_infos[0].parent.run_id #=> String
resp.execution_infos[0].tag_list #=> Array
resp.execution_infos[0].tag_list[0] #=> String
resp.execution_infos[0].cancel_requested #=> true/false
resp.next_page_token #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain that contains the workflow executions to list.

  • :start_time_filter (Types::ExecutionTimeFilter)

    If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

  • :close_time_filter (Types::ExecutionTimeFilter)

    If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

  • :execution_filter (Types::WorkflowExecutionFilter)

    If specified, only workflow executions matching the workflow ID specified in the filter are returned.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :close_status_filter (Types::CloseStatusFilter)

    If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :type_filter (Types::WorkflowTypeFilter)

    If specified, only executions of the type specified in the filter are returned.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :tag_filter (Types::TagFilter)

    If specified, only executions that have the matching tag are listed.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :next_page_token (String)

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

  • :maximum_page_size (Integer)

    The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

  • :reverse_order (Boolean)

    When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

Returns:

#list_domains(options = {}) ⇒ Types::DomainInfos

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.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.list_domains({
  next_page_token: "PageToken",
  registration_status: "REGISTERED", # required, accepts REGISTERED, DEPRECATED
  maximum_page_size: 1,
  reverse_order: false,
})

Response structure


resp.domain_infos #=> Array
resp.domain_infos[0].name #=> String
resp.domain_infos[0].status #=> String, one of "REGISTERED", "DEPRECATED"
resp.domain_infos[0].description #=> String
resp.next_page_token #=> String

Options Hash (options):

  • :next_page_token (String)

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

  • :registration_status (required, String)

    Specifies the registration status of the domains to list.

  • :maximum_page_size (Integer)

    The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

  • :reverse_order (Boolean)

    When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Returns:

#list_open_workflow_executions(options = {}) ⇒ Types::WorkflowExecutionInfos

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.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.list_open_workflow_executions({
  domain: "DomainName", # required
  start_time_filter: { # required
    oldest_date: Time.now, # required
    latest_date: Time.now,
  },
  type_filter: {
    name: "Name", # required
    version: "VersionOptional",
  },
  tag_filter: {
    tag: "Tag", # required
  },
  next_page_token: "PageToken",
  maximum_page_size: 1,
  reverse_order: false,
  execution_filter: {
    workflow_id: "WorkflowId", # required
  },
})

Response structure


resp.execution_infos #=> Array
resp.execution_infos[0].execution.workflow_id #=> String
resp.execution_infos[0].execution.run_id #=> String
resp.execution_infos[0].workflow_type.name #=> String
resp.execution_infos[0].workflow_type.version #=> String
resp.execution_infos[0].start_timestamp #=> Time
resp.execution_infos[0].close_timestamp #=> Time
resp.execution_infos[0].execution_status #=> String, one of "OPEN", "CLOSED"
resp.execution_infos[0].close_status #=> String, one of "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT"
resp.execution_infos[0].parent.workflow_id #=> String
resp.execution_infos[0].parent.run_id #=> String
resp.execution_infos[0].tag_list #=> Array
resp.execution_infos[0].tag_list[0] #=> String
resp.execution_infos[0].cancel_requested #=> true/false
resp.next_page_token #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain that contains the workflow executions to list.

  • :start_time_filter (required, Types::ExecutionTimeFilter)

    Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

  • :type_filter (Types::WorkflowTypeFilter)

    If specified, only executions of the type specified in the filter are returned.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :tag_filter (Types::TagFilter)

    If specified, only executions that have the matching tag are listed.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

  • :next_page_token (String)

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

  • :maximum_page_size (Integer)

    The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

  • :reverse_order (Boolean)

    When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

  • :execution_filter (Types::WorkflowExecutionFilter)

    If specified, only workflow executions matching the workflow ID specified in the filter are returned.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

#list_workflow_types(options = {}) ⇒ Types::WorkflowTypeInfos

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.list_workflow_types({
  domain: "DomainName", # required
  name: "Name",
  registration_status: "REGISTERED", # required, accepts REGISTERED, DEPRECATED
  next_page_token: "PageToken",
  maximum_page_size: 1,
  reverse_order: false,
})

Response structure


resp.type_infos #=> Array
resp.type_infos[0].workflow_type.name #=> String
resp.type_infos[0].workflow_type.version #=> String
resp.type_infos[0].status #=> String, one of "REGISTERED", "DEPRECATED"
resp.type_infos[0].description #=> String
resp.type_infos[0].creation_date #=> Time
resp.type_infos[0].deprecation_date #=> Time
resp.next_page_token #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which the workflow types have been registered.

  • :name (String)

    If specified, lists the workflow type with this name.

  • :registration_status (required, String)

    Specifies the registration status of the workflow types to list.

  • :next_page_token (String)

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

  • :maximum_page_size (Integer)

    The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

  • :reverse_order (Boolean)

    When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

Returns:

#poll_for_activity_task(options = {}) ⇒ Types::ActivityTask

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 returns 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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.poll_for_activity_task({
  domain: "DomainName", # required
  task_list: { # required
    name: "Name", # required
  },
  identity: "Identity",
})

Response structure


resp.task_token #=> String
resp.activity_id #=> String
resp.started_event_id #=> Integer
resp.workflow_execution.workflow_id #=> String
resp.workflow_execution.run_id #=> String
resp.activity_type.name #=> String
resp.activity_type.version #=> String
resp.input #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain that contains the task lists being polled.

  • :task_list (required, Types::TaskList)

    Specifies the task list to poll for activity tasks.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :identity (String)

    Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Returns:

#poll_for_decision_task(options = {}) ⇒ Types::DecisionTask

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.poll_for_decision_task({
  domain: "DomainName", # required
  task_list: { # required
    name: "Name", # required
  },
  identity: "Identity",
  next_page_token: "PageToken",
  maximum_page_size: 1,
  reverse_order: false,
})

Response structure


resp.task_token #=> String
resp.started_event_id #=> Integer
resp.workflow_execution.workflow_id #=> String
resp.workflow_execution.run_id #=> String
resp.workflow_type.name #=> String
resp.workflow_type.version #=> String
resp.events #=> Array
resp.events[0].event_timestamp #=> Time
resp.events[0].event_type #=> String, one of "WorkflowExecutionStarted", "WorkflowExecutionCancelRequested", "WorkflowExecutionCompleted", "CompleteWorkflowExecutionFailed", "WorkflowExecutionFailed", "FailWorkflowExecutionFailed", "WorkflowExecutionTimedOut", "WorkflowExecutionCanceled", "CancelWorkflowExecutionFailed", "WorkflowExecutionContinuedAsNew", "ContinueAsNewWorkflowExecutionFailed", "WorkflowExecutionTerminated", "DecisionTaskScheduled", "DecisionTaskStarted", "DecisionTaskCompleted", "DecisionTaskTimedOut", "ActivityTaskScheduled", "ScheduleActivityTaskFailed", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "ActivityTaskTimedOut", "ActivityTaskCanceled", "ActivityTaskCancelRequested", "RequestCancelActivityTaskFailed", "WorkflowExecutionSignaled", "MarkerRecorded", "RecordMarkerFailed", "TimerStarted", "StartTimerFailed", "TimerFired", "TimerCanceled", "CancelTimerFailed", "StartChildWorkflowExecutionInitiated", "StartChildWorkflowExecutionFailed", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed", "ChildWorkflowExecutionTimedOut", "ChildWorkflowExecutionCanceled", "ChildWorkflowExecutionTerminated", "SignalExternalWorkflowExecutionInitiated", "SignalExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionSignaled", "RequestCancelExternalWorkflowExecutionInitiated", "RequestCancelExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionCancelRequested", "LambdaFunctionScheduled", "LambdaFunctionStarted", "LambdaFunctionCompleted", "LambdaFunctionFailed", "LambdaFunctionTimedOut", "ScheduleLambdaFunctionFailed", "StartLambdaFunctionFailed"
resp.events[0].event_id #=> Integer
resp.events[0].workflow_execution_started_event_attributes.input #=> String
resp.events[0].workflow_execution_started_event_attributes.execution_start_to_close_timeout #=> String
resp.events[0].workflow_execution_started_event_attributes.task_start_to_close_timeout #=> String
resp.events[0].workflow_execution_started_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].workflow_execution_started_event_attributes.task_list.name #=> String
resp.events[0].workflow_execution_started_event_attributes.task_priority #=> String
resp.events[0].workflow_execution_started_event_attributes.workflow_type.name #=> String
resp.events[0].workflow_execution_started_event_attributes.workflow_type.version #=> String
resp.events[0].workflow_execution_started_event_attributes.tag_list #=> Array
resp.events[0].workflow_execution_started_event_attributes.tag_list[0] #=> String
resp.events[0].workflow_execution_started_event_attributes.continued_execution_run_id #=> String
resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.workflow_id #=> String
resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.run_id #=> String
resp.events[0].workflow_execution_started_event_attributes.parent_initiated_event_id #=> Integer
resp.events[0].workflow_execution_started_event_attributes.lambda_role #=> String
resp.events[0].workflow_execution_completed_event_attributes.result #=> String
resp.events[0].workflow_execution_completed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].complete_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
resp.events[0].complete_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_failed_event_attributes.reason #=> String
resp.events[0].workflow_execution_failed_event_attributes.details #=> String
resp.events[0].workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].fail_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
resp.events[0].fail_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
resp.events[0].workflow_execution_timed_out_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].workflow_execution_canceled_event_attributes.details #=> String
resp.events[0].workflow_execution_canceled_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].cancel_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
resp.events[0].cancel_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_continued_as_new_event_attributes.input #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_continued_as_new_event_attributes.new_execution_run_id #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.execution_start_to_close_timeout #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.task_list.name #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.task_priority #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.task_start_to_close_timeout #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].workflow_execution_continued_as_new_event_attributes.tag_list #=> Array
resp.events[0].workflow_execution_continued_as_new_event_attributes.tag_list[0] #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.workflow_type.name #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.workflow_type.version #=> String
resp.events[0].workflow_execution_continued_as_new_event_attributes.lambda_role #=> String
resp.events[0].continue_as_new_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "WORKFLOW_TYPE_DEPRECATED", "WORKFLOW_TYPE_DOES_NOT_EXIST", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
resp.events[0].continue_as_new_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].workflow_execution_terminated_event_attributes.reason #=> String
resp.events[0].workflow_execution_terminated_event_attributes.details #=> String
resp.events[0].workflow_execution_terminated_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].workflow_execution_terminated_event_attributes.cause #=> String, one of "CHILD_POLICY_APPLIED", "EVENT_LIMIT_EXCEEDED", "OPERATOR_INITIATED"
resp.events[0].workflow_execution_cancel_requested_event_attributes.external_workflow_execution.workflow_id #=> String
resp.events[0].workflow_execution_cancel_requested_event_attributes.external_workflow_execution.run_id #=> String
resp.events[0].workflow_execution_cancel_requested_event_attributes.external_initiated_event_id #=> Integer
resp.events[0].workflow_execution_cancel_requested_event_attributes.cause #=> String, one of "CHILD_POLICY_APPLIED"
resp.events[0].decision_task_scheduled_event_attributes.task_list.name #=> String
resp.events[0].decision_task_scheduled_event_attributes.task_priority #=> String
resp.events[0].decision_task_scheduled_event_attributes.start_to_close_timeout #=> String
resp.events[0].decision_task_started_event_attributes.identity #=> String
resp.events[0].decision_task_started_event_attributes.scheduled_event_id #=> Integer
resp.events[0].decision_task_completed_event_attributes.execution_context #=> String
resp.events[0].decision_task_completed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].decision_task_completed_event_attributes.started_event_id #=> Integer
resp.events[0].decision_task_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
resp.events[0].decision_task_timed_out_event_attributes.scheduled_event_id #=> Integer
resp.events[0].decision_task_timed_out_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_scheduled_event_attributes.activity_type.name #=> String
resp.events[0].activity_task_scheduled_event_attributes.activity_type.version #=> String
resp.events[0].activity_task_scheduled_event_attributes.activity_id #=> String
resp.events[0].activity_task_scheduled_event_attributes.input #=> String
resp.events[0].activity_task_scheduled_event_attributes.control #=> String
resp.events[0].activity_task_scheduled_event_attributes.schedule_to_start_timeout #=> String
resp.events[0].activity_task_scheduled_event_attributes.schedule_to_close_timeout #=> String
resp.events[0].activity_task_scheduled_event_attributes.start_to_close_timeout #=> String
resp.events[0].activity_task_scheduled_event_attributes.task_list.name #=> String
resp.events[0].activity_task_scheduled_event_attributes.task_priority #=> String
resp.events[0].activity_task_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].activity_task_scheduled_event_attributes.heartbeat_timeout #=> String
resp.events[0].activity_task_started_event_attributes.identity #=> String
resp.events[0].activity_task_started_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_completed_event_attributes.result #=> String
resp.events[0].activity_task_completed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_completed_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_failed_event_attributes.reason #=> String
resp.events[0].activity_task_failed_event_attributes.details #=> String
resp.events[0].activity_task_failed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_failed_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE", "SCHEDULE_TO_START", "SCHEDULE_TO_CLOSE", "HEARTBEAT"
resp.events[0].activity_task_timed_out_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_timed_out_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_timed_out_event_attributes.details #=> String
resp.events[0].activity_task_canceled_event_attributes.details #=> String
resp.events[0].activity_task_canceled_event_attributes.scheduled_event_id #=> Integer
resp.events[0].activity_task_canceled_event_attributes.started_event_id #=> Integer
resp.events[0].activity_task_canceled_event_attributes.latest_cancel_requested_event_id #=> Integer
resp.events[0].activity_task_cancel_requested_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].activity_task_cancel_requested_event_attributes.activity_id #=> String
resp.events[0].workflow_execution_signaled_event_attributes.signal_name #=> String
resp.events[0].workflow_execution_signaled_event_attributes.input #=> String
resp.events[0].workflow_execution_signaled_event_attributes.external_workflow_execution.workflow_id #=> String
resp.events[0].workflow_execution_signaled_event_attributes.external_workflow_execution.run_id #=> String
resp.events[0].workflow_execution_signaled_event_attributes.external_initiated_event_id #=> Integer
resp.events[0].marker_recorded_event_attributes.marker_name #=> String
resp.events[0].marker_recorded_event_attributes.details #=> String
resp.events[0].marker_recorded_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].record_marker_failed_event_attributes.marker_name #=> String
resp.events[0].record_marker_failed_event_attributes.cause #=> String, one of "OPERATION_NOT_PERMITTED"
resp.events[0].record_marker_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].timer_started_event_attributes.timer_id #=> String
resp.events[0].timer_started_event_attributes.control #=> String
resp.events[0].timer_started_event_attributes.start_to_fire_timeout #=> String
resp.events[0].timer_started_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].timer_fired_event_attributes.timer_id #=> String
resp.events[0].timer_fired_event_attributes.started_event_id #=> Integer
resp.events[0].timer_canceled_event_attributes.timer_id #=> String
resp.events[0].timer_canceled_event_attributes.started_event_id #=> Integer
resp.events[0].timer_canceled_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_id #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_type.name #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_type.version #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.control #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.input #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.execution_start_to_close_timeout #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_list.name #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_priority #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_child_workflow_execution_initiated_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_start_to_close_timeout #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.tag_list #=> Array
resp.events[0].start_child_workflow_execution_initiated_event_attributes.tag_list[0] #=> String
resp.events[0].start_child_workflow_execution_initiated_event_attributes.lambda_role #=> String
resp.events[0].child_workflow_execution_started_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_started_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_started_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_started_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_started_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_completed_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.result #=> String
resp.events[0].child_workflow_execution_completed_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_completed_event_attributes.started_event_id #=> Integer
resp.events[0].child_workflow_execution_failed_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.reason #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.details #=> String
resp.events[0].child_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_failed_event_attributes.started_event_id #=> Integer
resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
resp.events[0].child_workflow_execution_timed_out_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_timed_out_event_attributes.started_event_id #=> Integer
resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.details #=> String
resp.events[0].child_workflow_execution_canceled_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_canceled_event_attributes.started_event_id #=> Integer
resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_execution.run_id #=> String
resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_type.name #=> String
resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_type.version #=> String
resp.events[0].child_workflow_execution_terminated_event_attributes.initiated_event_id #=> Integer
resp.events[0].child_workflow_execution_terminated_event_attributes.started_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.workflow_id #=> String
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.run_id #=> String
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.signal_name #=> String
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.input #=> String
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_initiated_event_attributes.control #=> String
resp.events[0].external_workflow_execution_signaled_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].external_workflow_execution_signaled_event_attributes.workflow_execution.run_id #=> String
resp.events[0].external_workflow_execution_signaled_event_attributes.initiated_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_failed_event_attributes.workflow_id #=> String
resp.events[0].signal_external_workflow_execution_failed_event_attributes.run_id #=> String
resp.events[0].signal_external_workflow_execution_failed_event_attributes.cause #=> String, one of "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
resp.events[0].signal_external_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].signal_external_workflow_execution_failed_event_attributes.control #=> String
resp.events[0].external_workflow_execution_cancel_requested_event_attributes.workflow_execution.workflow_id #=> String
resp.events[0].external_workflow_execution_cancel_requested_event_attributes.workflow_execution.run_id #=> String
resp.events[0].external_workflow_execution_cancel_requested_event_attributes.initiated_event_id #=> Integer
resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.workflow_id #=> String
resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.run_id #=> String
resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.control #=> String
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.workflow_id #=> String
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.run_id #=> String
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.cause #=> String, one of "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.control #=> String
resp.events[0].schedule_activity_task_failed_event_attributes.activity_type.name #=> String
resp.events[0].schedule_activity_task_failed_event_attributes.activity_type.version #=> String
resp.events[0].schedule_activity_task_failed_event_attributes.activity_id #=> String
resp.events[0].schedule_activity_task_failed_event_attributes.cause #=> String, one of "ACTIVITY_TYPE_DEPRECATED", "ACTIVITY_TYPE_DOES_NOT_EXIST", "ACTIVITY_ID_ALREADY_IN_USE", "OPEN_ACTIVITIES_LIMIT_EXCEEDED", "ACTIVITY_CREATION_RATE_EXCEEDED", "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", "OPERATION_NOT_PERMITTED"
resp.events[0].schedule_activity_task_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].request_cancel_activity_task_failed_event_attributes.activity_id #=> String
resp.events[0].request_cancel_activity_task_failed_event_attributes.cause #=> String, one of "ACTIVITY_ID_UNKNOWN", "OPERATION_NOT_PERMITTED"
resp.events[0].request_cancel_activity_task_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_timer_failed_event_attributes.timer_id #=> String
resp.events[0].start_timer_failed_event_attributes.cause #=> String, one of "TIMER_ID_ALREADY_IN_USE", "OPEN_TIMERS_LIMIT_EXCEEDED", "TIMER_CREATION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
resp.events[0].start_timer_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].cancel_timer_failed_event_attributes.timer_id #=> String
resp.events[0].cancel_timer_failed_event_attributes.cause #=> String, one of "TIMER_ID_UNKNOWN", "OPERATION_NOT_PERMITTED"
resp.events[0].cancel_timer_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_type.name #=> String
resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_type.version #=> String
resp.events[0].start_child_workflow_execution_failed_event_attributes.cause #=> String, one of "WORKFLOW_TYPE_DOES_NOT_EXIST", "WORKFLOW_TYPE_DEPRECATED", "OPEN_CHILDREN_LIMIT_EXCEEDED", "OPEN_WORKFLOWS_LIMIT_EXCEEDED", "CHILD_CREATION_RATE_EXCEEDED", "WORKFLOW_ALREADY_RUNNING", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "OPERATION_NOT_PERMITTED"
resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_id #=> String
resp.events[0].start_child_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
resp.events[0].start_child_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_child_workflow_execution_failed_event_attributes.control #=> String
resp.events[0].lambda_function_scheduled_event_attributes.id #=> String
resp.events[0].lambda_function_scheduled_event_attributes.name #=> String
resp.events[0].lambda_function_scheduled_event_attributes.control #=> String
resp.events[0].lambda_function_scheduled_event_attributes.input #=> String
resp.events[0].lambda_function_scheduled_event_attributes.start_to_close_timeout #=> String
resp.events[0].lambda_function_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].lambda_function_started_event_attributes.scheduled_event_id #=> Integer
resp.events[0].lambda_function_completed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].lambda_function_completed_event_attributes.started_event_id #=> Integer
resp.events[0].lambda_function_completed_event_attributes.result #=> String
resp.events[0].lambda_function_failed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].lambda_function_failed_event_attributes.started_event_id #=> Integer
resp.events[0].lambda_function_failed_event_attributes.reason #=> String
resp.events[0].lambda_function_failed_event_attributes.details #=> String
resp.events[0].lambda_function_timed_out_event_attributes.scheduled_event_id #=> Integer
resp.events[0].lambda_function_timed_out_event_attributes.started_event_id #=> Integer
resp.events[0].lambda_function_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
resp.events[0].schedule_lambda_function_failed_event_attributes.id #=> String
resp.events[0].schedule_lambda_function_failed_event_attributes.name #=> String
resp.events[0].schedule_lambda_function_failed_event_attributes.cause #=> String, one of "ID_ALREADY_IN_USE", "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED", "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED", "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"
resp.events[0].schedule_lambda_function_failed_event_attributes.decision_task_completed_event_id #=> Integer
resp.events[0].start_lambda_function_failed_event_attributes.scheduled_event_id #=> Integer
resp.events[0].start_lambda_function_failed_event_attributes.cause #=> String, one of "ASSUME_ROLE_FAILED"
resp.events[0].start_lambda_function_failed_event_attributes.message #=> String
resp.next_page_token #=> String
resp.previous_started_event_id #=> Integer

Options Hash (options):

  • :domain (required, String)

    The name of the domain containing the task lists to poll.

  • :task_list (required, Types::TaskList)

    Specifies the task list to poll for decision tasks.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :identity (String)

    Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

  • :next_page_token (String)

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

    The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn\'t return a new decision task.

  • :maximum_page_size (Integer)

    The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

  • :reverse_order (Boolean)

    When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

Returns:

#record_activity_task_heartbeat(options = {}) ⇒ Types::ActivityTaskStatus

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 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 doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

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.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.record_activity_task_heartbeat({
  task_token: "TaskToken", # required
  details: "LimitedData",
})

Response structure


resp.cancel_requested #=> true/false

Options Hash (options):

  • :task_token (required, String)

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

  • :details (String)

    If specified, contains details about the progress of the task.

Returns:

#register_activity_type(options = {}) ⇒ Struct

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.register_activity_type({
  domain: "DomainName", # required
  name: "Name", # required
  version: "Version", # required
  description: "Description",
  default_task_start_to_close_timeout: "DurationInSecondsOptional",
  default_task_heartbeat_timeout: "DurationInSecondsOptional",
  default_task_list: {
    name: "Name", # required
  },
  default_task_priority: "TaskPriority",
  default_task_schedule_to_start_timeout: "DurationInSecondsOptional",
  default_task_schedule_to_close_timeout: "DurationInSecondsOptional",
})

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which this activity is to be registered.

  • :name (required, String)

    The name of the activity type within the domain.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :version (required, String)

    The version of the activity type.

    The activity type consists of the name and version, the combination of which must be unique within the domain.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :description (String)

    A textual description of the activity type.

  • :default_task_start_to_close_timeout (String)

    If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

  • :default_task_heartbeat_timeout (String)

    If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

  • :default_task_list (Types::TaskList)

    If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn\'t provided when a task is scheduled through the ScheduleActivityTask Decision.

  • :default_task_priority (String)

    The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java\'s Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

  • :default_task_schedule_to_start_timeout (String)

    If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

  • :default_task_schedule_to_close_timeout (String)

    If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Returns:

  • (Struct)

    Returns an empty response.

#register_domain(options = {}) ⇒ Struct

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.register_domain({
  name: "DomainName", # required
  description: "Description",
  workflow_execution_retention_period_in_days: "DurationInDays", # required
})

Options Hash (options):

  • :name (required, String)

    Name of the domain to register. The name must be unique in the region that the domain is registered in.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :description (String)

    A text description of the domain.

  • :workflow_execution_retention_period_in_days (required, String)

    The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn\'t available in the results of visibility calls.

    If you pass the value NONE or 0 (zero), then the workflow execution history isn\'t retained. As soon as the workflow execution completes, the execution record and its history are deleted.

    The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

Returns:

  • (Struct)

    Returns an empty response.

#register_workflow_type(options = {}) ⇒ Struct

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.register_workflow_type({
  domain: "DomainName", # required
  name: "Name", # required
  version: "Version", # required
  description: "Description",
  default_task_start_to_close_timeout: "DurationInSecondsOptional",
  default_execution_start_to_close_timeout: "DurationInSecondsOptional",
  default_task_list: {
    name: "Name", # required
  },
  default_task_priority: "TaskPriority",
  default_child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
  default_lambda_role: "Arn",
})

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which to register the workflow type.

  • :name (required, String)

    The name of the workflow type.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :version (required, String)

    The version of the workflow type.

    The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :description (String)

    Textual description of the workflow type.

  • :default_task_start_to_close_timeout (String)

    If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

  • :default_execution_start_to_close_timeout (String)

    If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

    The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

  • :default_task_list (Types::TaskList)

    If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn\'t provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

  • :default_task_priority (String)

    The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java\'s Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

  • :default_child_policy (String)

    If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

  • :default_lambda_role (String)

    The default IAM role attached to this workflow type.

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don\'t specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Returns:

  • (Struct)

    Returns an empty response.

#request_cancel_workflow_execution(options = {}) ⇒ Struct

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.

If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.request_cancel_workflow_execution({
  domain: "DomainName", # required
  workflow_id: "WorkflowId", # required
  run_id: "WorkflowRunIdOptional",
})

Options Hash (options):

  • :domain (required, String)

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

  • :workflow_id (required, String)

    The workflowId of the workflow execution to cancel.

  • :run_id (String)

    The runId of the workflow execution to cancel.

Returns:

  • (Struct)

    Returns an empty response.

#respond_activity_task_canceled(options = {}) ⇒ Struct

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be 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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.respond_activity_task_canceled({
  task_token: "TaskToken", # required
  details: "Data",
})

Options Hash (options):

  • :task_token (required, String)

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

  • :details (String)

    Information about the cancellation.

Returns:

  • (Struct)

    Returns an empty response.

#respond_activity_task_completed(options = {}) ⇒ Struct

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 doesn't 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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.respond_activity_task_completed({
  task_token: "TaskToken", # required
  result: "Data",
})

Options Hash (options):

  • :task_token (required, String)

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

  • :result (String)

    The result of the activity task. It is a free form string that is implementation specific.

Returns:

  • (Struct)

    Returns an empty response.

#respond_activity_task_failed(options = {}) ⇒ Struct

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.respond_activity_task_failed({
  task_token: "TaskToken", # required
  reason: "FailureReason",
  details: "Data",
})

Options Hash (options):

  • :task_token (required, String)

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

  • :reason (String)

    Description of the error that may assist in diagnostics.

  • :details (String)

    Detailed information about the failure.

Returns:

  • (Struct)

    Returns an empty response.

#respond_decision_task_completed(options = {}) ⇒ Struct

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 in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.respond_decision_task_completed({
  task_token: "TaskToken", # required
  decisions: [
    {
      decision_type: "ScheduleActivityTask", # required, accepts ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution, ScheduleLambdaFunction
      schedule_activity_task_decision_attributes: {
        activity_type: { # required
          name: "Name", # required
          version: "Version", # required
        },
        activity_id: "ActivityId", # required
        control: "Data",
        input: "Data",
        schedule_to_close_timeout: "DurationInSecondsOptional",
        task_list: {
          name: "Name", # required
        },
        task_priority: "TaskPriority",
        schedule_to_start_timeout: "DurationInSecondsOptional",
        start_to_close_timeout: "DurationInSecondsOptional",
        heartbeat_timeout: "DurationInSecondsOptional",
      },
      request_cancel_activity_task_decision_attributes: {
        activity_id: "ActivityId", # required
      },
      complete_workflow_execution_decision_attributes: {
        result: "Data",
      },
      fail_workflow_execution_decision_attributes: {
        reason: "FailureReason",
        details: "Data",
      },
      cancel_workflow_execution_decision_attributes: {
        details: "Data",
      },
      continue_as_new_workflow_execution_decision_attributes: {
        input: "Data",
        execution_start_to_close_timeout: "DurationInSecondsOptional",
        task_list: {
          name: "Name", # required
        },
        task_priority: "TaskPriority",
        task_start_to_close_timeout: "DurationInSecondsOptional",
        child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
        tag_list: ["Tag"],
        workflow_type_version: "Version",
        lambda_role: "Arn",
      },
      record_marker_decision_attributes: {
        marker_name: "MarkerName", # required
        details: "Data",
      },
      start_timer_decision_attributes: {
        timer_id: "TimerId", # required
        control: "Data",
        start_to_fire_timeout: "DurationInSeconds", # required
      },
      cancel_timer_decision_attributes: {
        timer_id: "TimerId", # required
      },
      signal_external_workflow_execution_decision_attributes: {
        workflow_id: "WorkflowId", # required
        run_id: "WorkflowRunIdOptional",
        signal_name: "SignalName", # required
        input: "Data",
        control: "Data",
      },
      request_cancel_external_workflow_execution_decision_attributes: {
        workflow_id: "WorkflowId", # required
        run_id: "WorkflowRunIdOptional",
        control: "Data",
      },
      start_child_workflow_execution_decision_attributes: {
        workflow_type: { # required
          name: "Name", # required
          version: "Version", # required
        },
        workflow_id: "WorkflowId", # required
        control: "Data",
        input: "Data",
        execution_start_to_close_timeout: "DurationInSecondsOptional",
        task_list: {
          name: "Name", # required
        },
        task_priority: "TaskPriority",
        task_start_to_close_timeout: "DurationInSecondsOptional",
        child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
        tag_list: ["Tag"],
        lambda_role: "Arn",
      },
      schedule_lambda_function_decision_attributes: {
        id: "FunctionId", # required
        name: "FunctionName", # required
        control: "Data",
        input: "FunctionInput",
        start_to_close_timeout: "DurationInSecondsOptional",
      },
    },
  ],
  execution_context: "Data",
})

Options Hash (options):

  • :task_token (required, String)

    The taskToken from the DecisionTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

  • :decisions (Array<Types::Decision>)

    The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.

  • :execution_context (String)

    User defined context to add to workflow execution.

Returns:

  • (Struct)

    Returns an empty response.

#signal_workflow_execution(options = {}) ⇒ Struct

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).

If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

If the specified workflow execution isn't 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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.signal_workflow_execution({
  domain: "DomainName", # required
  workflow_id: "WorkflowId", # required
  run_id: "WorkflowRunIdOptional",
  signal_name: "SignalName", # required
  input: "Data",
})

Options Hash (options):

  • :domain (required, String)

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

  • :workflow_id (required, String)

    The workflowId of the workflow execution to signal.

  • :run_id (String)

    The runId of the workflow execution to signal.

  • :signal_name (required, String)

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

  • :input (String)

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

Returns:

  • (Struct)

    Returns an empty response.

#start_workflow_execution(options = {}) ⇒ Types::Run

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.start_workflow_execution({
  domain: "DomainName", # required
  workflow_id: "WorkflowId", # required
  workflow_type: { # required
    name: "Name", # required
    version: "Version", # required
  },
  task_list: {
    name: "Name", # required
  },
  task_priority: "TaskPriority",
  input: "Data",
  execution_start_to_close_timeout: "DurationInSecondsOptional",
  tag_list: ["Tag"],
  task_start_to_close_timeout: "DurationInSecondsOptional",
  child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
  lambda_role: "Arn",
})

Response structure


resp.run_id #=> String

Options Hash (options):

  • :domain (required, String)

    The name of the domain in which the workflow execution is created.

  • :workflow_id (required, String)

    The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :workflow_type (required, Types::WorkflowType)

    The type of the workflow to start.

  • :task_list (Types::TaskList)

    The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

  • :task_priority (String)

    The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java\'s Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

  • :input (String)

    The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

  • :execution_start_to_close_timeout (String)

    The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

    An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

  • :tag_list (Array<String>)

    The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

  • :task_start_to_close_timeout (String)

    Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

  • :child_policy (String)

    If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

  • :lambda_role (String)

    The IAM role to attach to this workflow execution.

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don\'t attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Returns:

#terminate_workflow_execution(options = {}) ⇒ Struct

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.

If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

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 doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.terminate_workflow_execution({
  domain: "DomainName", # required
  workflow_id: "WorkflowId", # required
  run_id: "WorkflowRunIdOptional",
  reason: "TerminateReason",
  details: "Data",
  child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
})

Options Hash (options):

  • :domain (required, String)

    The domain of the workflow execution to terminate.

  • :workflow_id (required, String)

    The workflowId of the workflow execution to terminate.

  • :run_id (String)

    The runId of the workflow execution to terminate.

  • :reason (String)

    A descriptive reason for terminating the workflow execution.

  • :details (String)

    Details for terminating the workflow execution.

  • :child_policy (String)

    If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Returns:

  • (Struct)

    Returns an empty response.

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.