AWS Simple Workflow Service (version v1.*.*)

count_closed_workflow_executions#

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.

{
  "tagFilter" : {
    "tag" : " Specifies the tag that must be associated with the execution for it to meet the filter criteria. \nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @."
  },
  "typeFilter" : {
    "name" : " Name of the workflow type.",
    "version" : "Version of the workflow type."
  },
  "closeStatusFilter" : {
    "status" : " The close status that must match the close status of an execution for it to meet the criteria of this filter."
  },
  "domain" : "The name of the domain containing the workflow executions to count.",
  "startTimeFilter" : {
    "latestDate" : "Specifies the latest start or close date and time to return.",
    "oldestDate" : "Specifies the oldest start or close date and time to return."
  },
  "executionFilter" : {
    "workflowId" : "The workflowId to pass of match the criteria of this filter."
  },
  "closeTimeFilter" : {
    "latestDate" : "Specifies the latest start or close date and time to return.",
    "oldestDate" : "Specifies the oldest start or close date and time to return."
  }
}

count_open_workflow_executions#

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.

{
  "tagFilter" : {
    "tag" : " Specifies the tag that must be associated with the execution for it to meet the filter criteria. \nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @."
  },
  "typeFilter" : {
    "name" : " Name of the workflow type.",
    "version" : "Version of the workflow type."
  },
  "domain" : "The name of the domain containing the workflow executions to count.",
  "startTimeFilter" : {
    "latestDate" : "Specifies the latest start or close date and time to return.",
    "oldestDate" : "Specifies the oldest start or close date and time to return."
  },
  "executionFilter" : {
    "workflowId" : "The workflowId to pass of match the criteria of this filter."
  }
}

count_pending_activity_tasks#

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.

{
  "domain" : "The name of the domain that contains the task list.",
  "taskList" : {
    "name" : "The name of the task list."
  }
}

count_pending_decision_tasks#

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.

{
  "domain" : "The name of the domain that contains the task list.",
  "taskList" : {
    "name" : "The name of the task list."
  }
}

deprecate_activity_type#

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.

{
  "domain" : "The name of the domain in which the activity type is registered.",
  "activityType" : {
    "name" : "The name of this activity.  \nThe combination of activity type name and version must be unique within a domain.",
    "version" : "The version of this activity.  \nThe combination of activity type name and version must be unique with in a domain."
  }
}

deprecate_domain#

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.

{
  "name" : "The name of the domain to deprecate."
}

deprecate_workflow_type#

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.

{
  "domain" : "The name of the domain in which the workflow type is registered.",
  "workflowType" : {
    "name" : " The name of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain.",
    "version" : " The version of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain."
  }
}

describe_activity_type#

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.

{
  "domain" : "The name of the domain in which the activity type is registered.",
  "activityType" : {
    "name" : "The name of this activity.  \nThe combination of activity type name and version must be unique within a domain.",
    "version" : "The version of this activity.  \nThe combination of activity type name and version must be unique with in a domain."
  }
}

describe_domain#

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.

{
  "name" : "The name of the domain to describe."
}

describe_workflow_execution#

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.

{
  "execution" : {
    "runId" : "A system-generated unique identifier for the workflow execution.",
    "workflowId" : "The user defined identifier associated with the workflow execution."
  },
  "domain" : "The name of the domain containing the workflow execution."
}

describe_workflow_type#

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.

{
  "domain" : "The name of the domain in which this workflow type is registered.",
  "workflowType" : {
    "name" : " The name of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain.",
    "version" : " The version of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain."
  }
}

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

{
  "execution" : {
    "runId" : "A system-generated unique identifier for the workflow execution.",
    "workflowId" : "The user defined identifier associated with the workflow execution."
  },
  "reverseOrder" : "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.",
  "domain" : "The name of the domain containing the workflow execution."
}

list_activity_types#

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.

{
  "registrationStatus" : "Specifies the registration status of the activity types to list.",
  "reverseOrder" : "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.",
  "domain" : "The name of the domain in which the activity types have been registered.",
  "name" : "If specified, only lists the activity types that have this name."
}

list_closed_workflow_executions#

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.

{
  "tagFilter" : {
    "tag" : " Specifies the tag that must be associated with the execution for it to meet the filter criteria. \nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @."
  },
  "typeFilter" : {
    "name" : " Name of the workflow type.",
    "version" : "Version of the workflow type."
  },
  "closeStatusFilter" : {
    "status" : " The close status that must match the close status of an execution for it to meet the criteria of this filter."
  },
  "reverseOrder" : "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.",
  "domain" : "The name of the domain that contains the workflow executions to list.",
  "startTimeFilter" : {
    "latestDate" : "Specifies the latest start or close date and time to return.",
    "oldestDate" : "Specifies the oldest start or close date and time to return."
  },
  "executionFilter" : {
    "workflowId" : "The workflowId to pass of match the criteria of this filter."
  },
  "closeTimeFilter" : {
    "latestDate" : "Specifies the latest start or close date and time to return.",
    "oldestDate" : "Specifies the oldest start or close date and time to return."
  }
}

