Class: Aws::SWF::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SWF::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-swf/client.rb
Overview
An API client for SWF. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::SWF::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#count_closed_workflow_executions(params = {}) ⇒ Types::WorkflowExecutionCount
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
-
#count_open_workflow_executions(params = {}) ⇒ Types::WorkflowExecutionCount
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
-
#count_pending_activity_tasks(params = {}) ⇒ Types::PendingTaskCount
Returns the estimated number of activity tasks in the specified task list.
-
#count_pending_decision_tasks(params = {}) ⇒ Types::PendingTaskCount
Returns the estimated number of decision tasks in the specified task list.
-
#deprecate_activity_type(params = {}) ⇒ Struct
Deprecates the specified *activity type*.
-
#deprecate_domain(params = {}) ⇒ Struct
Deprecates the specified domain.
-
#deprecate_workflow_type(params = {}) ⇒ Struct
Deprecates the specified *workflow type*.
-
#describe_activity_type(params = {}) ⇒ Types::ActivityTypeDetail
Returns information about the specified activity type.
-
#describe_domain(params = {}) ⇒ Types::DomainDetail
Returns information about the specified domain, including description and status.
-
#describe_workflow_execution(params = {}) ⇒ Types::WorkflowExecutionDetail
Returns information about the specified workflow execution including its type and some statistics.
-
#describe_workflow_type(params = {}) ⇒ Types::WorkflowTypeDetail
Returns information about the specified *workflow type*.
-
#get_workflow_execution_history(params = {}) ⇒ Types::History
Returns the history of the specified workflow execution.
-
#list_activity_types(params = {}) ⇒ Types::ActivityTypeInfos
Returns information about all activities registered in the specified domain that match the specified name and registration status.
-
#list_closed_workflow_executions(params = {}) ⇒ Types::WorkflowExecutionInfos
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
-
#list_domains(params = {}) ⇒ Types::DomainInfos
Returns the list of domains registered in the account.
-
#list_open_workflow_executions(params = {}) ⇒ Types::WorkflowExecutionInfos
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List tags for a given domain.
-
#list_workflow_types(params = {}) ⇒ Types::WorkflowTypeInfos
Returns information about workflow types in the specified domain.
-
#poll_for_activity_task(params = {}) ⇒ Types::ActivityTask
Used by workers to get an ActivityTask from the specified activity ‘taskList`.
-
#poll_for_decision_task(params = {}) ⇒ Types::DecisionTask
Used by deciders to get a DecisionTask from the specified decision ‘taskList`.
-
#record_activity_task_heartbeat(params = {}) ⇒ Types::ActivityTaskStatus
Used by activity workers to report to the service that the ActivityTask represented by the specified ‘taskToken` is still making progress.
-
#register_activity_type(params = {}) ⇒ Struct
Registers a new *activity type* along with its configuration settings in the specified domain.
-
#register_domain(params = {}) ⇒ Struct
Registers a new domain.
-
#register_workflow_type(params = {}) ⇒ Struct
Registers a new *workflow type* and its configuration settings in the specified domain.
-
#request_cancel_workflow_execution(params = {}) ⇒ Struct
Records a ‘WorkflowExecutionCancelRequested` event in the currently running workflow execution identified by the given domain, workflowId, and runId.
-
#respond_activity_task_canceled(params = {}) ⇒ Struct
Used by workers to tell the service that the ActivityTask identified by the ‘taskToken` was successfully canceled.
-
#respond_activity_task_completed(params = {}) ⇒ Struct
Used by workers to tell the service that the ActivityTask identified by the ‘taskToken` completed successfully with a `result` (if provided).
-
#respond_activity_task_failed(params = {}) ⇒ Struct
Used by workers to tell the service that the ActivityTask identified by the ‘taskToken` has failed with `reason` (if specified).
-
#respond_decision_task_completed(params = {}) ⇒ Struct
Used by deciders to tell the service that the DecisionTask identified by the ‘taskToken` has successfully completed.
-
#signal_workflow_execution(params = {}) ⇒ Struct
Records a ‘WorkflowExecutionSignaled` event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId.
-
#start_workflow_execution(params = {}) ⇒ Types::Run
Starts an execution of the workflow type in the specified domain using the provided ‘workflowId` and input data.
-
#tag_resource(params = {}) ⇒ Struct
Add a tag to a Amazon SWF domain.
-
#terminate_workflow_execution(params = {}) ⇒ Struct
Records a ‘WorkflowExecutionTerminated` event and forces closure of the workflow execution identified by the given domain, runId, and workflowId.
-
#undeprecate_activity_type(params = {}) ⇒ Struct
Undeprecates a previously deprecated *activity type*.
-
#undeprecate_domain(params = {}) ⇒ Struct
Undeprecates a previously deprecated domain.
-
#undeprecate_workflow_type(params = {}) ⇒ Struct
Undeprecates a previously deprecated *workflow type*.
-
#untag_resource(params = {}) ⇒ Struct
Remove a tag from a Amazon SWF domain.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
397 398 399 |
# File 'lib/aws-sdk-swf/client.rb', line 397 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4398 4399 4400 |
# File 'lib/aws-sdk-swf/client.rb', line 4398 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4401 4402 4403 |
# File 'lib/aws-sdk-swf/client.rb', line 4401 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 |
# File 'lib/aws-sdk-swf/client.rb', line 4376 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-swf' context[:gem_version] = '1.50.0' Seahorse::Client::Request.new(handlers, context) end |
#count_closed_workflow_executions(params = {}) ⇒ Types::WorkflowExecutionCount
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
546 547 548 549 |
# File 'lib/aws-sdk-swf/client.rb', line 546 def count_closed_workflow_executions(params = {}, = {}) req = build_request(:count_closed_workflow_executions, params) req.send_request() end |
#count_open_workflow_executions(params = {}) ⇒ Types::WorkflowExecutionCount
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
658 659 660 661 |
# File 'lib/aws-sdk-swf/client.rb', line 658 def count_open_workflow_executions(params = {}, = {}) req = build_request(:count_open_workflow_executions, params) req.send_request() end |
#count_pending_activity_tasks(params = {}) ⇒ Types::PendingTaskCount
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn’t guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then ‘0` is returned.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the ‘taskList.name` parameter by using a `Condition` element with the `swf:taskList.name` key to allow the action to access only certain task lists.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
721 722 723 724 |
# File 'lib/aws-sdk-swf/client.rb', line 721 def count_pending_activity_tasks(params = {}, = {}) req = build_request(:count_pending_activity_tasks, params) req.send_request() end |
#count_pending_decision_tasks(params = {}) ⇒ Types::PendingTaskCount
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn’t guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then ‘0` is returned.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the ‘taskList.name` parameter by using a `Condition` element with the `swf:taskList.name` key to allow the action to access only certain task lists.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
784 785 786 787 |
# File 'lib/aws-sdk-swf/client.rb', line 784 def count_pending_decision_tasks(params = {}, = {}) req = build_request(:count_pending_decision_tasks, params) req.send_request() end |
#deprecate_activity_type(params = {}) ⇒ Struct
Deprecates the specified *activity type*. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
850 851 852 853 |
# File 'lib/aws-sdk-swf/client.rb', line 850 def deprecate_activity_type(params = {}, = {}) req = build_request(:deprecate_activity_type, params) req.send_request() end |
#deprecate_domain(params = {}) ⇒ Struct
Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
904 905 906 907 |
# File 'lib/aws-sdk-swf/client.rb', line 904 def deprecate_domain(params = {}, = {}) req = build_request(:deprecate_domain, params) req.send_request() end |
#deprecate_workflow_type(params = {}) ⇒ Struct
Deprecates the specified *workflow type*. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
971 972 973 974 |
# File 'lib/aws-sdk-swf/client.rb', line 971 def deprecate_workflow_type(params = {}, = {}) req = build_request(:deprecate_workflow_type, params) req.send_request() end |
#describe_activity_type(params = {}) ⇒ Types::ActivityTypeDetail
Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the following parameters by using a ‘Condition` element with the appropriate keys.
-
‘activityType.name`: String constraint. The key is `swf:activityType.name`.
-
‘activityType.version`: String constraint. The key is `swf:activityType.version`.
-
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
1051 1052 1053 1054 |
# File 'lib/aws-sdk-swf/client.rb', line 1051 def describe_activity_type(params = {}, = {}) req = build_request(:describe_activity_type, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DomainDetail
Returns information about the specified domain, including description and status.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
You cannot use an IAM policy to constrain this action’s parameters.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
1107 1108 1109 1110 |
# File 'lib/aws-sdk-swf/client.rb', line 1107 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_workflow_execution(params = {}) ⇒ Types::WorkflowExecutionDetail
Returns information about the specified workflow execution including its type and some statistics.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
1199 1200 1201 1202 |
# File 'lib/aws-sdk-swf/client.rb', line 1199 def describe_workflow_execution(params = {}, = {}) req = build_request(:describe_workflow_execution, params) req.send_request() end |
#describe_workflow_type(params = {}) ⇒ Types::WorkflowTypeDetail
Returns information about the specified *workflow type*. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the following parameters by using a ‘Condition` element with the appropriate keys.
-
‘workflowType.name`: String constraint. The key is `swf:workflowType.name`.
-
‘workflowType.version`: String constraint. The key is `swf:workflowType.version`.
-
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
1277 1278 1279 1280 |
# File 'lib/aws-sdk-swf/client.rb', line 1277 def describe_workflow_type(params = {}, = {}) req = build_request(:describe_workflow_type, params) req.send_request() end |
#get_workflow_execution_history(params = {}) ⇒ Types::History
Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the ‘nextPageToken` returned by the initial call.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1617 1618 1619 1620 |
# File 'lib/aws-sdk-swf/client.rb', line 1617 def get_workflow_execution_history(params = {}, = {}) req = build_request(:get_workflow_execution_history, params) req.send_request() end |
#list_activity_types(params = {}) ⇒ Types::ActivityTypeInfos
Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the ‘nextPageToken` returned by the initial call.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
You cannot use an IAM policy to constrain this action’s parameters.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1715 1716 1717 1718 |
# File 'lib/aws-sdk-swf/client.rb', line 1715 def list_activity_types(params = {}, = {}) req = build_request(:list_activity_types, params) req.send_request() end |
#list_closed_workflow_executions(params = {}) ⇒ Types::WorkflowExecutionInfos
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1907 1908 1909 1910 |
# File 'lib/aws-sdk-swf/client.rb', line 1907 def list_closed_workflow_executions(params = {}, = {}) req = build_request(:list_closed_workflow_executions, params) req.send_request() end |
#list_domains(params = {}) ⇒ Types::DomainInfos
Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1998 1999 2000 2001 |
# File 'lib/aws-sdk-swf/client.rb', line 1998 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() end |
#list_open_workflow_executions(params = {}) ⇒ Types::WorkflowExecutionInfos
Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2152 2153 2154 2155 |
# File 'lib/aws-sdk-swf/client.rb', line 2152 def list_open_workflow_executions(params = {}, = {}) req = build_request(:list_open_workflow_executions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List tags for a given domain.
2180 2181 2182 2183 |
# File 'lib/aws-sdk-swf/client.rb', line 2180 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_workflow_types(params = {}) ⇒ Types::WorkflowTypeInfos
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
You cannot use an IAM policy to constrain this action’s parameters.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2275 2276 2277 2278 |
# File 'lib/aws-sdk-swf/client.rb', line 2275 def list_workflow_types(params = {}, = {}) req = build_request(:list_workflow_types, params) req.send_request() end |
#poll_for_activity_task(params = {}) ⇒ Types::ActivityTask
Used by workers to get an ActivityTask from the specified activity ‘taskList`. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.
Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the ‘taskList.name` parameter by using a `Condition` element with the `swf:taskList.name` key to allow the action to access only certain task lists.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
2369 2370 2371 2372 |
# File 'lib/aws-sdk-swf/client.rb', line 2369 def poll_for_activity_task(params = {}, = {}) req = build_request(:poll_for_activity_task, params) req.send_request() end |
#poll_for_decision_task(params = {}) ⇒ Types::DecisionTask
Used by deciders to get a DecisionTask from the specified decision ‘taskList`. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to ‘PollForDecisionTask` using the `nextPageToken` returned by the initial call. Note that you do not call `GetWorkflowExecutionHistory` with this `nextPageToken`. Instead, call `PollForDecisionTask` again.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the ‘taskList.name` parameter by using a `Condition` element with the `swf:taskList.name` key to allow the action to access only certain task lists.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2767 2768 2769 2770 |
# File 'lib/aws-sdk-swf/client.rb', line 2767 def poll_for_decision_task(params = {}, = {}) req = build_request(:poll_for_decision_task, params) req.send_request() end |
#record_activity_task_heartbeat(params = {}) ⇒ Types::ActivityTaskStatus
Used by activity workers to report to the service that the ActivityTask represented by the specified ‘taskToken` is still making progress. The worker can also specify details of the progress, for example percent complete, using the `details` parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean `cancelRequested` flag returned by the service is set to `true`.
This action resets the ‘taskHeartbeatTimeout` clock. The `taskHeartbeatTimeout` is specified in RegisterActivityType.
This action doesn’t in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ‘ActivityTaskTimedOut` event that contains the information from the last heartbeat generated by the activity worker.
<note markdown=“1”> 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 markdown=“1”> 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>
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
2860 2861 2862 2863 |
# File 'lib/aws-sdk-swf/client.rb', line 2860 def record_activity_task_heartbeat(params = {}, = {}) req = build_request(:record_activity_task_heartbeat, params) req.send_request() end |
#register_activity_type(params = {}) ⇒ Struct
Registers a new *activity type* along with its configuration settings in the specified domain.
A ‘TypeAlreadyExists` fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the following parameters by using a ‘Condition` element with the appropriate keys.
-
‘defaultTaskList.name`: String constraint. The key is `swf:defaultTaskList.name`.
-
‘name`: String constraint. The key is `swf:name`.
-
‘version`: String constraint. The key is `swf:version`.
-
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3009 3010 3011 3012 |
# File 'lib/aws-sdk-swf/client.rb', line 3009 def register_activity_type(params = {}, = {}) req = build_request(:register_activity_type, params) req.send_request() end |
#register_domain(params = {}) ⇒ Struct
Registers a new domain.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
You cannot use an IAM policy to constrain this action’s parameters.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3095 3096 3097 3098 |
# File 'lib/aws-sdk-swf/client.rb', line 3095 def register_domain(params = {}, = {}) req = build_request(:register_domain, params) req.send_request() end |
#register_workflow_type(params = {}) ⇒ Struct
Registers a new *workflow type* and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
If the type already exists, then a ‘TypeAlreadyExists` fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the following parameters by using a ‘Condition` element with the appropriate keys.
-
‘defaultTaskList.name`: String constraint. The key is `swf:defaultTaskList.name`.
-
‘name`: String constraint. The key is `swf:name`.
-
‘version`: String constraint. The key is `swf:version`.
-
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3267 3268 3269 3270 |
# File 'lib/aws-sdk-swf/client.rb', line 3267 def register_workflow_type(params = {}, = {}) req = build_request(:register_workflow_type, params) req.send_request() end |
#request_cancel_workflow_execution(params = {}) ⇒ Struct
Records a ‘WorkflowExecutionCancelRequested` event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.
<note markdown=“1”> 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.
</note>
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3335 3336 3337 3338 |
# File 'lib/aws-sdk-swf/client.rb', line 3335 def request_cancel_workflow_execution(params = {}, = {}) req = build_request(:request_cancel_workflow_execution, params) req.send_request() end |
#respond_activity_task_canceled(params = {}) ⇒ Struct
Used by workers to tell the service that the ActivityTask identified by the ‘taskToken` was successfully canceled. Additional `details` can be provided using the `details` argument.
These ‘details` (if provided) appear in the `ActivityTaskCanceled` event added to the workflow history.
Only use this operation if the ‘canceled` flag of a RecordActivityTaskHeartbeat request returns `true` and if the activity can be safely undone or abandoned.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has [timed out].
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
You cannot use an IAM policy to constrain this action’s parameters.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types [2]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3404 3405 3406 3407 |
# File 'lib/aws-sdk-swf/client.rb', line 3404 def respond_activity_task_canceled(params = {}, = {}) req = build_request(:respond_activity_task_canceled, params) req.send_request() end |
#respond_activity_task_completed(params = {}) ⇒ Struct
Used by workers to tell the service that the ActivityTask identified by the ‘taskToken` completed successfully with a `result` (if provided). The `result` appears in the `ActivityTaskCompleted` event in the workflow history.
If the requested task doesn’t complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the ‘canceled` flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has [timed out].
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
You cannot use an IAM policy to constrain this action’s parameters.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types [2]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3474 3475 3476 3477 |
# File 'lib/aws-sdk-swf/client.rb', line 3474 def respond_activity_task_completed(params = {}, = {}) req = build_request(:respond_activity_task_completed, params) req.send_request() end |
#respond_activity_task_failed(params = {}) ⇒ Struct
Used by workers to tell the service that the ActivityTask identified by the ‘taskToken` has failed with `reason` (if specified). The `reason` and `details` appear in the `ActivityTaskFailed` event added to the workflow history.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has [timed out].
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
You cannot use an IAM policy to constrain this action’s parameters.
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types [2]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3541 3542 3543 3544 |
# File 'lib/aws-sdk-swf/client.rb', line 3541 def respond_activity_task_failed(params = {}, = {}) req = build_request(:respond_activity_task_failed, params) req.send_request() end |
#respond_decision_task_completed(params = {}) ⇒ Struct
Used by deciders to tell the service that the DecisionTask identified by the ‘taskToken` has successfully completed. The `decisions` argument specifies the list of decisions made while processing the task.
A ‘DecisionTaskCompleted` event is added to the workflow history. The `executionContext` specified is attached to the event in the workflow execution history.
**Access Control**
If an IAM policy grants permission to use ‘RespondDecisionTaskCompleted`, it can express permissions for the list of decisions in the `decisions` parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3718 3719 3720 3721 |
# File 'lib/aws-sdk-swf/client.rb', line 3718 def respond_decision_task_completed(params = {}, = {}) req = build_request(:respond_decision_task_completed, params) req.send_request() end |
#signal_workflow_execution(params = {}) ⇒ Struct
Records a ‘WorkflowExecutionSignaled` event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).
<note markdown=“1”> 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.
</note>
<note markdown=“1”> If the specified workflow execution isn’t 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
3795 3796 3797 3798 |
# File 'lib/aws-sdk-swf/client.rb', line 3795 def signal_workflow_execution(params = {}, = {}) req = build_request(:signal_workflow_execution, params) req.send_request() end |
#start_workflow_execution(params = {}) ⇒ Types::Run
Starts an execution of the workflow type in the specified domain using the provided ‘workflowId` and input data.
This action returns the newly started workflow execution.
**Access Control**
You can use IAM policies to control this action’s access to Amazon SWF resources as follows:
-
Use a ‘Resource` element with the domain name to limit the action to only specified domains.
-
Use an ‘Action` element to allow or deny permission to call this action.
-
Constrain the following parameters by using a ‘Condition` element with the appropriate keys.
-
‘tagList.member.0`: The key is `swf:tagList.member.0`.
-
‘tagList.member.1`: The key is `swf:tagList.member.1`.
-
‘tagList.member.2`: The key is `swf:tagList.member.2`.
-
‘tagList.member.3`: The key is `swf:tagList.member.3`.
-
‘tagList.member.4`: The key is `swf:tagList.member.4`.
-
‘taskList`: String constraint. The key is `swf:taskList.name`.
-
‘workflowType.name`: String constraint. The key is `swf:workflowType.name`.
-
‘workflowType.version`: String constraint. The key is `swf:workflowType.version`.
-
If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
4021 4022 4023 4024 |
# File 'lib/aws-sdk-swf/client.rb', line 4021 def start_workflow_execution(params = {}, = {}) req = build_request(:start_workflow_execution, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Add a tag to a Amazon SWF domain.
<note markdown=“1”> Amazon SWF supports a maximum of 50 tags per resource.
</note>
4057 4058 4059 4060 |
# File 'lib/aws-sdk-swf/client.rb', line 4057 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#terminate_workflow_execution(params = {}) ⇒ Struct
Records a ‘WorkflowExecutionTerminated` event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.
If the identified workflow execution was in progress, it is terminated immediately.
<note markdown=“1”> 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.
</note>
<note markdown=“1”> You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn’t.
</note>
**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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
4162 4163 4164 4165 |
# File 'lib/aws-sdk-swf/client.rb', line 4162 def terminate_workflow_execution(params = {}, = {}) req = build_request(:terminate_workflow_execution, params) req.send_request() end |
#undeprecate_activity_type(params = {}) ⇒ Struct
Undeprecates a previously deprecated *activity type*. After an activity type has been undeprecated, you can create new tasks of that activity type.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
4227 4228 4229 4230 |
# File 'lib/aws-sdk-swf/client.rb', line 4227 def undeprecate_activity_type(params = {}, = {}) req = build_request(:undeprecate_activity_type, params) req.send_request() end |
#undeprecate_domain(params = {}) ⇒ Struct
Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
4278 4279 4280 4281 |
# File 'lib/aws-sdk-swf/client.rb', line 4278 def undeprecate_domain(params = {}, = {}) req = build_request(:undeprecate_domain, params) req.send_request() end |
#undeprecate_workflow_type(params = {}) ⇒ Struct
Undeprecates a previously deprecated *workflow type*. After a workflow type has been undeprecated, you can create new executions of that type.
<note markdown=“1”> 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:
-
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*.
[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
4343 4344 4345 4346 |
# File 'lib/aws-sdk-swf/client.rb', line 4343 def undeprecate_workflow_type(params = {}, = {}) req = build_request(:undeprecate_workflow_type, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove a tag from a Amazon SWF domain.
4367 4368 4369 4370 |
# File 'lib/aws-sdk-swf/client.rb', line 4367 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4391 4392 4393 |
# File 'lib/aws-sdk-swf/client.rb', line 4391 def waiter_names [] end |