Current section

Files

Jump to
aws lib aws swf.ex
Raw

lib/aws/swf.ex

# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/jkakar/aws-codegen for more details.
defmodule AWS.SWF do
@moduledoc """
Amazon Simple Workflow Service
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build
applications that use Amazon's cloud to coordinate work across distributed
components. In Amazon SWF, a *task* represents a logical unit of work that
is performed by a component of your workflow. Coordinating tasks in a
workflow involves managing intertask dependencies, scheduling, and
concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating
them without worrying about underlying complexities such as tracking their
progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the
Amazon SWF programming model, see the [Amazon SWF Developer
Guide](http://docs.aws.amazon.com/amazonswf/latest/developerguide/).
"""
@doc """
Returns the number of closed workflow executions within the given domain
that meet the specified filtering criteria.
<note>This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li>`tagFilter.tag`: String constraint. The key is
`swf:tagFilter.tag`.</li> <li>`typeFilter.name`: String constraint. The key
is `swf:typeFilter.name`.</li> <li>`typeFilter.version`: String constraint.
The key is `swf:typeFilter.version`.</li> </ul> </li> </ul> If the caller
does not have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The
associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def count_closed_workflow_executions(client, input, options \\ []) do
request(client, "CountClosedWorkflowExecutions", input, options)
end
@doc """
Returns the number of open workflow executions within the given domain that
meet the specified filtering criteria.
<note>This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li>`tagFilter.tag`: String constraint. The key is
`swf:tagFilter.tag`.</li> <li>`typeFilter.name`: String constraint. The key
is `swf:typeFilter.name`.</li> <li>`typeFilter.version`: String constraint.
The key is `swf:typeFilter.version`.</li> </ul> </li> </ul> If the caller
does not have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The
associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def count_open_workflow_executions(client, input, options \\ []) do
request(client, "CountOpenWorkflowExecutions", input, options)
end
@doc """
Returns the estimated number of activity tasks in the specified task list.
The count returned is an approximation and is not guaranteed to be exact.
If you specify a task list that no activity task was ever scheduled in then
0 will be returned.
**Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>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.</li> </ul> If the
caller does not have sufficient permissions to invoke the action, or the
parameter values fall outside the specified constraints, the action fails.
The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def count_pending_activity_tasks(client, input, options \\ []) do
request(client, "CountPendingActivityTasks", input, options)
end
@doc """
Returns the estimated number of decision tasks in the specified task list.
The count returned is an approximation and is not guaranteed to be exact.
If you specify a task list that no decision task was ever scheduled in then
0 will be returned.
**Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>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.</li> </ul> If the
caller does not have sufficient permissions to invoke the action, or the
parameter values fall outside the specified constraints, the action fails.
The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def count_pending_decision_tasks(client, input, options \\ []) do
request(client, "CountPendingDecisionTasks", input, options)
end
@doc """
Deprecates the specified *activity type*. After an activity type has been
deprecated, you cannot create new tasks of that activity type. Tasks of
this type that were scheduled before the type was deprecated will continue
to run.
<note>This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li>`activityType.name`: String constraint. The key is
`swf:activityType.name`.</li> <li>`activityType.version`: String
constraint. The key is `swf:activityType.version`.</li> </ul> </li> </ul>
If the caller does not have sufficient permissions to invoke the action, or
the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def deprecate_activity_type(client, input, options \\ []) do
request(client, "DeprecateActivityType", input, options)
end
@doc """
Deprecates the specified domain. After a domain has been deprecated it
cannot be used to create new workflow executions or register new types.
However, you can still use visibility actions on this domain. Deprecating a
domain also deprecates all activity and workflow types registered in the
domain. Executions that were started before the domain was deprecated will
continue to run.
<note>This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def deprecate_domain(client, input, options \\ []) do
request(client, "DeprecateDomain", input, options)
end
@doc """
Deprecates the specified *workflow type*. After a workflow type has been
deprecated, you cannot create new executions of that type. Executions that
were started before the type was deprecated will continue to run. A
deprecated workflow type may still be used when calling visibility actions.
<note>This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li>`workflowType.name`: String constraint. The key is
`swf:workflowType.name`.</li> <li>`workflowType.version`: String
constraint. The key is `swf:workflowType.version`.</li> </ul> </li> </ul>
If the caller does not have sufficient permissions to invoke the action, or
the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def deprecate_workflow_type(client, input, options \\ []) do
request(client, "DeprecateWorkflowType", input, options)
end
@doc """
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:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li>`activityType.name`: String constraint. The key is
`swf:activityType.name`.</li> <li>`activityType.version`: String
constraint. The key is `swf:activityType.version`.</li> </ul> </li> </ul>
If the caller does not have sufficient permissions to invoke the action, or
the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def describe_activity_type(client, input, options \\ []) do
request(client, "DescribeActivityType", input, options)
end
@doc """
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:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def describe_domain(client, input, options \\ []) do
request(client, "DescribeDomain", input, options)
end
@doc """
Returns information about the specified workflow execution including its
type and some statistics.
<note>This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def describe_workflow_execution(client, input, options \\ []) do
request(client, "DescribeWorkflowExecution", input, options)
end
@doc """
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:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li>`workflowType.name`: String constraint. The key is
`swf:workflowType.name`.</li> <li>`workflowType.version`: String
constraint. The key is `swf:workflowType.version`.</li> </ul> </li> </ul>
If the caller does not have sufficient permissions to invoke the action, or
the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def describe_workflow_type(client, input, options \\ []) do
request(client, "DescribeWorkflowType", input, options)
end
@doc """
Returns the history of the specified workflow execution. The results may be
split into multiple pages. To retrieve subsequent pages, make the call
again using the `nextPageToken` returned by the initial call.
<note>This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def get_workflow_execution_history(client, input, options \\ []) do
request(client, "GetWorkflowExecutionHistory", input, options)
end
@doc """
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:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def list_activity_types(client, input, options \\ []) do
request(client, "ListActivityTypes", input, options)
end
@doc """
Returns a list of closed workflow executions in the specified domain that
meet the filtering criteria. The results may be split into multiple pages.
To retrieve subsequent pages, make the call again using the nextPageToken
returned by the initial call.
<note>This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li>`tagFilter.tag`: String constraint. The key is
`swf:tagFilter.tag`.</li> <li>`typeFilter.name`: String constraint. The key
is `swf:typeFilter.name`.</li> <li>`typeFilter.version`: String constraint.
The key is `swf:typeFilter.version`.</li> </ul> </li> </ul> If the caller
does not have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The
associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def list_closed_workflow_executions(client, input, options \\ []) do
request(client, "ListClosedWorkflowExecutions", input, options)
end
@doc """
Returns the list of domains registered in the account. The results may be
split into multiple pages. To retrieve subsequent pages, make the call
again using the nextPageToken returned by the initial call.
<note> This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>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.</li> <li>Use an `Action` element to allow or deny
permission to call this action.</li> <li>You cannot use an IAM policy to
constrain this action's parameters.</li> </ul> If the caller does not have
sufficient permissions to invoke the action, or the parameter values fall
outside the specified constraints, the action fails. The associated event
attribute's **cause** parameter will be set to OPERATION_NOT_PERMITTED. For
details and example IAM policies, see [Using IAM to Manage Access to Amazon
SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def list_domains(client, input, options \\ []) do
request(client, "ListDomains", input, options)
end
@doc """
Returns a list of open workflow executions in the specified domain that
meet the filtering criteria. The results may be split into multiple pages.
To retrieve subsequent pages, make the call again using the nextPageToken
returned by the initial call.
<note> This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes.</note> **Access
Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li>`tagFilter.tag`: String constraint. The key is
`swf:tagFilter.tag`.</li> <li>`typeFilter.name`: String constraint. The key
is `swf:typeFilter.name`.</li> <li>`typeFilter.version`: String constraint.
The key is `swf:typeFilter.version`.</li> </ul> </li> </ul> If the caller
does not have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The
associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def list_open_workflow_executions(client, input, options \\ []) do
request(client, "ListOpenWorkflowExecutions", input, options)
end
@doc """
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:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def list_workflow_types(client, input, options \\ []) do
request(client, "ListWorkflowTypes", input, options)
end
@doc """
Used by workers to get an `ActivityTask` from the specified activity
`taskList`. This initiates a long poll, where the service holds the HTTP
connection open and responds as soon as a task becomes available. The
maximum time the service holds on to the request before responding is 60
seconds. If no task is available within 60 seconds, the poll will return an
empty result. An empty result, in this context, means that an ActivityTask
is returned, but that the value of taskToken is an empty string. If a task
is returned, the worker should use its type to identify and process it
correctly.
<important>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).</important> **Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>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.</li> </ul> If the
caller does not have sufficient permissions to invoke the action, or the
parameter values fall outside the specified constraints, the action fails.
The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def poll_for_activity_task(client, input, options \\ []) do
request(client, "PollForActivityTask", input, options)
end
@doc """
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.
<important>Deciders should set their client side socket timeout to at least
70 seconds (10 seconds higher than the timeout).</important>
<important>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.</important> **Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>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.</li> </ul> If the
caller does not have sufficient permissions to invoke the action, or the
parameter values fall outside the specified constraints, the action fails.
The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def poll_for_decision_task(client, input, options \\ []) do
request(client, "PollForDecisionTask", input, options)
end
@doc """
Used by activity workers to report to the service that the `ActivityTask`
represented by the specified `taskToken` is still making progress. The
worker can also (optionally) specify details of the progress, for example
percent complete, using the `details` parameter. This action can also be
used by the worker as a mechanism to check if cancellation is being
requested for the activity task. If a cancellation is being attempted for
the specified task, then the boolean `cancelRequested` flag returned by the
service is set to `true`.
This action resets the `taskHeartbeatTimeout` clock. The
`taskHeartbeatTimeout` is specified in `RegisterActivityType`.
This action does not in itself create an event in the workflow execution
history. However, if the task times out, the workflow execution history
will contain a `ActivityTaskTimedOut` event that contains the information
from the last heartbeat generated by the activity worker.
<note>The `taskStartToCloseTimeout` of an activity type is the maximum
duration of an activity task, regardless of the number of
`RecordActivityTaskHeartbeat` requests received. The
`taskStartToCloseTimeout` is also specified in
`RegisterActivityType`.</note> <note>This operation is only useful for
long-lived activities to report liveliness of the task and to determine if
a cancellation is being attempted. </note> <important>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.</important> **Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def record_activity_task_heartbeat(client, input, options \\ []) do
request(client, "RecordActivityTaskHeartbeat", input, options)
end
@doc """
Registers a new *activity type* along with its configuration settings in
the specified domain.
<important>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.</important> **Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li> `defaultTaskList.name`: String constraint. The key is
`swf:defaultTaskList.name`.</li> <li> `name`: String constraint. The key is
`swf:name`.</li> <li> `version`: String constraint. The key is
`swf:version`.</li> </ul> </li> </ul> If the caller does not have
sufficient permissions to invoke the action, or the parameter values fall
outside the specified constraints, the action fails. The associated event
attribute's **cause** parameter will be set to OPERATION_NOT_PERMITTED. For
details and example IAM policies, see [Using IAM to Manage Access to Amazon
SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def register_activity_type(client, input, options \\ []) do
request(client, "RegisterActivityType", input, options)
end
@doc """
Registers a new domain.
**Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>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.</li> <li>Use an `Action` element to allow or deny
permission to call this action.</li> <li>You cannot use an IAM policy to
constrain this action's parameters.</li> </ul> If the caller does not have
sufficient permissions to invoke the action, or the parameter values fall
outside the specified constraints, the action fails. The associated event
attribute's **cause** parameter will be set to OPERATION_NOT_PERMITTED. For
details and example IAM policies, see [Using IAM to Manage Access to Amazon
SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def register_domain(client, input, options \\ []) do
request(client, "RegisterDomain", input, options)
end
@doc """
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.
<important>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.</important> **Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li> `defaultTaskList.name`: String constraint. The key is
`swf:defaultTaskList.name`.</li> <li> `name`: String constraint. The key is
`swf:name`.</li> <li> `version`: String constraint. The key is
`swf:version`.</li> </ul> </li> </ul> If the caller does not have
sufficient permissions to invoke the action, or the parameter values fall
outside the specified constraints, the action fails. The associated event
attribute's **cause** parameter will be set to OPERATION_NOT_PERMITTED. For
details and example IAM policies, see [Using IAM to Manage Access to Amazon
SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def register_workflow_type(client, input, options \\ []) do
request(client, "RegisterWorkflowType", input, options)
end
@doc """
Records a `WorkflowExecutionCancelRequested` event in the currently running
workflow execution identified by the given domain, workflowId, and runId.
This logically requests the cancellation of the workflow execution as a
whole. It is up to the decider to take appropriate actions when it receives
an execution history with this event.
<note>If the runId is not specified, the `WorkflowExecutionCancelRequested`
event is recorded in the history of the current open workflow execution
with the specified workflowId in the domain.</note> <note>Because this
action allows the workflow to properly clean up and gracefully close, it
should be used instead of `TerminateWorkflowExecution` when
possible.</note> **Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def request_cancel_workflow_execution(client, input, options \\ []) do
request(client, "RequestCancelWorkflowExecution", input, options)
end
@doc """
Used by workers to tell the service that the `ActivityTask` identified by
the `taskToken` was successfully canceled. Additional `details` can be
optionally provided using the `details` argument.
These `details` (if provided) appear in the `ActivityTaskCanceled` event
added to the workflow history.
<important>Only use this operation if the `canceled` flag of a
`RecordActivityTaskHeartbeat` request returns `true` and if the activity
can be safely undone or abandoned.</important> 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](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types).
**Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def respond_activity_task_canceled(client, input, options \\ []) do
request(client, "RespondActivityTaskCanceled", input, options)
end
@doc """
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.
<important> If the requested task does not complete successfully, use
`RespondActivityTaskFailed` instead. If the worker finds that the task is
canceled through the `canceled` flag returned by
`RecordActivityTaskHeartbeat`, it should cancel the task, clean up and then
call `RespondActivityTaskCanceled`.</important> 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](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types).
**Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def respond_activity_task_completed(client, input, options \\ []) do
request(client, "RespondActivityTaskCompleted", input, options)
end
@doc """
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](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types).
**Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def respond_activity_task_failed(client, input, options \\ []) do
request(client, "RespondActivityTaskFailed", input, options)
end
@doc """
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](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def respond_decision_task_completed(client, input, options \\ []) do
request(client, "RespondDecisionTaskCompleted", input, options)
end
@doc """
Records a `WorkflowExecutionSignaled` event in the workflow execution
history and creates a decision task for the workflow execution identified
by the given domain, workflowId and runId. The event is recorded with the
specified user defined signalName and input (if provided).
<note> If a runId is not specified, then the `WorkflowExecutionSignaled`
event is recorded in the history of the current open workflow with the
matching workflowId in the domain.</note> <note> If the specified workflow
execution is not open, this method fails with `UnknownResource`.</note>
**Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def signal_workflow_execution(client, input, options \\ []) do
request(client, "SignalWorkflowExecution", input, options)
end
@doc """
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:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>Constrain the following
parameters by using a `Condition` element with the appropriate keys. <ul>
<li> `tagList.member.0`: The key is `swf:tagList.member.0`.</li> <li>
`tagList.member.1`: The key is `swf:tagList.member.1`.</li> <li>
`tagList.member.2`: The key is `swf:tagList.member.2`.</li> <li>
`tagList.member.3`: The key is `swf:tagList.member.3`.</li> <li>
`tagList.member.4`: The key is `swf:tagList.member.4`.</li> <li>`taskList`:
String constraint. The key is `swf:taskList.name`.</li>
<li>`workflowType.name`: String constraint. The key is
`swf:workflowType.name`.</li> <li>`workflowType.version`: String
constraint. The key is `swf:workflowType.version`.</li> </ul> </li> </ul>
If the caller does not have sufficient permissions to invoke the action, or
the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def start_workflow_execution(client, input, options \\ []) do
request(client, "StartWorkflowExecution", input, options)
end
@doc """
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.
<important> If the identified workflow execution was in progress, it is
terminated immediately.</important> <note> If a runId is not specified,
then the `WorkflowExecutionTerminated` event is recorded in the history of
the current open workflow with the matching workflowId in the
domain.</note> <note> You should consider using
`RequestCancelWorkflowExecution` action instead because it allows the
workflow to gracefully close while `TerminateWorkflowExecution` does
not.</note> **Access Control**
You can use IAM policies to control this action's access to Amazon SWF
resources as follows:
<ul> <li>Use a `Resource` element with the domain name to limit the action
to only specified domains.</li> <li>Use an `Action` element to allow or
deny permission to call this action.</li> <li>You cannot use an IAM policy
to constrain this action's parameters.</li> </ul> If the caller does not
have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated
event attribute's **cause** parameter will be set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see [Using
IAM to Manage Access to Amazon SWF
Workflows](http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
"""
def terminate_workflow_execution(client, input, options \\ []) do
request(client, "TerminateWorkflowExecution", input, options)
end
defp request(client, action, input, options) do
client = %{client | service: "swf"}
host = "swf.#{client.region}.#{client.endpoint}"
url = "https://#{host}/"
headers = [{"Host", host},
{"Content-Type", "application/x-amz-json-1.0"},
{"X-Amz-Target", "SimpleWorkflowService.#{action}"}]
payload = Poison.Encoder.encode(input, [])
headers = AWS.Request.sign_v4(client, "POST", url, headers, payload)
case HTTPoison.post(url, payload, headers, options) do
{:ok, response=%HTTPoison.Response{status_code: 200, body: body}} ->
{:ok, Poison.Parser.parse!(body), response}
{:ok, _response=%HTTPoison.Response{body: body}} ->
reason = Poison.Parser.parse!(body)["__type"]
{:error, reason}
{:error, %HTTPoison.Error{reason: reason}} ->
{:error, %HTTPoison.Error{reason: reason}}
end
end
end