list_domains#

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.

{
  "registrationStatus" : "Specifies the registration status of the domains to list.",
  "reverseOrder" : "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."
}

list_open_workflow_executions#

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.

{
  "tagFilter" : {
    "tag" : " Specifies the tag that must be associated with the execution for it to meet the filter criteria. \nTags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @."
  },
  "typeFilter" : {
    "name" : " Name of the workflow type.",
    "version" : "Version of the workflow type."
  },
  "reverseOrder" : "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.",
  "domain" : "The name of the domain that contains the workflow executions to list.",
  "startTimeFilter" : {
    "latestDate" : "Specifies the latest start or close date and time to return.",
    "oldestDate" : "Specifies the oldest start or close date and time to return."
  },
  "executionFilter" : {
    "workflowId" : "The workflowId to pass of match the criteria of this filter."
  }
}

list_tags_for_resource#

List tags for a given domain.

{
  "resourceArn" : "The Amazon Resource Name (ARN) for the Amazon SWF domain."
}

list_workflow_types#

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.

{
  "registrationStatus" : "Specifies the registration status of the workflow types to list.",
  "reverseOrder" : "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.",
  "domain" : "The name of the domain in which the workflow types have been registered.",
  "name" : "If specified, lists the workflow type with this name."
}

poll_for_activity_task#

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.

{
  "identity" : "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.",
  "domain" : "The name of the domain that contains the task lists being polled.",
  "taskList" : {
    "name" : "The name of the task list."
  }
}

poll_for_decision_task#

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.

{
  "identity" : "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.",
  "reverseOrder" : "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.",
  "domain" : "The name of the domain containing the task lists to poll.",
  "taskList" : {
    "name" : "The name of the task list."
  }
}

record_activity_task_heartbeat#

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.

{
  "details" : "If specified, contains details about the progress of the task.",
  "taskToken" : "The taskToken of the ActivityTask.  \n 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. "
}

register_activity_type#

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.

{
  "defaultTaskScheduleToStartTimeout" : "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. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.",
  "defaultTaskList" : {
    "name" : "The name of the task list."
  },
  "domain" : "The name of the domain in which this activity is to be registered.",
  "defaultTaskStartToCloseTimeout" : "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. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.",
  "name" : "The name of the activity type within the domain. \nThe 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 be the literal string arn.",
  "description" : "A textual description of the activity type.",
  "defaultTaskHeartbeatTimeout" : "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. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.",
  "defaultTaskScheduleToCloseTimeout" : "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. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.",
  "version" : "The version of the activity type.  \nThe activity type consists of the name and version, the combination of which must be unique within the domain.  \nThe 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 be the literal string arn.",
  "defaultTaskPriority" : "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. \nFor more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide.."
}

register_domain#

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.

{
  "workflowExecutionRetentionPeriodInDays" : "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. \nIf 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. \nThe 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.",
  "name" : "Name of the domain to register. The name must be unique in the region that the domain is registered in. \nThe 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 be the literal string arn.",
  "description" : "A text description of the domain.",
  "tags" : [ {
    "value" : "The value of a tag.",
    "key" : "The key of a tag."
  } ]
}

register_workflow_type#

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.

{
  "defaultChildPolicy" : "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. \nThe supported child policies are:  \n  TERMINATE – The child executions are terminated.  \n  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.  \n  ABANDON – No action is taken. The child executions continue to run. ",
  "defaultTaskList" : {
    "name" : "The name of the task list."
  },
  "domain" : "The name of the domain in which to register the workflow type.",
  "defaultTaskStartToCloseTimeout" : "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. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.",
  "name" : "The name of the workflow type. \nThe 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 be the literal string arn.",
  "description" : "Textual description of the workflow type.",
  "defaultLambdaRole" : "The default IAM role attached to this workflow type.  \nExecutions 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 https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.",
  "version" : "The version of the workflow type.  \nThe 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.  \nThe 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 be the literal string arn.",
  "defaultExecutionStartToCloseTimeout" : "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. \nThe 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.",
  "defaultTaskPriority" : "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. \nFor more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide."
}

request_cancel_workflow_execution#

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.

{
  "domain" : "The name of the domain containing the workflow execution to cancel.",
  "runId" : "The runId of the workflow execution to cancel.",
  "workflowId" : "The workflowId of the workflow execution to cancel."
}

respond_activity_task_canceled#

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.

{
  "details" : " Information about the cancellation.",
  "taskToken" : "The taskToken of the ActivityTask.  \n 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."
}

respond_activity_task_completed#

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.

{
  "result" : "The result of the activity task. It is a free form string that is implementation specific.",
  "taskToken" : "The taskToken of the ActivityTask.  \n 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."
}

respond_activity_task_failed#

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.

{
  "reason" : "Description of the error that may assist in diagnostics.",
  "details" : " Detailed information about the failure.",
  "taskToken" : "The taskToken of the ActivityTask.  \n 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."
}

respond_decision_task_completed#

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.

{
  "executionContext" : "User defined context to add to workflow execution.",
  "decisions" : [ {
    "cancelWorkflowExecutionDecisionAttributes" : {
      "details" : " Details of the cancellation."
    },
    "cancelTimerDecisionAttributes" : {
      "timerId" : " The unique ID of the timer to cancel."
    },
    "recordMarkerDecisionAttributes" : {
      "details" : " The details of the marker.",
      "markerName" : " The name of the marker."
    },
    "requestCancelExternalWorkflowExecutionDecisionAttributes" : {
      "control" : "The data attached to the event that can be used by the decider in subsequent workflow tasks.",
      "runId" : "The runId of the external workflow execution to cancel.",
      "workflowId" : " The workflowId of the external workflow execution to cancel."
    },
    "scheduleActivityTaskDecisionAttributes" : {
      "startToCloseTimeout" : "If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.  \nA start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.",
      "activityId" : " The activityId of the activity task. \nThe 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.",
      "input" : "The input provided to the activity task.",
      "scheduleToCloseTimeout" : "The maximum duration for this activity task. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.  \nA schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.",
      "scheduleToStartTimeout" : " If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.  \nA schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.",
      "taskPriority" : " If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. \nFor more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.",
      "taskList" : {
        "name" : "The name of the task list."
      },
      "control" : "Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.",
      "activityType" : {
        "name" : "The name of this activity.  \nThe combination of activity type name and version must be unique within a domain.",
        "version" : "The version of this activity.  \nThe combination of activity type name and version must be unique with in a domain."
      },
      "heartbeatTimeout" : "If set, specifies the 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. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration."
    },
    "scheduleLambdaFunctionDecisionAttributes" : {
      "startToCloseTimeout" : "The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed.",
      "input" : "The optional input data to be supplied to the Lambda function.",
      "name" : "The name, or ARN, of the Lambda function to schedule.",
      "control" : "The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.",
      "id" : "A string that identifies the Lambda function execution in the event history."
    },
    "continueAsNewWorkflowExecutionDecisionAttributes" : {
      "tagList" : [ "string" ],
      "input" : "The input provided to the new workflow execution.",
      "lambdaRole" : "The IAM role to attach to the new (continued) execution.",
      "childPolicy" : "If set, specifies the policy to use for the child workflow executions of the new 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. \nThe supported child policies are:  \n  TERMINATE – The child executions are terminated.  \n  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.  \n  ABANDON – No action is taken. The child executions continue to run.    \nA 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.",
      "workflowTypeVersion" : "The version of the workflow to start.",
      "taskPriority" : " The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. \nFor more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.",
      "taskList" : {
        "name" : "The name of the task list."
      },
      "taskStartToCloseTimeout" : "Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.  \nA task start-to-close timeout for the new 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.",
      "executionStartToCloseTimeout" : "If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.  \nAn execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned."
    },
    "failWorkflowExecutionDecisionAttributes" : {
      "reason" : "A descriptive reason for the failure that may help in diagnostics.",
      "details" : " Details of the failure."
    },
    "signalExternalWorkflowExecutionDecisionAttributes" : {
      "signalName" : " The name of the signal.The target workflow execution uses the signal name and input to process the signal.",
      "input" : " The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.",
      "control" : "The data attached to the event that can be used by the decider in subsequent decision tasks.",
      "runId" : "The runId of the workflow execution to be signaled.",
      "workflowId" : " The workflowId of the workflow execution to be signaled."
    },
    "completeWorkflowExecutionDecisionAttributes" : {
      "result" : "The result of the workflow execution. The form of the result is implementation defined."
    },
    "startTimerDecisionAttributes" : {
      "control" : "The data attached to the event that can be used by the decider in subsequent workflow tasks.",
      "startToFireTimeout" : " The duration to wait before firing the timer. \nThe duration is specified in seconds, an integer greater than or equal to 0.",
      "timerId" : " The unique ID of the timer. \nThe 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."
    },
    "requestCancelActivityTaskDecisionAttributes" : {
      "activityId" : "The activityId of the activity task to be canceled."
    },
    "decisionType" : "Specifies the type of the decision.",
    "startChildWorkflowExecutionDecisionAttributes" : {
      "tagList" : [ "string" ],
      "input" : "The input to be provided to the workflow execution.",
      "lambdaRole" : "The IAM role attached to the child workflow execution.",
      "childPolicy" : " If set, specifies the policy to use for the child workflow executions if the workflow execution being started 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. \nThe supported child policies are:  \n  TERMINATE – The child executions are terminated.  \n  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.  \n  ABANDON – No action is taken. The child executions continue to run.    \nA 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.",
      "taskPriority" : " A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. \nFor more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.",
      "taskList" : {
        "name" : "The name of the task list."
      },
      "workflowType" : {
        "name" : " The name of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain.",
        "version" : " The version of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain."
      },
      "control" : "The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.",
      "taskStartToCloseTimeout" : "Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.  \nA 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.",
      "executionStartToCloseTimeout" : "The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.  \nAn execution 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 execution start-to-close timeout was specified at registration time then a fault is returned.",
      "workflowId" : " The workflowId of the workflow execution. \nThe 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."
    }
  } ],
  "taskToken" : "The taskToken from the DecisionTask.  \n 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."
}

signal_workflow_execution#

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.

{
  "signalName" : "The name of the signal. This name must be meaningful to the target workflow.",
  "input" : "Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.",
  "domain" : "The name of the domain containing the workflow execution to signal.",
  "runId" : "The runId of the workflow execution to signal.",
  "workflowId" : "The workflowId of the workflow execution to signal."
}

start_workflow_execution#

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.

{
  "tagList" : [ "string" ],
  "input" : "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.",
  "lambdaRole" : "The IAM role to attach to this workflow execution.  \nExecutions 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 https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.",
  "domain" : "The name of the domain in which the workflow execution is created.",
  "childPolicy" : "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. \nThe supported child policies are:  \n  TERMINATE – The child executions are terminated.  \n  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.  \n  ABANDON – No action is taken. The child executions continue to run.    \nA 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.",
  "taskPriority" : "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. \nFor more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.",
  "taskList" : {
    "name" : "The name of the task list."
  },
  "workflowType" : {
    "name" : " The name of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain.",
    "version" : " The version of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain."
  },
  "taskStartToCloseTimeout" : "Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. \nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.  \nA 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.",
  "executionStartToCloseTimeout" : "The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. \nThe 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.  \nAn 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.",
  "workflowId" : "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 within the same domain. \nThe 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 be the literal string arn."
}

tag_resource#

Add a tag to a Amazon SWF domain.
Amazon SWF supports a maximum of 50 tags per resource.

{
  "resourceArn" : "The Amazon Resource Name (ARN) for the Amazon SWF domain.",
  "tags" : [ {
    "value" : "The value of a tag.",
    "key" : "The key of a tag."
  } ]
}

terminate_workflow_execution#

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.

{
  "reason" : " A descriptive reason for terminating the workflow execution.",
  "domain" : "The domain of the workflow execution to terminate.",
  "childPolicy" : "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. \nThe supported child policies are:  \n  TERMINATE – The child executions are terminated.  \n  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.  \n  ABANDON – No action is taken. The child executions continue to run.    \nA 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.",
  "details" : " Details for terminating the workflow execution.",
  "runId" : "The runId of the workflow execution to terminate.",
  "workflowId" : "The workflowId of the workflow execution to terminate."
}

undeprecate_activity_type#

Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type.
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.

{
  "domain" : "The name of the domain of the deprecated activity type.",
  "activityType" : {
    "name" : "The name of this activity.  \nThe combination of activity type name and version must be unique within a domain.",
    "version" : "The version of this activity.  \nThe combination of activity type name and version must be unique with in a domain."
  }
}

undeprecate_domain#

Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.
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.

{
  "name" : "The name of the domain of the deprecated workflow type."
}

undeprecate_workflow_type#

Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type.
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.

{
  "domain" : "The name of the domain of the deprecated workflow type.",
  "workflowType" : {
    "name" : " The name of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain.",
    "version" : " The version of the workflow type.  \nThe combination of workflow type name and version must be unique with in a domain."
  }
}

untag_resource#

Remove a tag from a Amazon SWF domain.

{
  "tagKeys" : [ "string" ],
  "resourceArn" : "The Amazon Resource Name (ARN) for the Amazon SWF domain."
}