aws-sdk-swf 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-swf.rb +47 -0
- data/lib/aws-sdk-swf/client.rb +3304 -0
- data/lib/aws-sdk-swf/client_api.rb +1618 -0
- data/lib/aws-sdk-swf/customizations.rb +0 -0
- data/lib/aws-sdk-swf/errors.rb +23 -0
- data/lib/aws-sdk-swf/plugins/read_timeouts.rb +26 -0
- data/lib/aws-sdk-swf/resource.rb +25 -0
- data/lib/aws-sdk-swf/types.rb +6318 -0
- metadata +81 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 8bcb0105cfae0c5313054c887eded64c5c2615ba
|
4
|
+
data.tar.gz: 08179bfb8598a048d89b4a66406f15a294b076be
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 38981fba9f66c4cdff8021ccfd4dabd4757c15efa9f7645058bd4f19c8af201ed8f869811ef78ff7c686fcd5e4cdbc872585ca3c8f6eee048cf78ce264f3d592
|
7
|
+
data.tar.gz: 7e95a0d64f8678a7ed63a114727129fdcec42b618a1beb6d01380ad5fd4e6a487a8f99ed684a4c0e2a627be2ea3f8e0f1699793c4bb6b44d039d53a7764dd9aa
|
data/lib/aws-sdk-swf.rb
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-swf/types'
|
12
|
+
require_relative 'aws-sdk-swf/client_api'
|
13
|
+
require_relative 'aws-sdk-swf/client'
|
14
|
+
require_relative 'aws-sdk-swf/errors'
|
15
|
+
require_relative 'aws-sdk-swf/resource'
|
16
|
+
require_relative 'aws-sdk-swf/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon Simple Workflow Service. This module is available in the
|
19
|
+
# `aws-sdk-swf` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from Amazon Simple Workflow Service all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::SWF::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::SWF
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,3304 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
23
|
+
require 'aws-sdk-swf/plugins/read_timeouts.rb'
|
24
|
+
|
25
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:swf)
|
26
|
+
|
27
|
+
module Aws
|
28
|
+
module SWF
|
29
|
+
class Client < Seahorse::Client::Base
|
30
|
+
|
31
|
+
include Aws::ClientStubs
|
32
|
+
|
33
|
+
@identifier = :swf
|
34
|
+
|
35
|
+
set_api(ClientApi::API)
|
36
|
+
|
37
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
38
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
39
|
+
add_plugin(Aws::Plugins::Logging)
|
40
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
41
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
42
|
+
add_plugin(Aws::Plugins::UserAgent)
|
43
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
44
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
45
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
46
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
47
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
48
|
+
add_plugin(Aws::Plugins::StubResponses)
|
49
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
50
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
51
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
52
|
+
add_plugin(Aws::SWF::Plugins::ReadTimeouts)
|
53
|
+
|
54
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
55
|
+
# Your AWS credentials. This can be an instance of any one of the
|
56
|
+
# following classes:
|
57
|
+
#
|
58
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
59
|
+
# credentials.
|
60
|
+
#
|
61
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
62
|
+
# from an EC2 IMDS on an EC2 instance.
|
63
|
+
#
|
64
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
65
|
+
# shared file, such as `~/.aws/config`.
|
66
|
+
#
|
67
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
68
|
+
#
|
69
|
+
# When `:credentials` are not configured directly, the following
|
70
|
+
# locations will be searched for credentials:
|
71
|
+
#
|
72
|
+
# * `Aws.config[:credentials]`
|
73
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
74
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
75
|
+
# * `~/.aws/credentials`
|
76
|
+
# * `~/.aws/config`
|
77
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
78
|
+
# very aggressive. Construct and pass an instance of
|
79
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
80
|
+
# timeouts.
|
81
|
+
# @option options [required, String] :region
|
82
|
+
# The AWS region to connect to. The configured `:region` is
|
83
|
+
# used to determine the service `:endpoint`. When not passed,
|
84
|
+
# a default `:region` is search for in the following locations:
|
85
|
+
#
|
86
|
+
# * `Aws.config[:region]`
|
87
|
+
# * `ENV['AWS_REGION']`
|
88
|
+
# * `ENV['AMAZON_REGION']`
|
89
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
90
|
+
# * `~/.aws/credentials`
|
91
|
+
# * `~/.aws/config`
|
92
|
+
# @option options [String] :access_key_id
|
93
|
+
# @option options [Boolean] :convert_params (true)
|
94
|
+
# When `true`, an attempt is made to coerce request parameters into
|
95
|
+
# the required types.
|
96
|
+
# @option options [String] :endpoint
|
97
|
+
# The client endpoint is normally constructed from the `:region`
|
98
|
+
# option. You should only configure an `:endpoint` when connecting
|
99
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
100
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
101
|
+
# The log formatter.
|
102
|
+
# @option options [Symbol] :log_level (:info)
|
103
|
+
# The log level to send messages to the `:logger` at.
|
104
|
+
# @option options [Logger] :logger
|
105
|
+
# The Logger instance to send log messages to. If this option
|
106
|
+
# is not set, logging will be disabled.
|
107
|
+
# @option options [String] :profile ("default")
|
108
|
+
# Used when loading credentials from the shared credentials file
|
109
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
110
|
+
# @option options [Integer] :retry_limit (3)
|
111
|
+
# The maximum number of times to retry failed requests. Only
|
112
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
113
|
+
# are retried. Generally, these are throttling errors, data
|
114
|
+
# checksum errors, networking errors, timeout errors and auth
|
115
|
+
# errors from expired credentials.
|
116
|
+
# @option options [String] :secret_access_key
|
117
|
+
# @option options [String] :session_token
|
118
|
+
# @option options [Boolean] :simple_json (false)
|
119
|
+
# Disables request parameter conversion, validation, and formatting.
|
120
|
+
# Also disable response data type conversions. This option is useful
|
121
|
+
# when you want to ensure the highest level of performance by
|
122
|
+
# avoiding overhead of walking request parameters and response data
|
123
|
+
# structures.
|
124
|
+
#
|
125
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
126
|
+
# be formatted exactly as the DynamoDB API expects.
|
127
|
+
# @option options [Boolean] :stub_responses (false)
|
128
|
+
# Causes the client to return stubbed responses. By default
|
129
|
+
# fake responses are generated and returned. You can specify
|
130
|
+
# the response data to return or errors to raise by calling
|
131
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
132
|
+
#
|
133
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
134
|
+
# requests are made, and retries are disabled.
|
135
|
+
# @option options [Boolean] :validate_params (true)
|
136
|
+
# When `true`, request parameters are validated before
|
137
|
+
# sending the request.
|
138
|
+
def initialize(*args)
|
139
|
+
super
|
140
|
+
end
|
141
|
+
|
142
|
+
# @!group API Operations
|
143
|
+
|
144
|
+
# Returns the number of closed workflow executions within the given
|
145
|
+
# domain that meet the specified filtering criteria.
|
146
|
+
#
|
147
|
+
# <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
148
|
+
#
|
149
|
+
# **Access Control**
|
150
|
+
#
|
151
|
+
# You can use IAM policies to control this action's access to Amazon
|
152
|
+
# SWF resources as follows:
|
153
|
+
#
|
154
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
155
|
+
# only specified domains.
|
156
|
+
# * Use an `Action` element to allow or deny permission to call this
|
157
|
+
# action.
|
158
|
+
# * Constrain the following parameters by using a `Condition` element
|
159
|
+
# with the appropriate keys.
|
160
|
+
# * `tagFilter.tag`\: String constraint. The key is
|
161
|
+
# `swf:tagFilter.tag`.
|
162
|
+
# * `typeFilter.name`\: String constraint. The key is
|
163
|
+
# `swf:typeFilter.name`.
|
164
|
+
# * `typeFilter.version`\: String constraint. The key is
|
165
|
+
# `swf:typeFilter.version`.
|
166
|
+
#
|
167
|
+
# If the caller does not have sufficient permissions to invoke the
|
168
|
+
# action, or the parameter values fall outside the specified
|
169
|
+
# constraints, the action fails. The associated event attribute's
|
170
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
171
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
172
|
+
# Amazon SWF Workflows][1].
|
173
|
+
#
|
174
|
+
#
|
175
|
+
#
|
176
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
177
|
+
# @option params [required, String] :domain
|
178
|
+
# The name of the domain containing the workflow executions to count.
|
179
|
+
# @option params [Types::ExecutionTimeFilter] :start_time_filter
|
180
|
+
# If specified, only workflow executions that meet the start time
|
181
|
+
# criteria of the filter are counted.
|
182
|
+
#
|
183
|
+
# <note>`startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.</note>
|
184
|
+
# @option params [Types::ExecutionTimeFilter] :close_time_filter
|
185
|
+
# If specified, only workflow executions that meet the close time
|
186
|
+
# criteria of the filter are counted.
|
187
|
+
#
|
188
|
+
# <note>`startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.</note>
|
189
|
+
# @option params [Types::WorkflowExecutionFilter] :execution_filter
|
190
|
+
# If specified, only workflow executions matching the `WorkflowId` in
|
191
|
+
# the filter are counted.
|
192
|
+
#
|
193
|
+
# <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
194
|
+
# @option params [Types::WorkflowTypeFilter] :type_filter
|
195
|
+
# If specified, indicates the type of the workflow executions to be
|
196
|
+
# counted.
|
197
|
+
#
|
198
|
+
# <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
199
|
+
# @option params [Types::TagFilter] :tag_filter
|
200
|
+
# If specified, only executions that have a tag that matches the filter
|
201
|
+
# are counted.
|
202
|
+
#
|
203
|
+
# <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
204
|
+
# @option params [Types::CloseStatusFilter] :close_status_filter
|
205
|
+
# If specified, only workflow executions that match this close status
|
206
|
+
# are counted. This filter has an affect only if `executionStatus` is
|
207
|
+
# specified as `CLOSED`.
|
208
|
+
#
|
209
|
+
# <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
210
|
+
# @return [Types::WorkflowExecutionCount] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
211
|
+
#
|
212
|
+
# * {Types::WorkflowExecutionCount#count #count} => Integer
|
213
|
+
# * {Types::WorkflowExecutionCount#truncated #truncated} => Boolean
|
214
|
+
#
|
215
|
+
# @example Request syntax with placeholder values
|
216
|
+
# resp = client.count_closed_workflow_executions({
|
217
|
+
# domain: "DomainName", # required
|
218
|
+
# start_time_filter: {
|
219
|
+
# oldest_date: Time.now, # required
|
220
|
+
# latest_date: Time.now,
|
221
|
+
# },
|
222
|
+
# close_time_filter: {
|
223
|
+
# oldest_date: Time.now, # required
|
224
|
+
# latest_date: Time.now,
|
225
|
+
# },
|
226
|
+
# execution_filter: {
|
227
|
+
# workflow_id: "WorkflowId", # required
|
228
|
+
# },
|
229
|
+
# type_filter: {
|
230
|
+
# name: "Name", # required
|
231
|
+
# version: "VersionOptional",
|
232
|
+
# },
|
233
|
+
# tag_filter: {
|
234
|
+
# tag: "Tag", # required
|
235
|
+
# },
|
236
|
+
# close_status_filter: {
|
237
|
+
# status: "COMPLETED", # required, accepts COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
|
238
|
+
# },
|
239
|
+
# })
|
240
|
+
#
|
241
|
+
# @example Response structure
|
242
|
+
# resp.count #=> Integer
|
243
|
+
# resp.truncated #=> Boolean
|
244
|
+
# @overload count_closed_workflow_executions(params = {})
|
245
|
+
# @param [Hash] params ({})
|
246
|
+
def count_closed_workflow_executions(params = {}, options = {})
|
247
|
+
req = build_request(:count_closed_workflow_executions, params)
|
248
|
+
req.send_request(options)
|
249
|
+
end
|
250
|
+
|
251
|
+
# Returns the number of open workflow executions within the given domain
|
252
|
+
# that meet the specified filtering criteria.
|
253
|
+
#
|
254
|
+
# <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
255
|
+
#
|
256
|
+
# **Access Control**
|
257
|
+
#
|
258
|
+
# You can use IAM policies to control this action's access to Amazon
|
259
|
+
# SWF resources as follows:
|
260
|
+
#
|
261
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
262
|
+
# only specified domains.
|
263
|
+
# * Use an `Action` element to allow or deny permission to call this
|
264
|
+
# action.
|
265
|
+
# * Constrain the following parameters by using a `Condition` element
|
266
|
+
# with the appropriate keys.
|
267
|
+
# * `tagFilter.tag`\: String constraint. The key is
|
268
|
+
# `swf:tagFilter.tag`.
|
269
|
+
# * `typeFilter.name`\: String constraint. The key is
|
270
|
+
# `swf:typeFilter.name`.
|
271
|
+
# * `typeFilter.version`\: String constraint. The key is
|
272
|
+
# `swf:typeFilter.version`.
|
273
|
+
#
|
274
|
+
# If the caller does not have sufficient permissions to invoke the
|
275
|
+
# action, or the parameter values fall outside the specified
|
276
|
+
# constraints, the action fails. The associated event attribute's
|
277
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
278
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
279
|
+
# Amazon SWF Workflows][1].
|
280
|
+
#
|
281
|
+
#
|
282
|
+
#
|
283
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
284
|
+
# @option params [required, String] :domain
|
285
|
+
# The name of the domain containing the workflow executions to count.
|
286
|
+
# @option params [required, Types::ExecutionTimeFilter] :start_time_filter
|
287
|
+
# Specifies the start time criteria that workflow executions must meet
|
288
|
+
# in order to be counted.
|
289
|
+
# @option params [Types::WorkflowTypeFilter] :type_filter
|
290
|
+
# Specifies the type of the workflow executions to be counted.
|
291
|
+
#
|
292
|
+
# <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
293
|
+
# @option params [Types::TagFilter] :tag_filter
|
294
|
+
# If specified, only executions that have a tag that matches the filter
|
295
|
+
# are counted.
|
296
|
+
#
|
297
|
+
# <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
298
|
+
# @option params [Types::WorkflowExecutionFilter] :execution_filter
|
299
|
+
# If specified, only workflow executions matching the `WorkflowId` in
|
300
|
+
# the filter are counted.
|
301
|
+
#
|
302
|
+
# <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
303
|
+
# @return [Types::WorkflowExecutionCount] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
304
|
+
#
|
305
|
+
# * {Types::WorkflowExecutionCount#count #count} => Integer
|
306
|
+
# * {Types::WorkflowExecutionCount#truncated #truncated} => Boolean
|
307
|
+
#
|
308
|
+
# @example Request syntax with placeholder values
|
309
|
+
# resp = client.count_open_workflow_executions({
|
310
|
+
# domain: "DomainName", # required
|
311
|
+
# start_time_filter: { # required
|
312
|
+
# oldest_date: Time.now, # required
|
313
|
+
# latest_date: Time.now,
|
314
|
+
# },
|
315
|
+
# type_filter: {
|
316
|
+
# name: "Name", # required
|
317
|
+
# version: "VersionOptional",
|
318
|
+
# },
|
319
|
+
# tag_filter: {
|
320
|
+
# tag: "Tag", # required
|
321
|
+
# },
|
322
|
+
# execution_filter: {
|
323
|
+
# workflow_id: "WorkflowId", # required
|
324
|
+
# },
|
325
|
+
# })
|
326
|
+
#
|
327
|
+
# @example Response structure
|
328
|
+
# resp.count #=> Integer
|
329
|
+
# resp.truncated #=> Boolean
|
330
|
+
# @overload count_open_workflow_executions(params = {})
|
331
|
+
# @param [Hash] params ({})
|
332
|
+
def count_open_workflow_executions(params = {}, options = {})
|
333
|
+
req = build_request(:count_open_workflow_executions, params)
|
334
|
+
req.send_request(options)
|
335
|
+
end
|
336
|
+
|
337
|
+
# Returns the estimated number of activity tasks in the specified task
|
338
|
+
# list. The count returned is an approximation and is not guaranteed to
|
339
|
+
# be exact. If you specify a task list that no activity task was ever
|
340
|
+
# scheduled in then 0 will be returned.
|
341
|
+
#
|
342
|
+
# **Access Control**
|
343
|
+
#
|
344
|
+
# You can use IAM policies to control this action's access to Amazon
|
345
|
+
# SWF resources as follows:
|
346
|
+
#
|
347
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
348
|
+
# only specified domains.
|
349
|
+
# * Use an `Action` element to allow or deny permission to call this
|
350
|
+
# action.
|
351
|
+
# * Constrain the `taskList.name` parameter by using a **Condition**
|
352
|
+
# element with the `swf:taskList.name` key to allow the action to
|
353
|
+
# access only certain task lists.
|
354
|
+
#
|
355
|
+
# If the caller does not have sufficient permissions to invoke the
|
356
|
+
# action, or the parameter values fall outside the specified
|
357
|
+
# constraints, the action fails. The associated event attribute's
|
358
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
359
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
360
|
+
# Amazon SWF Workflows][1].
|
361
|
+
#
|
362
|
+
#
|
363
|
+
#
|
364
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
365
|
+
# @option params [required, String] :domain
|
366
|
+
# The name of the domain that contains the task list.
|
367
|
+
# @option params [required, Types::TaskList] :task_list
|
368
|
+
# The name of the task list.
|
369
|
+
# @return [Types::PendingTaskCount] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
370
|
+
#
|
371
|
+
# * {Types::PendingTaskCount#count #count} => Integer
|
372
|
+
# * {Types::PendingTaskCount#truncated #truncated} => Boolean
|
373
|
+
#
|
374
|
+
# @example Request syntax with placeholder values
|
375
|
+
# resp = client.count_pending_activity_tasks({
|
376
|
+
# domain: "DomainName", # required
|
377
|
+
# task_list: { # required
|
378
|
+
# name: "Name", # required
|
379
|
+
# },
|
380
|
+
# })
|
381
|
+
#
|
382
|
+
# @example Response structure
|
383
|
+
# resp.count #=> Integer
|
384
|
+
# resp.truncated #=> Boolean
|
385
|
+
# @overload count_pending_activity_tasks(params = {})
|
386
|
+
# @param [Hash] params ({})
|
387
|
+
def count_pending_activity_tasks(params = {}, options = {})
|
388
|
+
req = build_request(:count_pending_activity_tasks, params)
|
389
|
+
req.send_request(options)
|
390
|
+
end
|
391
|
+
|
392
|
+
# Returns the estimated number of decision tasks in the specified task
|
393
|
+
# list. The count returned is an approximation and is not guaranteed to
|
394
|
+
# be exact. If you specify a task list that no decision task was ever
|
395
|
+
# scheduled in then 0 will be returned.
|
396
|
+
#
|
397
|
+
# **Access Control**
|
398
|
+
#
|
399
|
+
# You can use IAM policies to control this action's access to Amazon
|
400
|
+
# SWF resources as follows:
|
401
|
+
#
|
402
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
403
|
+
# only specified domains.
|
404
|
+
# * Use an `Action` element to allow or deny permission to call this
|
405
|
+
# action.
|
406
|
+
# * Constrain the `taskList.name` parameter by using a **Condition**
|
407
|
+
# element with the `swf:taskList.name` key to allow the action to
|
408
|
+
# access only certain task lists.
|
409
|
+
#
|
410
|
+
# If the caller does not have sufficient permissions to invoke the
|
411
|
+
# action, or the parameter values fall outside the specified
|
412
|
+
# constraints, the action fails. The associated event attribute's
|
413
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
414
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
415
|
+
# Amazon SWF Workflows][1].
|
416
|
+
#
|
417
|
+
#
|
418
|
+
#
|
419
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
420
|
+
# @option params [required, String] :domain
|
421
|
+
# The name of the domain that contains the task list.
|
422
|
+
# @option params [required, Types::TaskList] :task_list
|
423
|
+
# The name of the task list.
|
424
|
+
# @return [Types::PendingTaskCount] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
425
|
+
#
|
426
|
+
# * {Types::PendingTaskCount#count #count} => Integer
|
427
|
+
# * {Types::PendingTaskCount#truncated #truncated} => Boolean
|
428
|
+
#
|
429
|
+
# @example Request syntax with placeholder values
|
430
|
+
# resp = client.count_pending_decision_tasks({
|
431
|
+
# domain: "DomainName", # required
|
432
|
+
# task_list: { # required
|
433
|
+
# name: "Name", # required
|
434
|
+
# },
|
435
|
+
# })
|
436
|
+
#
|
437
|
+
# @example Response structure
|
438
|
+
# resp.count #=> Integer
|
439
|
+
# resp.truncated #=> Boolean
|
440
|
+
# @overload count_pending_decision_tasks(params = {})
|
441
|
+
# @param [Hash] params ({})
|
442
|
+
def count_pending_decision_tasks(params = {}, options = {})
|
443
|
+
req = build_request(:count_pending_decision_tasks, params)
|
444
|
+
req.send_request(options)
|
445
|
+
end
|
446
|
+
|
447
|
+
# Deprecates the specified *activity type*. After an activity type has
|
448
|
+
# been deprecated, you cannot create new tasks of that activity type.
|
449
|
+
# Tasks of this type that were scheduled before the type was deprecated
|
450
|
+
# will continue to run.
|
451
|
+
#
|
452
|
+
# <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
453
|
+
#
|
454
|
+
# **Access Control**
|
455
|
+
#
|
456
|
+
# You can use IAM policies to control this action's access to Amazon
|
457
|
+
# SWF resources as follows:
|
458
|
+
#
|
459
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
460
|
+
# only specified domains.
|
461
|
+
# * Use an `Action` element to allow or deny permission to call this
|
462
|
+
# action.
|
463
|
+
# * Constrain the following parameters by using a `Condition` element
|
464
|
+
# with the appropriate keys.
|
465
|
+
# * `activityType.name`\: String constraint. The key is
|
466
|
+
# `swf:activityType.name`.
|
467
|
+
# * `activityType.version`\: String constraint. The key is
|
468
|
+
# `swf:activityType.version`.
|
469
|
+
#
|
470
|
+
# If the caller does not have sufficient permissions to invoke the
|
471
|
+
# action, or the parameter values fall outside the specified
|
472
|
+
# constraints, the action fails. The associated event attribute's
|
473
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
474
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
475
|
+
# Amazon SWF Workflows][1].
|
476
|
+
#
|
477
|
+
#
|
478
|
+
#
|
479
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
480
|
+
# @option params [required, String] :domain
|
481
|
+
# The name of the domain in which the activity type is registered.
|
482
|
+
# @option params [required, Types::ActivityType] :activity_type
|
483
|
+
# The activity type to deprecate.
|
484
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
485
|
+
#
|
486
|
+
# @example Request syntax with placeholder values
|
487
|
+
# resp = client.deprecate_activity_type({
|
488
|
+
# domain: "DomainName", # required
|
489
|
+
# activity_type: { # required
|
490
|
+
# name: "Name", # required
|
491
|
+
# version: "Version", # required
|
492
|
+
# },
|
493
|
+
# })
|
494
|
+
# @overload deprecate_activity_type(params = {})
|
495
|
+
# @param [Hash] params ({})
|
496
|
+
def deprecate_activity_type(params = {}, options = {})
|
497
|
+
req = build_request(:deprecate_activity_type, params)
|
498
|
+
req.send_request(options)
|
499
|
+
end
|
500
|
+
|
501
|
+
# Deprecates the specified domain. After a domain has been deprecated it
|
502
|
+
# cannot be used to create new workflow executions or register new
|
503
|
+
# types. However, you can still use visibility actions on this domain.
|
504
|
+
# Deprecating a domain also deprecates all activity and workflow types
|
505
|
+
# registered in the domain. Executions that were started before the
|
506
|
+
# domain was deprecated will continue to run.
|
507
|
+
#
|
508
|
+
# <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
509
|
+
#
|
510
|
+
# **Access Control**
|
511
|
+
#
|
512
|
+
# You can use IAM policies to control this action's access to Amazon
|
513
|
+
# SWF resources as follows:
|
514
|
+
#
|
515
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
516
|
+
# only specified domains.
|
517
|
+
# * Use an `Action` element to allow or deny permission to call this
|
518
|
+
# action.
|
519
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
520
|
+
#
|
521
|
+
# If the caller does not have sufficient permissions to invoke the
|
522
|
+
# action, or the parameter values fall outside the specified
|
523
|
+
# constraints, the action fails. The associated event attribute's
|
524
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
525
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
526
|
+
# Amazon SWF Workflows][1].
|
527
|
+
#
|
528
|
+
#
|
529
|
+
#
|
530
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
531
|
+
# @option params [required, String] :name
|
532
|
+
# The name of the domain to deprecate.
|
533
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
534
|
+
#
|
535
|
+
# @example Request syntax with placeholder values
|
536
|
+
# resp = client.deprecate_domain({
|
537
|
+
# name: "DomainName", # required
|
538
|
+
# })
|
539
|
+
# @overload deprecate_domain(params = {})
|
540
|
+
# @param [Hash] params ({})
|
541
|
+
def deprecate_domain(params = {}, options = {})
|
542
|
+
req = build_request(:deprecate_domain, params)
|
543
|
+
req.send_request(options)
|
544
|
+
end
|
545
|
+
|
546
|
+
# Deprecates the specified *workflow type*. After a workflow type has
|
547
|
+
# been deprecated, you cannot create new executions of that type.
|
548
|
+
# Executions that were started before the type was deprecated will
|
549
|
+
# continue to run. A deprecated workflow type may still be used when
|
550
|
+
# calling visibility actions.
|
551
|
+
#
|
552
|
+
# <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
553
|
+
#
|
554
|
+
# **Access Control**
|
555
|
+
#
|
556
|
+
# You can use IAM policies to control this action's access to Amazon
|
557
|
+
# SWF resources as follows:
|
558
|
+
#
|
559
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
560
|
+
# only specified domains.
|
561
|
+
# * Use an `Action` element to allow or deny permission to call this
|
562
|
+
# action.
|
563
|
+
# * Constrain the following parameters by using a `Condition` element
|
564
|
+
# with the appropriate keys.
|
565
|
+
# * `workflowType.name`\: String constraint. The key is
|
566
|
+
# `swf:workflowType.name`.
|
567
|
+
# * `workflowType.version`\: String constraint. The key is
|
568
|
+
# `swf:workflowType.version`.
|
569
|
+
#
|
570
|
+
# If the caller does not have sufficient permissions to invoke the
|
571
|
+
# action, or the parameter values fall outside the specified
|
572
|
+
# constraints, the action fails. The associated event attribute's
|
573
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
574
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
575
|
+
# Amazon SWF Workflows][1].
|
576
|
+
#
|
577
|
+
#
|
578
|
+
#
|
579
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
580
|
+
# @option params [required, String] :domain
|
581
|
+
# The name of the domain in which the workflow type is registered.
|
582
|
+
# @option params [required, Types::WorkflowType] :workflow_type
|
583
|
+
# The workflow type to deprecate.
|
584
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
585
|
+
#
|
586
|
+
# @example Request syntax with placeholder values
|
587
|
+
# resp = client.deprecate_workflow_type({
|
588
|
+
# domain: "DomainName", # required
|
589
|
+
# workflow_type: { # required
|
590
|
+
# name: "Name", # required
|
591
|
+
# version: "Version", # required
|
592
|
+
# },
|
593
|
+
# })
|
594
|
+
# @overload deprecate_workflow_type(params = {})
|
595
|
+
# @param [Hash] params ({})
|
596
|
+
def deprecate_workflow_type(params = {}, options = {})
|
597
|
+
req = build_request(:deprecate_workflow_type, params)
|
598
|
+
req.send_request(options)
|
599
|
+
end
|
600
|
+
|
601
|
+
# Returns information about the specified activity type. This includes
|
602
|
+
# configuration settings provided when the type was registered and other
|
603
|
+
# general information about the type.
|
604
|
+
#
|
605
|
+
# **Access Control**
|
606
|
+
#
|
607
|
+
# You can use IAM policies to control this action's access to Amazon
|
608
|
+
# SWF resources as follows:
|
609
|
+
#
|
610
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
611
|
+
# only specified domains.
|
612
|
+
# * Use an `Action` element to allow or deny permission to call this
|
613
|
+
# action.
|
614
|
+
# * Constrain the following parameters by using a `Condition` element
|
615
|
+
# with the appropriate keys.
|
616
|
+
# * `activityType.name`\: String constraint. The key is
|
617
|
+
# `swf:activityType.name`.
|
618
|
+
# * `activityType.version`\: String constraint. The key is
|
619
|
+
# `swf:activityType.version`.
|
620
|
+
#
|
621
|
+
# If the caller does not have sufficient permissions to invoke the
|
622
|
+
# action, or the parameter values fall outside the specified
|
623
|
+
# constraints, the action fails. The associated event attribute's
|
624
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
625
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
626
|
+
# Amazon SWF Workflows][1].
|
627
|
+
#
|
628
|
+
#
|
629
|
+
#
|
630
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
631
|
+
# @option params [required, String] :domain
|
632
|
+
# The name of the domain in which the activity type is registered.
|
633
|
+
# @option params [required, Types::ActivityType] :activity_type
|
634
|
+
# The activity type to get information about. Activity types are
|
635
|
+
# identified by the `name` and `version` that were supplied when the
|
636
|
+
# activity was registered.
|
637
|
+
# @return [Types::ActivityTypeDetail] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
638
|
+
#
|
639
|
+
# * {Types::ActivityTypeDetail#type_info #typeInfo} => Types::ActivityTypeInfo
|
640
|
+
# * {Types::ActivityTypeDetail#configuration #configuration} => Types::ActivityTypeConfiguration
|
641
|
+
#
|
642
|
+
# @example Request syntax with placeholder values
|
643
|
+
# resp = client.describe_activity_type({
|
644
|
+
# domain: "DomainName", # required
|
645
|
+
# activity_type: { # required
|
646
|
+
# name: "Name", # required
|
647
|
+
# version: "Version", # required
|
648
|
+
# },
|
649
|
+
# })
|
650
|
+
#
|
651
|
+
# @example Response structure
|
652
|
+
# resp.type_info.activity_type.name #=> String
|
653
|
+
# resp.type_info.activity_type.version #=> String
|
654
|
+
# resp.type_info.status #=> String, one of "REGISTERED", "DEPRECATED"
|
655
|
+
# resp.type_info.description #=> String
|
656
|
+
# resp.type_info.creation_date #=> Time
|
657
|
+
# resp.type_info.deprecation_date #=> Time
|
658
|
+
# resp.configuration.default_task_start_to_close_timeout #=> String
|
659
|
+
# resp.configuration.default_task_heartbeat_timeout #=> String
|
660
|
+
# resp.configuration.default_task_list.name #=> String
|
661
|
+
# resp.configuration.default_task_priority #=> String
|
662
|
+
# resp.configuration.default_task_schedule_to_start_timeout #=> String
|
663
|
+
# resp.configuration.default_task_schedule_to_close_timeout #=> String
|
664
|
+
# @overload describe_activity_type(params = {})
|
665
|
+
# @param [Hash] params ({})
|
666
|
+
def describe_activity_type(params = {}, options = {})
|
667
|
+
req = build_request(:describe_activity_type, params)
|
668
|
+
req.send_request(options)
|
669
|
+
end
|
670
|
+
|
671
|
+
# Returns information about the specified domain, including description
|
672
|
+
# and status.
|
673
|
+
#
|
674
|
+
# **Access Control**
|
675
|
+
#
|
676
|
+
# You can use IAM policies to control this action's access to Amazon
|
677
|
+
# SWF resources as follows:
|
678
|
+
#
|
679
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
680
|
+
# only specified domains.
|
681
|
+
# * Use an `Action` element to allow or deny permission to call this
|
682
|
+
# action.
|
683
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
684
|
+
#
|
685
|
+
# If the caller does not have sufficient permissions to invoke the
|
686
|
+
# action, or the parameter values fall outside the specified
|
687
|
+
# constraints, the action fails. The associated event attribute's
|
688
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
689
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
690
|
+
# Amazon SWF Workflows][1].
|
691
|
+
#
|
692
|
+
#
|
693
|
+
#
|
694
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
695
|
+
# @option params [required, String] :name
|
696
|
+
# The name of the domain to describe.
|
697
|
+
# @return [Types::DomainDetail] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
698
|
+
#
|
699
|
+
# * {Types::DomainDetail#domain_info #domainInfo} => Types::DomainInfo
|
700
|
+
# * {Types::DomainDetail#configuration #configuration} => Types::DomainConfiguration
|
701
|
+
#
|
702
|
+
# @example Request syntax with placeholder values
|
703
|
+
# resp = client.describe_domain({
|
704
|
+
# name: "DomainName", # required
|
705
|
+
# })
|
706
|
+
#
|
707
|
+
# @example Response structure
|
708
|
+
# resp.domain_info.name #=> String
|
709
|
+
# resp.domain_info.status #=> String, one of "REGISTERED", "DEPRECATED"
|
710
|
+
# resp.domain_info.description #=> String
|
711
|
+
# resp.configuration.workflow_execution_retention_period_in_days #=> String
|
712
|
+
# @overload describe_domain(params = {})
|
713
|
+
# @param [Hash] params ({})
|
714
|
+
def describe_domain(params = {}, options = {})
|
715
|
+
req = build_request(:describe_domain, params)
|
716
|
+
req.send_request(options)
|
717
|
+
end
|
718
|
+
|
719
|
+
# Returns information about the specified workflow execution including
|
720
|
+
# its type and some statistics.
|
721
|
+
#
|
722
|
+
# <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
723
|
+
#
|
724
|
+
# **Access Control**
|
725
|
+
#
|
726
|
+
# You can use IAM policies to control this action's access to Amazon
|
727
|
+
# SWF resources as follows:
|
728
|
+
#
|
729
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
730
|
+
# only specified domains.
|
731
|
+
# * Use an `Action` element to allow or deny permission to call this
|
732
|
+
# action.
|
733
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
734
|
+
#
|
735
|
+
# If the caller does not have sufficient permissions to invoke the
|
736
|
+
# action, or the parameter values fall outside the specified
|
737
|
+
# constraints, the action fails. The associated event attribute's
|
738
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
739
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
740
|
+
# Amazon SWF Workflows][1].
|
741
|
+
#
|
742
|
+
#
|
743
|
+
#
|
744
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
745
|
+
# @option params [required, String] :domain
|
746
|
+
# The name of the domain containing the workflow execution.
|
747
|
+
# @option params [required, Types::WorkflowExecution] :execution
|
748
|
+
# The workflow execution to describe.
|
749
|
+
# @return [Types::WorkflowExecutionDetail] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
750
|
+
#
|
751
|
+
# * {Types::WorkflowExecutionDetail#execution_info #executionInfo} => Types::WorkflowExecutionInfo
|
752
|
+
# * {Types::WorkflowExecutionDetail#execution_configuration #executionConfiguration} => Types::WorkflowExecutionConfiguration
|
753
|
+
# * {Types::WorkflowExecutionDetail#open_counts #openCounts} => Types::WorkflowExecutionOpenCounts
|
754
|
+
# * {Types::WorkflowExecutionDetail#latest_activity_task_timestamp #latestActivityTaskTimestamp} => Time
|
755
|
+
# * {Types::WorkflowExecutionDetail#latest_execution_context #latestExecutionContext} => String
|
756
|
+
#
|
757
|
+
# @example Request syntax with placeholder values
|
758
|
+
# resp = client.describe_workflow_execution({
|
759
|
+
# domain: "DomainName", # required
|
760
|
+
# execution: { # required
|
761
|
+
# workflow_id: "WorkflowId", # required
|
762
|
+
# run_id: "RunId", # required
|
763
|
+
# },
|
764
|
+
# })
|
765
|
+
#
|
766
|
+
# @example Response structure
|
767
|
+
# resp.execution_info.execution.workflow_id #=> String
|
768
|
+
# resp.execution_info.execution.run_id #=> String
|
769
|
+
# resp.execution_info.workflow_type.name #=> String
|
770
|
+
# resp.execution_info.workflow_type.version #=> String
|
771
|
+
# resp.execution_info.start_timestamp #=> Time
|
772
|
+
# resp.execution_info.close_timestamp #=> Time
|
773
|
+
# resp.execution_info.execution_status #=> String, one of "OPEN", "CLOSED"
|
774
|
+
# resp.execution_info.close_status #=> String, one of "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT"
|
775
|
+
# resp.execution_info.parent.workflow_id #=> String
|
776
|
+
# resp.execution_info.parent.run_id #=> String
|
777
|
+
# resp.execution_info.tag_list #=> Array
|
778
|
+
# resp.execution_info.tag_list[0] #=> String
|
779
|
+
# resp.execution_info.cancel_requested #=> Boolean
|
780
|
+
# resp.execution_configuration.task_start_to_close_timeout #=> String
|
781
|
+
# resp.execution_configuration.execution_start_to_close_timeout #=> String
|
782
|
+
# resp.execution_configuration.task_list.name #=> String
|
783
|
+
# resp.execution_configuration.task_priority #=> String
|
784
|
+
# resp.execution_configuration.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
785
|
+
# resp.execution_configuration.lambda_role #=> String
|
786
|
+
# resp.open_counts.open_activity_tasks #=> Integer
|
787
|
+
# resp.open_counts.open_decision_tasks #=> Integer
|
788
|
+
# resp.open_counts.open_timers #=> Integer
|
789
|
+
# resp.open_counts.open_child_workflow_executions #=> Integer
|
790
|
+
# resp.open_counts.open_lambda_functions #=> Integer
|
791
|
+
# resp.latest_activity_task_timestamp #=> Time
|
792
|
+
# resp.latest_execution_context #=> String
|
793
|
+
# @overload describe_workflow_execution(params = {})
|
794
|
+
# @param [Hash] params ({})
|
795
|
+
def describe_workflow_execution(params = {}, options = {})
|
796
|
+
req = build_request(:describe_workflow_execution, params)
|
797
|
+
req.send_request(options)
|
798
|
+
end
|
799
|
+
|
800
|
+
# Returns information about the specified *workflow type*. This includes
|
801
|
+
# configuration settings specified when the type was registered and
|
802
|
+
# other information such as creation date, current status, and so on.
|
803
|
+
#
|
804
|
+
# **Access Control**
|
805
|
+
#
|
806
|
+
# You can use IAM policies to control this action's access to Amazon
|
807
|
+
# SWF resources as follows:
|
808
|
+
#
|
809
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
810
|
+
# only specified domains.
|
811
|
+
# * Use an `Action` element to allow or deny permission to call this
|
812
|
+
# action.
|
813
|
+
# * Constrain the following parameters by using a `Condition` element
|
814
|
+
# with the appropriate keys.
|
815
|
+
# * `workflowType.name`\: String constraint. The key is
|
816
|
+
# `swf:workflowType.name`.
|
817
|
+
# * `workflowType.version`\: String constraint. The key is
|
818
|
+
# `swf:workflowType.version`.
|
819
|
+
#
|
820
|
+
# If the caller does not have sufficient permissions to invoke the
|
821
|
+
# action, or the parameter values fall outside the specified
|
822
|
+
# constraints, the action fails. The associated event attribute's
|
823
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
824
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
825
|
+
# Amazon SWF Workflows][1].
|
826
|
+
#
|
827
|
+
#
|
828
|
+
#
|
829
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
830
|
+
# @option params [required, String] :domain
|
831
|
+
# The name of the domain in which this workflow type is registered.
|
832
|
+
# @option params [required, Types::WorkflowType] :workflow_type
|
833
|
+
# The workflow type to describe.
|
834
|
+
# @return [Types::WorkflowTypeDetail] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
835
|
+
#
|
836
|
+
# * {Types::WorkflowTypeDetail#type_info #typeInfo} => Types::WorkflowTypeInfo
|
837
|
+
# * {Types::WorkflowTypeDetail#configuration #configuration} => Types::WorkflowTypeConfiguration
|
838
|
+
#
|
839
|
+
# @example Request syntax with placeholder values
|
840
|
+
# resp = client.describe_workflow_type({
|
841
|
+
# domain: "DomainName", # required
|
842
|
+
# workflow_type: { # required
|
843
|
+
# name: "Name", # required
|
844
|
+
# version: "Version", # required
|
845
|
+
# },
|
846
|
+
# })
|
847
|
+
#
|
848
|
+
# @example Response structure
|
849
|
+
# resp.type_info.workflow_type.name #=> String
|
850
|
+
# resp.type_info.workflow_type.version #=> String
|
851
|
+
# resp.type_info.status #=> String, one of "REGISTERED", "DEPRECATED"
|
852
|
+
# resp.type_info.description #=> String
|
853
|
+
# resp.type_info.creation_date #=> Time
|
854
|
+
# resp.type_info.deprecation_date #=> Time
|
855
|
+
# resp.configuration.default_task_start_to_close_timeout #=> String
|
856
|
+
# resp.configuration.default_execution_start_to_close_timeout #=> String
|
857
|
+
# resp.configuration.default_task_list.name #=> String
|
858
|
+
# resp.configuration.default_task_priority #=> String
|
859
|
+
# resp.configuration.default_child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
860
|
+
# resp.configuration.default_lambda_role #=> String
|
861
|
+
# @overload describe_workflow_type(params = {})
|
862
|
+
# @param [Hash] params ({})
|
863
|
+
def describe_workflow_type(params = {}, options = {})
|
864
|
+
req = build_request(:describe_workflow_type, params)
|
865
|
+
req.send_request(options)
|
866
|
+
end
|
867
|
+
|
868
|
+
# Returns the history of the specified workflow execution. The results
|
869
|
+
# may be split into multiple pages. To retrieve subsequent pages, make
|
870
|
+
# the call again using the `nextPageToken` returned by the initial call.
|
871
|
+
#
|
872
|
+
# <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
873
|
+
#
|
874
|
+
# **Access Control**
|
875
|
+
#
|
876
|
+
# You can use IAM policies to control this action's access to Amazon
|
877
|
+
# SWF resources as follows:
|
878
|
+
#
|
879
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
880
|
+
# only specified domains.
|
881
|
+
# * Use an `Action` element to allow or deny permission to call this
|
882
|
+
# action.
|
883
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
884
|
+
#
|
885
|
+
# If the caller does not have sufficient permissions to invoke the
|
886
|
+
# action, or the parameter values fall outside the specified
|
887
|
+
# constraints, the action fails. The associated event attribute's
|
888
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
889
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
890
|
+
# Amazon SWF Workflows][1].
|
891
|
+
#
|
892
|
+
#
|
893
|
+
#
|
894
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
895
|
+
# @option params [required, String] :domain
|
896
|
+
# The name of the domain containing the workflow execution.
|
897
|
+
# @option params [required, Types::WorkflowExecution] :execution
|
898
|
+
# Specifies the workflow execution for which to return the history.
|
899
|
+
# @option params [String] :next_page_token
|
900
|
+
# If a `NextPageToken` was returned by a previous call, there are more
|
901
|
+
# results available. To retrieve the next page of results, make the call
|
902
|
+
# again using the returned token in `nextPageToken`. Keep all other
|
903
|
+
# arguments unchanged.
|
904
|
+
#
|
905
|
+
# The configured `maximumPageSize` determines how many results can be
|
906
|
+
# returned in a single call.
|
907
|
+
# @option params [Integer] :maximum_page_size
|
908
|
+
# The maximum number of results that will be returned per call.
|
909
|
+
# `nextPageToken` can be used to obtain futher pages of results. The
|
910
|
+
# default is 1000, which is the maximum allowed page size. You can,
|
911
|
+
# however, specify a page size *smaller* than the maximum.
|
912
|
+
#
|
913
|
+
# This is an upper limit only; the actual number of results returned per
|
914
|
+
# call may be fewer than the specified maximum.
|
915
|
+
# @option params [Boolean] :reverse_order
|
916
|
+
# When set to `true`, returns the events in reverse order. By default
|
917
|
+
# the results are returned in ascending order of the `eventTimeStamp` of
|
918
|
+
# the events.
|
919
|
+
# @return [Types::History] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
920
|
+
#
|
921
|
+
# * {Types::History#events #events} => Array<Types::HistoryEvent>
|
922
|
+
# * {Types::History#next_page_token #nextPageToken} => String
|
923
|
+
#
|
924
|
+
# @example Request syntax with placeholder values
|
925
|
+
# resp = client.get_workflow_execution_history({
|
926
|
+
# domain: "DomainName", # required
|
927
|
+
# execution: { # required
|
928
|
+
# workflow_id: "WorkflowId", # required
|
929
|
+
# run_id: "RunId", # required
|
930
|
+
# },
|
931
|
+
# next_page_token: "PageToken",
|
932
|
+
# maximum_page_size: 1,
|
933
|
+
# reverse_order: false,
|
934
|
+
# })
|
935
|
+
#
|
936
|
+
# @example Response structure
|
937
|
+
# resp.events #=> Array
|
938
|
+
# resp.events[0].event_timestamp #=> Time
|
939
|
+
# resp.events[0].event_type #=> String, one of "WorkflowExecutionStarted", "WorkflowExecutionCancelRequested", "WorkflowExecutionCompleted", "CompleteWorkflowExecutionFailed", "WorkflowExecutionFailed", "FailWorkflowExecutionFailed", "WorkflowExecutionTimedOut", "WorkflowExecutionCanceled", "CancelWorkflowExecutionFailed", "WorkflowExecutionContinuedAsNew", "ContinueAsNewWorkflowExecutionFailed", "WorkflowExecutionTerminated", "DecisionTaskScheduled", "DecisionTaskStarted", "DecisionTaskCompleted", "DecisionTaskTimedOut", "ActivityTaskScheduled", "ScheduleActivityTaskFailed", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "ActivityTaskTimedOut", "ActivityTaskCanceled", "ActivityTaskCancelRequested", "RequestCancelActivityTaskFailed", "WorkflowExecutionSignaled", "MarkerRecorded", "RecordMarkerFailed", "TimerStarted", "StartTimerFailed", "TimerFired", "TimerCanceled", "CancelTimerFailed", "StartChildWorkflowExecutionInitiated", "StartChildWorkflowExecutionFailed", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed", "ChildWorkflowExecutionTimedOut", "ChildWorkflowExecutionCanceled", "ChildWorkflowExecutionTerminated", "SignalExternalWorkflowExecutionInitiated", "SignalExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionSignaled", "RequestCancelExternalWorkflowExecutionInitiated", "RequestCancelExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionCancelRequested", "LambdaFunctionScheduled", "LambdaFunctionStarted", "LambdaFunctionCompleted", "LambdaFunctionFailed", "LambdaFunctionTimedOut", "ScheduleLambdaFunctionFailed", "StartLambdaFunctionFailed"
|
940
|
+
# resp.events[0].event_id #=> Integer
|
941
|
+
# resp.events[0].workflow_execution_started_event_attributes.input #=> String
|
942
|
+
# resp.events[0].workflow_execution_started_event_attributes.execution_start_to_close_timeout #=> String
|
943
|
+
# resp.events[0].workflow_execution_started_event_attributes.task_start_to_close_timeout #=> String
|
944
|
+
# resp.events[0].workflow_execution_started_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
945
|
+
# resp.events[0].workflow_execution_started_event_attributes.task_list.name #=> String
|
946
|
+
# resp.events[0].workflow_execution_started_event_attributes.workflow_type.name #=> String
|
947
|
+
# resp.events[0].workflow_execution_started_event_attributes.workflow_type.version #=> String
|
948
|
+
# resp.events[0].workflow_execution_started_event_attributes.tag_list #=> Array
|
949
|
+
# resp.events[0].workflow_execution_started_event_attributes.tag_list[0] #=> String
|
950
|
+
# resp.events[0].workflow_execution_started_event_attributes.task_priority #=> String
|
951
|
+
# resp.events[0].workflow_execution_started_event_attributes.continued_execution_run_id #=> String
|
952
|
+
# resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.workflow_id #=> String
|
953
|
+
# resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.run_id #=> String
|
954
|
+
# resp.events[0].workflow_execution_started_event_attributes.parent_initiated_event_id #=> Integer
|
955
|
+
# resp.events[0].workflow_execution_started_event_attributes.lambda_role #=> String
|
956
|
+
# resp.events[0].workflow_execution_completed_event_attributes.result #=> String
|
957
|
+
# resp.events[0].workflow_execution_completed_event_attributes.decision_task_completed_event_id #=> Integer
|
958
|
+
# resp.events[0].complete_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
|
959
|
+
# resp.events[0].complete_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
960
|
+
# resp.events[0].workflow_execution_failed_event_attributes.reason #=> String
|
961
|
+
# resp.events[0].workflow_execution_failed_event_attributes.details #=> String
|
962
|
+
# resp.events[0].workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
963
|
+
# resp.events[0].fail_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
|
964
|
+
# resp.events[0].fail_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
965
|
+
# resp.events[0].workflow_execution_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
|
966
|
+
# resp.events[0].workflow_execution_timed_out_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
967
|
+
# resp.events[0].workflow_execution_canceled_event_attributes.details #=> String
|
968
|
+
# resp.events[0].workflow_execution_canceled_event_attributes.decision_task_completed_event_id #=> Integer
|
969
|
+
# resp.events[0].cancel_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
|
970
|
+
# resp.events[0].cancel_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
971
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.input #=> String
|
972
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.decision_task_completed_event_id #=> Integer
|
973
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.new_execution_run_id #=> String
|
974
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.execution_start_to_close_timeout #=> String
|
975
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.task_list.name #=> String
|
976
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.task_priority #=> String
|
977
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.task_start_to_close_timeout #=> String
|
978
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
979
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.tag_list #=> Array
|
980
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.tag_list[0] #=> String
|
981
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.workflow_type.name #=> String
|
982
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.workflow_type.version #=> String
|
983
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.lambda_role #=> String
|
984
|
+
# resp.events[0].continue_as_new_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "WORKFLOW_TYPE_DEPRECATED", "WORKFLOW_TYPE_DOES_NOT_EXIST", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
|
985
|
+
# resp.events[0].continue_as_new_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
986
|
+
# resp.events[0].workflow_execution_terminated_event_attributes.reason #=> String
|
987
|
+
# resp.events[0].workflow_execution_terminated_event_attributes.details #=> String
|
988
|
+
# resp.events[0].workflow_execution_terminated_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
989
|
+
# resp.events[0].workflow_execution_terminated_event_attributes.cause #=> String, one of "CHILD_POLICY_APPLIED", "EVENT_LIMIT_EXCEEDED", "OPERATOR_INITIATED"
|
990
|
+
# resp.events[0].workflow_execution_cancel_requested_event_attributes.external_workflow_execution.workflow_id #=> String
|
991
|
+
# resp.events[0].workflow_execution_cancel_requested_event_attributes.external_workflow_execution.run_id #=> String
|
992
|
+
# resp.events[0].workflow_execution_cancel_requested_event_attributes.external_initiated_event_id #=> Integer
|
993
|
+
# resp.events[0].workflow_execution_cancel_requested_event_attributes.cause #=> String, one of "CHILD_POLICY_APPLIED"
|
994
|
+
# resp.events[0].decision_task_scheduled_event_attributes.task_list.name #=> String
|
995
|
+
# resp.events[0].decision_task_scheduled_event_attributes.task_priority #=> String
|
996
|
+
# resp.events[0].decision_task_scheduled_event_attributes.start_to_close_timeout #=> String
|
997
|
+
# resp.events[0].decision_task_started_event_attributes.identity #=> String
|
998
|
+
# resp.events[0].decision_task_started_event_attributes.scheduled_event_id #=> Integer
|
999
|
+
# resp.events[0].decision_task_completed_event_attributes.execution_context #=> String
|
1000
|
+
# resp.events[0].decision_task_completed_event_attributes.scheduled_event_id #=> Integer
|
1001
|
+
# resp.events[0].decision_task_completed_event_attributes.started_event_id #=> Integer
|
1002
|
+
# resp.events[0].decision_task_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
|
1003
|
+
# resp.events[0].decision_task_timed_out_event_attributes.scheduled_event_id #=> Integer
|
1004
|
+
# resp.events[0].decision_task_timed_out_event_attributes.started_event_id #=> Integer
|
1005
|
+
# resp.events[0].activity_task_scheduled_event_attributes.activity_type.name #=> String
|
1006
|
+
# resp.events[0].activity_task_scheduled_event_attributes.activity_type.version #=> String
|
1007
|
+
# resp.events[0].activity_task_scheduled_event_attributes.activity_id #=> String
|
1008
|
+
# resp.events[0].activity_task_scheduled_event_attributes.input #=> String
|
1009
|
+
# resp.events[0].activity_task_scheduled_event_attributes.control #=> String
|
1010
|
+
# resp.events[0].activity_task_scheduled_event_attributes.schedule_to_start_timeout #=> String
|
1011
|
+
# resp.events[0].activity_task_scheduled_event_attributes.schedule_to_close_timeout #=> String
|
1012
|
+
# resp.events[0].activity_task_scheduled_event_attributes.start_to_close_timeout #=> String
|
1013
|
+
# resp.events[0].activity_task_scheduled_event_attributes.task_list.name #=> String
|
1014
|
+
# resp.events[0].activity_task_scheduled_event_attributes.task_priority #=> String
|
1015
|
+
# resp.events[0].activity_task_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
|
1016
|
+
# resp.events[0].activity_task_scheduled_event_attributes.heartbeat_timeout #=> String
|
1017
|
+
# resp.events[0].activity_task_started_event_attributes.identity #=> String
|
1018
|
+
# resp.events[0].activity_task_started_event_attributes.scheduled_event_id #=> Integer
|
1019
|
+
# resp.events[0].activity_task_completed_event_attributes.result #=> String
|
1020
|
+
# resp.events[0].activity_task_completed_event_attributes.scheduled_event_id #=> Integer
|
1021
|
+
# resp.events[0].activity_task_completed_event_attributes.started_event_id #=> Integer
|
1022
|
+
# resp.events[0].activity_task_failed_event_attributes.reason #=> String
|
1023
|
+
# resp.events[0].activity_task_failed_event_attributes.details #=> String
|
1024
|
+
# resp.events[0].activity_task_failed_event_attributes.scheduled_event_id #=> Integer
|
1025
|
+
# resp.events[0].activity_task_failed_event_attributes.started_event_id #=> Integer
|
1026
|
+
# resp.events[0].activity_task_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE", "SCHEDULE_TO_START", "SCHEDULE_TO_CLOSE", "HEARTBEAT"
|
1027
|
+
# resp.events[0].activity_task_timed_out_event_attributes.scheduled_event_id #=> Integer
|
1028
|
+
# resp.events[0].activity_task_timed_out_event_attributes.started_event_id #=> Integer
|
1029
|
+
# resp.events[0].activity_task_timed_out_event_attributes.details #=> String
|
1030
|
+
# resp.events[0].activity_task_canceled_event_attributes.details #=> String
|
1031
|
+
# resp.events[0].activity_task_canceled_event_attributes.scheduled_event_id #=> Integer
|
1032
|
+
# resp.events[0].activity_task_canceled_event_attributes.started_event_id #=> Integer
|
1033
|
+
# resp.events[0].activity_task_canceled_event_attributes.latest_cancel_requested_event_id #=> Integer
|
1034
|
+
# resp.events[0].activity_task_cancel_requested_event_attributes.decision_task_completed_event_id #=> Integer
|
1035
|
+
# resp.events[0].activity_task_cancel_requested_event_attributes.activity_id #=> String
|
1036
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.signal_name #=> String
|
1037
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.input #=> String
|
1038
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.external_workflow_execution.workflow_id #=> String
|
1039
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.external_workflow_execution.run_id #=> String
|
1040
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.external_initiated_event_id #=> Integer
|
1041
|
+
# resp.events[0].marker_recorded_event_attributes.marker_name #=> String
|
1042
|
+
# resp.events[0].marker_recorded_event_attributes.details #=> String
|
1043
|
+
# resp.events[0].marker_recorded_event_attributes.decision_task_completed_event_id #=> Integer
|
1044
|
+
# resp.events[0].record_marker_failed_event_attributes.marker_name #=> String
|
1045
|
+
# resp.events[0].record_marker_failed_event_attributes.cause #=> String, one of "OPERATION_NOT_PERMITTED"
|
1046
|
+
# resp.events[0].record_marker_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1047
|
+
# resp.events[0].timer_started_event_attributes.timer_id #=> String
|
1048
|
+
# resp.events[0].timer_started_event_attributes.control #=> String
|
1049
|
+
# resp.events[0].timer_started_event_attributes.start_to_fire_timeout #=> String
|
1050
|
+
# resp.events[0].timer_started_event_attributes.decision_task_completed_event_id #=> Integer
|
1051
|
+
# resp.events[0].timer_fired_event_attributes.timer_id #=> String
|
1052
|
+
# resp.events[0].timer_fired_event_attributes.started_event_id #=> Integer
|
1053
|
+
# resp.events[0].timer_canceled_event_attributes.timer_id #=> String
|
1054
|
+
# resp.events[0].timer_canceled_event_attributes.started_event_id #=> Integer
|
1055
|
+
# resp.events[0].timer_canceled_event_attributes.decision_task_completed_event_id #=> Integer
|
1056
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_id #=> String
|
1057
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_type.name #=> String
|
1058
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_type.version #=> String
|
1059
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.control #=> String
|
1060
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.input #=> String
|
1061
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.execution_start_to_close_timeout #=> String
|
1062
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_list.name #=> String
|
1063
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_priority #=> String
|
1064
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
|
1065
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
1066
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_start_to_close_timeout #=> String
|
1067
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.tag_list #=> Array
|
1068
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.tag_list[0] #=> String
|
1069
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.lambda_role #=> String
|
1070
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.workflow_execution.workflow_id #=> String
|
1071
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.workflow_execution.run_id #=> String
|
1072
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.workflow_type.name #=> String
|
1073
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.workflow_type.version #=> String
|
1074
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.initiated_event_id #=> Integer
|
1075
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.workflow_execution.workflow_id #=> String
|
1076
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.workflow_execution.run_id #=> String
|
1077
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.workflow_type.name #=> String
|
1078
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.workflow_type.version #=> String
|
1079
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.result #=> String
|
1080
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.initiated_event_id #=> Integer
|
1081
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.started_event_id #=> Integer
|
1082
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.workflow_execution.workflow_id #=> String
|
1083
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.workflow_execution.run_id #=> String
|
1084
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.workflow_type.name #=> String
|
1085
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.workflow_type.version #=> String
|
1086
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.reason #=> String
|
1087
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.details #=> String
|
1088
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
|
1089
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.started_event_id #=> Integer
|
1090
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_execution.workflow_id #=> String
|
1091
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_execution.run_id #=> String
|
1092
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_type.name #=> String
|
1093
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_type.version #=> String
|
1094
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
|
1095
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.initiated_event_id #=> Integer
|
1096
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.started_event_id #=> Integer
|
1097
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_execution.workflow_id #=> String
|
1098
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_execution.run_id #=> String
|
1099
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_type.name #=> String
|
1100
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_type.version #=> String
|
1101
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.details #=> String
|
1102
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.initiated_event_id #=> Integer
|
1103
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.started_event_id #=> Integer
|
1104
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_execution.workflow_id #=> String
|
1105
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_execution.run_id #=> String
|
1106
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_type.name #=> String
|
1107
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_type.version #=> String
|
1108
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.initiated_event_id #=> Integer
|
1109
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.started_event_id #=> Integer
|
1110
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.workflow_id #=> String
|
1111
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.run_id #=> String
|
1112
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.signal_name #=> String
|
1113
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.input #=> String
|
1114
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
|
1115
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.control #=> String
|
1116
|
+
# resp.events[0].external_workflow_execution_signaled_event_attributes.workflow_execution.workflow_id #=> String
|
1117
|
+
# resp.events[0].external_workflow_execution_signaled_event_attributes.workflow_execution.run_id #=> String
|
1118
|
+
# resp.events[0].external_workflow_execution_signaled_event_attributes.initiated_event_id #=> Integer
|
1119
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.workflow_id #=> String
|
1120
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.run_id #=> String
|
1121
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.cause #=> String, one of "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
|
1122
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
|
1123
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1124
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.control #=> String
|
1125
|
+
# resp.events[0].external_workflow_execution_cancel_requested_event_attributes.workflow_execution.workflow_id #=> String
|
1126
|
+
# resp.events[0].external_workflow_execution_cancel_requested_event_attributes.workflow_execution.run_id #=> String
|
1127
|
+
# resp.events[0].external_workflow_execution_cancel_requested_event_attributes.initiated_event_id #=> Integer
|
1128
|
+
# resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.workflow_id #=> String
|
1129
|
+
# resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.run_id #=> String
|
1130
|
+
# resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
|
1131
|
+
# resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.control #=> String
|
1132
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.workflow_id #=> String
|
1133
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.run_id #=> String
|
1134
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.cause #=> String, one of "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
|
1135
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
|
1136
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1137
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.control #=> String
|
1138
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.activity_type.name #=> String
|
1139
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.activity_type.version #=> String
|
1140
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.activity_id #=> String
|
1141
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.cause #=> String, one of "ACTIVITY_TYPE_DEPRECATED", "ACTIVITY_TYPE_DOES_NOT_EXIST", "ACTIVITY_ID_ALREADY_IN_USE", "OPEN_ACTIVITIES_LIMIT_EXCEEDED", "ACTIVITY_CREATION_RATE_EXCEEDED", "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", "OPERATION_NOT_PERMITTED"
|
1142
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1143
|
+
# resp.events[0].request_cancel_activity_task_failed_event_attributes.activity_id #=> String
|
1144
|
+
# resp.events[0].request_cancel_activity_task_failed_event_attributes.cause #=> String, one of "ACTIVITY_ID_UNKNOWN", "OPERATION_NOT_PERMITTED"
|
1145
|
+
# resp.events[0].request_cancel_activity_task_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1146
|
+
# resp.events[0].start_timer_failed_event_attributes.timer_id #=> String
|
1147
|
+
# resp.events[0].start_timer_failed_event_attributes.cause #=> String, one of "TIMER_ID_ALREADY_IN_USE", "OPEN_TIMERS_LIMIT_EXCEEDED", "TIMER_CREATION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
|
1148
|
+
# resp.events[0].start_timer_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1149
|
+
# resp.events[0].cancel_timer_failed_event_attributes.timer_id #=> String
|
1150
|
+
# resp.events[0].cancel_timer_failed_event_attributes.cause #=> String, one of "TIMER_ID_UNKNOWN", "OPERATION_NOT_PERMITTED"
|
1151
|
+
# resp.events[0].cancel_timer_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1152
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_type.name #=> String
|
1153
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_type.version #=> String
|
1154
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.cause #=> String, one of "WORKFLOW_TYPE_DOES_NOT_EXIST", "WORKFLOW_TYPE_DEPRECATED", "OPEN_CHILDREN_LIMIT_EXCEEDED", "OPEN_WORKFLOWS_LIMIT_EXCEEDED", "CHILD_CREATION_RATE_EXCEEDED", "WORKFLOW_ALREADY_RUNNING", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "OPERATION_NOT_PERMITTED"
|
1155
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_id #=> String
|
1156
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
|
1157
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1158
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.control #=> String
|
1159
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.id #=> String
|
1160
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.name #=> String
|
1161
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.input #=> String
|
1162
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.start_to_close_timeout #=> String
|
1163
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
|
1164
|
+
# resp.events[0].lambda_function_started_event_attributes.scheduled_event_id #=> Integer
|
1165
|
+
# resp.events[0].lambda_function_completed_event_attributes.scheduled_event_id #=> Integer
|
1166
|
+
# resp.events[0].lambda_function_completed_event_attributes.started_event_id #=> Integer
|
1167
|
+
# resp.events[0].lambda_function_completed_event_attributes.result #=> String
|
1168
|
+
# resp.events[0].lambda_function_failed_event_attributes.scheduled_event_id #=> Integer
|
1169
|
+
# resp.events[0].lambda_function_failed_event_attributes.started_event_id #=> Integer
|
1170
|
+
# resp.events[0].lambda_function_failed_event_attributes.reason #=> String
|
1171
|
+
# resp.events[0].lambda_function_failed_event_attributes.details #=> String
|
1172
|
+
# resp.events[0].lambda_function_timed_out_event_attributes.scheduled_event_id #=> Integer
|
1173
|
+
# resp.events[0].lambda_function_timed_out_event_attributes.started_event_id #=> Integer
|
1174
|
+
# resp.events[0].lambda_function_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
|
1175
|
+
# resp.events[0].schedule_lambda_function_failed_event_attributes.id #=> String
|
1176
|
+
# resp.events[0].schedule_lambda_function_failed_event_attributes.name #=> String
|
1177
|
+
# resp.events[0].schedule_lambda_function_failed_event_attributes.cause #=> String, one of "ID_ALREADY_IN_USE", "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED", "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED", "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"
|
1178
|
+
# resp.events[0].schedule_lambda_function_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1179
|
+
# resp.events[0].start_lambda_function_failed_event_attributes.scheduled_event_id #=> Integer
|
1180
|
+
# resp.events[0].start_lambda_function_failed_event_attributes.cause #=> String, one of "ASSUME_ROLE_FAILED"
|
1181
|
+
# resp.events[0].start_lambda_function_failed_event_attributes.message #=> String
|
1182
|
+
# resp.next_page_token #=> String
|
1183
|
+
# @overload get_workflow_execution_history(params = {})
|
1184
|
+
# @param [Hash] params ({})
|
1185
|
+
def get_workflow_execution_history(params = {}, options = {})
|
1186
|
+
req = build_request(:get_workflow_execution_history, params)
|
1187
|
+
req.send_request(options)
|
1188
|
+
end
|
1189
|
+
|
1190
|
+
# Returns information about all activities registered in the specified
|
1191
|
+
# domain that match the specified name and registration status. The
|
1192
|
+
# result includes information like creation date, current status of the
|
1193
|
+
# activity, etc. The results may be split into multiple pages. To
|
1194
|
+
# retrieve subsequent pages, make the call again using the
|
1195
|
+
# `nextPageToken` returned by the initial call.
|
1196
|
+
#
|
1197
|
+
# **Access Control**
|
1198
|
+
#
|
1199
|
+
# You can use IAM policies to control this action's access to Amazon
|
1200
|
+
# SWF resources as follows:
|
1201
|
+
#
|
1202
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
1203
|
+
# only specified domains.
|
1204
|
+
# * Use an `Action` element to allow or deny permission to call this
|
1205
|
+
# action.
|
1206
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
1207
|
+
#
|
1208
|
+
# If the caller does not have sufficient permissions to invoke the
|
1209
|
+
# action, or the parameter values fall outside the specified
|
1210
|
+
# constraints, the action fails. The associated event attribute's
|
1211
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
1212
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
1213
|
+
# Amazon SWF Workflows][1].
|
1214
|
+
#
|
1215
|
+
#
|
1216
|
+
#
|
1217
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
1218
|
+
# @option params [required, String] :domain
|
1219
|
+
# The name of the domain in which the activity types have been
|
1220
|
+
# registered.
|
1221
|
+
# @option params [String] :name
|
1222
|
+
# If specified, only lists the activity types that have this name.
|
1223
|
+
# @option params [required, String] :registration_status
|
1224
|
+
# Specifies the registration status of the activity types to list.
|
1225
|
+
# @option params [String] :next_page_token
|
1226
|
+
# If a `NextPageToken` was returned by a previous call, there are more
|
1227
|
+
# results available. To retrieve the next page of results, make the call
|
1228
|
+
# again using the returned token in `nextPageToken`. Keep all other
|
1229
|
+
# arguments unchanged.
|
1230
|
+
#
|
1231
|
+
# The configured `maximumPageSize` determines how many results can be
|
1232
|
+
# returned in a single call.
|
1233
|
+
# @option params [Integer] :maximum_page_size
|
1234
|
+
# The maximum number of results that will be returned per call.
|
1235
|
+
# `nextPageToken` can be used to obtain futher pages of results. The
|
1236
|
+
# default is 1000, which is the maximum allowed page size. You can,
|
1237
|
+
# however, specify a page size *smaller* than the maximum.
|
1238
|
+
#
|
1239
|
+
# This is an upper limit only; the actual number of results returned per
|
1240
|
+
# call may be fewer than the specified maximum.
|
1241
|
+
# @option params [Boolean] :reverse_order
|
1242
|
+
# When set to `true`, returns the results in reverse order. By default,
|
1243
|
+
# the results are returned in ascending alphabetical order by `name` of
|
1244
|
+
# the activity types.
|
1245
|
+
# @return [Types::ActivityTypeInfos] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1246
|
+
#
|
1247
|
+
# * {Types::ActivityTypeInfos#type_infos #typeInfos} => Array<Types::ActivityTypeInfo>
|
1248
|
+
# * {Types::ActivityTypeInfos#next_page_token #nextPageToken} => String
|
1249
|
+
#
|
1250
|
+
# @example Request syntax with placeholder values
|
1251
|
+
# resp = client.list_activity_types({
|
1252
|
+
# domain: "DomainName", # required
|
1253
|
+
# name: "Name",
|
1254
|
+
# registration_status: "REGISTERED", # required, accepts REGISTERED, DEPRECATED
|
1255
|
+
# next_page_token: "PageToken",
|
1256
|
+
# maximum_page_size: 1,
|
1257
|
+
# reverse_order: false,
|
1258
|
+
# })
|
1259
|
+
#
|
1260
|
+
# @example Response structure
|
1261
|
+
# resp.type_infos #=> Array
|
1262
|
+
# resp.type_infos[0].activity_type.name #=> String
|
1263
|
+
# resp.type_infos[0].activity_type.version #=> String
|
1264
|
+
# resp.type_infos[0].status #=> String, one of "REGISTERED", "DEPRECATED"
|
1265
|
+
# resp.type_infos[0].description #=> String
|
1266
|
+
# resp.type_infos[0].creation_date #=> Time
|
1267
|
+
# resp.type_infos[0].deprecation_date #=> Time
|
1268
|
+
# resp.next_page_token #=> String
|
1269
|
+
# @overload list_activity_types(params = {})
|
1270
|
+
# @param [Hash] params ({})
|
1271
|
+
def list_activity_types(params = {}, options = {})
|
1272
|
+
req = build_request(:list_activity_types, params)
|
1273
|
+
req.send_request(options)
|
1274
|
+
end
|
1275
|
+
|
1276
|
+
# Returns a list of closed workflow executions in the specified domain
|
1277
|
+
# that meet the filtering criteria. The results may be split into
|
1278
|
+
# multiple pages. To retrieve subsequent pages, make the call again
|
1279
|
+
# using the nextPageToken returned by the initial call.
|
1280
|
+
#
|
1281
|
+
# <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
1282
|
+
#
|
1283
|
+
# **Access Control**
|
1284
|
+
#
|
1285
|
+
# You can use IAM policies to control this action's access to Amazon
|
1286
|
+
# SWF resources as follows:
|
1287
|
+
#
|
1288
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
1289
|
+
# only specified domains.
|
1290
|
+
# * Use an `Action` element to allow or deny permission to call this
|
1291
|
+
# action.
|
1292
|
+
# * Constrain the following parameters by using a `Condition` element
|
1293
|
+
# with the appropriate keys.
|
1294
|
+
# * `tagFilter.tag`\: String constraint. The key is
|
1295
|
+
# `swf:tagFilter.tag`.
|
1296
|
+
# * `typeFilter.name`\: String constraint. The key is
|
1297
|
+
# `swf:typeFilter.name`.
|
1298
|
+
# * `typeFilter.version`\: String constraint. The key is
|
1299
|
+
# `swf:typeFilter.version`.
|
1300
|
+
#
|
1301
|
+
# If the caller does not have sufficient permissions to invoke the
|
1302
|
+
# action, or the parameter values fall outside the specified
|
1303
|
+
# constraints, the action fails. The associated event attribute's
|
1304
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
1305
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
1306
|
+
# Amazon SWF Workflows][1].
|
1307
|
+
#
|
1308
|
+
#
|
1309
|
+
#
|
1310
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
1311
|
+
# @option params [required, String] :domain
|
1312
|
+
# The name of the domain that contains the workflow executions to list.
|
1313
|
+
# @option params [Types::ExecutionTimeFilter] :start_time_filter
|
1314
|
+
# If specified, the workflow executions are included in the returned
|
1315
|
+
# results based on whether their start times are within the range
|
1316
|
+
# specified by this filter. Also, if this parameter is specified, the
|
1317
|
+
# returned results are ordered by their start times.
|
1318
|
+
#
|
1319
|
+
# <note>`startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.</note>
|
1320
|
+
# @option params [Types::ExecutionTimeFilter] :close_time_filter
|
1321
|
+
# If specified, the workflow executions are included in the returned
|
1322
|
+
# results based on whether their close times are within the range
|
1323
|
+
# specified by this filter. Also, if this parameter is specified, the
|
1324
|
+
# returned results are ordered by their close times.
|
1325
|
+
#
|
1326
|
+
# <note>`startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.</note>
|
1327
|
+
# @option params [Types::WorkflowExecutionFilter] :execution_filter
|
1328
|
+
# If specified, only workflow executions matching the workflow ID
|
1329
|
+
# specified in the filter are returned.
|
1330
|
+
#
|
1331
|
+
# <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
1332
|
+
# @option params [Types::CloseStatusFilter] :close_status_filter
|
1333
|
+
# If specified, only workflow executions that match this *close status*
|
1334
|
+
# are listed. For example, if TERMINATED is specified, then only
|
1335
|
+
# TERMINATED workflow executions are listed.
|
1336
|
+
#
|
1337
|
+
# <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
1338
|
+
# @option params [Types::WorkflowTypeFilter] :type_filter
|
1339
|
+
# If specified, only executions of the type specified in the filter are
|
1340
|
+
# returned.
|
1341
|
+
#
|
1342
|
+
# <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
1343
|
+
# @option params [Types::TagFilter] :tag_filter
|
1344
|
+
# If specified, only executions that have the matching tag are listed.
|
1345
|
+
#
|
1346
|
+
# <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
1347
|
+
# @option params [String] :next_page_token
|
1348
|
+
# If a `NextPageToken` was returned by a previous call, there are more
|
1349
|
+
# results available. To retrieve the next page of results, make the call
|
1350
|
+
# again using the returned token in `nextPageToken`. Keep all other
|
1351
|
+
# arguments unchanged.
|
1352
|
+
#
|
1353
|
+
# The configured `maximumPageSize` determines how many results can be
|
1354
|
+
# returned in a single call.
|
1355
|
+
# @option params [Integer] :maximum_page_size
|
1356
|
+
# The maximum number of results that will be returned per call.
|
1357
|
+
# `nextPageToken` can be used to obtain futher pages of results. The
|
1358
|
+
# default is 1000, which is the maximum allowed page size. You can,
|
1359
|
+
# however, specify a page size *smaller* than the maximum.
|
1360
|
+
#
|
1361
|
+
# This is an upper limit only; the actual number of results returned per
|
1362
|
+
# call may be fewer than the specified maximum.
|
1363
|
+
# @option params [Boolean] :reverse_order
|
1364
|
+
# When set to `true`, returns the results in reverse order. By default
|
1365
|
+
# the results are returned in descending order of the start or the close
|
1366
|
+
# time of the executions.
|
1367
|
+
# @return [Types::WorkflowExecutionInfos] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1368
|
+
#
|
1369
|
+
# * {Types::WorkflowExecutionInfos#execution_infos #executionInfos} => Array<Types::WorkflowExecutionInfo>
|
1370
|
+
# * {Types::WorkflowExecutionInfos#next_page_token #nextPageToken} => String
|
1371
|
+
#
|
1372
|
+
# @example Request syntax with placeholder values
|
1373
|
+
# resp = client.list_closed_workflow_executions({
|
1374
|
+
# domain: "DomainName", # required
|
1375
|
+
# start_time_filter: {
|
1376
|
+
# oldest_date: Time.now, # required
|
1377
|
+
# latest_date: Time.now,
|
1378
|
+
# },
|
1379
|
+
# close_time_filter: {
|
1380
|
+
# oldest_date: Time.now, # required
|
1381
|
+
# latest_date: Time.now,
|
1382
|
+
# },
|
1383
|
+
# execution_filter: {
|
1384
|
+
# workflow_id: "WorkflowId", # required
|
1385
|
+
# },
|
1386
|
+
# close_status_filter: {
|
1387
|
+
# status: "COMPLETED", # required, accepts COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
|
1388
|
+
# },
|
1389
|
+
# type_filter: {
|
1390
|
+
# name: "Name", # required
|
1391
|
+
# version: "VersionOptional",
|
1392
|
+
# },
|
1393
|
+
# tag_filter: {
|
1394
|
+
# tag: "Tag", # required
|
1395
|
+
# },
|
1396
|
+
# next_page_token: "PageToken",
|
1397
|
+
# maximum_page_size: 1,
|
1398
|
+
# reverse_order: false,
|
1399
|
+
# })
|
1400
|
+
#
|
1401
|
+
# @example Response structure
|
1402
|
+
# resp.execution_infos #=> Array
|
1403
|
+
# resp.execution_infos[0].execution.workflow_id #=> String
|
1404
|
+
# resp.execution_infos[0].execution.run_id #=> String
|
1405
|
+
# resp.execution_infos[0].workflow_type.name #=> String
|
1406
|
+
# resp.execution_infos[0].workflow_type.version #=> String
|
1407
|
+
# resp.execution_infos[0].start_timestamp #=> Time
|
1408
|
+
# resp.execution_infos[0].close_timestamp #=> Time
|
1409
|
+
# resp.execution_infos[0].execution_status #=> String, one of "OPEN", "CLOSED"
|
1410
|
+
# resp.execution_infos[0].close_status #=> String, one of "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT"
|
1411
|
+
# resp.execution_infos[0].parent.workflow_id #=> String
|
1412
|
+
# resp.execution_infos[0].parent.run_id #=> String
|
1413
|
+
# resp.execution_infos[0].tag_list #=> Array
|
1414
|
+
# resp.execution_infos[0].tag_list[0] #=> String
|
1415
|
+
# resp.execution_infos[0].cancel_requested #=> Boolean
|
1416
|
+
# resp.next_page_token #=> String
|
1417
|
+
# @overload list_closed_workflow_executions(params = {})
|
1418
|
+
# @param [Hash] params ({})
|
1419
|
+
def list_closed_workflow_executions(params = {}, options = {})
|
1420
|
+
req = build_request(:list_closed_workflow_executions, params)
|
1421
|
+
req.send_request(options)
|
1422
|
+
end
|
1423
|
+
|
1424
|
+
# Returns the list of domains registered in the account. The results may
|
1425
|
+
# be split into multiple pages. To retrieve subsequent pages, make the
|
1426
|
+
# call again using the nextPageToken returned by the initial call.
|
1427
|
+
#
|
1428
|
+
# <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
1429
|
+
#
|
1430
|
+
# **Access Control**
|
1431
|
+
#
|
1432
|
+
# You can use IAM policies to control this action's access to Amazon
|
1433
|
+
# SWF resources as follows:
|
1434
|
+
#
|
1435
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
1436
|
+
# only specified domains. The element must be set to
|
1437
|
+
# `arn:aws:swf::AccountID:domain/*`, where *AccountID* is the account
|
1438
|
+
# ID, with no dashes.
|
1439
|
+
# * Use an `Action` element to allow or deny permission to call this
|
1440
|
+
# action.
|
1441
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
1442
|
+
#
|
1443
|
+
# If the caller does not have sufficient permissions to invoke the
|
1444
|
+
# action, or the parameter values fall outside the specified
|
1445
|
+
# constraints, the action fails. The associated event attribute's
|
1446
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
1447
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
1448
|
+
# Amazon SWF Workflows][1].
|
1449
|
+
#
|
1450
|
+
#
|
1451
|
+
#
|
1452
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
1453
|
+
# @option params [String] :next_page_token
|
1454
|
+
# If a `NextPageToken` was returned by a previous call, there are more
|
1455
|
+
# results available. To retrieve the next page of results, make the call
|
1456
|
+
# again using the returned token in `nextPageToken`. Keep all other
|
1457
|
+
# arguments unchanged.
|
1458
|
+
#
|
1459
|
+
# The configured `maximumPageSize` determines how many results can be
|
1460
|
+
# returned in a single call.
|
1461
|
+
# @option params [required, String] :registration_status
|
1462
|
+
# Specifies the registration status of the domains to list.
|
1463
|
+
# @option params [Integer] :maximum_page_size
|
1464
|
+
# The maximum number of results that will be returned per call.
|
1465
|
+
# `nextPageToken` can be used to obtain futher pages of results. The
|
1466
|
+
# default is 1000, which is the maximum allowed page size. You can,
|
1467
|
+
# however, specify a page size *smaller* than the maximum.
|
1468
|
+
#
|
1469
|
+
# This is an upper limit only; the actual number of results returned per
|
1470
|
+
# call may be fewer than the specified maximum.
|
1471
|
+
# @option params [Boolean] :reverse_order
|
1472
|
+
# When set to `true`, returns the results in reverse order. By default,
|
1473
|
+
# the results are returned in ascending alphabetical order by `name` of
|
1474
|
+
# the domains.
|
1475
|
+
# @return [Types::DomainInfos] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1476
|
+
#
|
1477
|
+
# * {Types::DomainInfos#domain_infos #domainInfos} => Array<Types::DomainInfo>
|
1478
|
+
# * {Types::DomainInfos#next_page_token #nextPageToken} => String
|
1479
|
+
#
|
1480
|
+
# @example Request syntax with placeholder values
|
1481
|
+
# resp = client.list_domains({
|
1482
|
+
# next_page_token: "PageToken",
|
1483
|
+
# registration_status: "REGISTERED", # required, accepts REGISTERED, DEPRECATED
|
1484
|
+
# maximum_page_size: 1,
|
1485
|
+
# reverse_order: false,
|
1486
|
+
# })
|
1487
|
+
#
|
1488
|
+
# @example Response structure
|
1489
|
+
# resp.domain_infos #=> Array
|
1490
|
+
# resp.domain_infos[0].name #=> String
|
1491
|
+
# resp.domain_infos[0].status #=> String, one of "REGISTERED", "DEPRECATED"
|
1492
|
+
# resp.domain_infos[0].description #=> String
|
1493
|
+
# resp.next_page_token #=> String
|
1494
|
+
# @overload list_domains(params = {})
|
1495
|
+
# @param [Hash] params ({})
|
1496
|
+
def list_domains(params = {}, options = {})
|
1497
|
+
req = build_request(:list_domains, params)
|
1498
|
+
req.send_request(options)
|
1499
|
+
end
|
1500
|
+
|
1501
|
+
# Returns a list of open workflow executions in the specified domain
|
1502
|
+
# that meet the filtering criteria. The results may be split into
|
1503
|
+
# multiple pages. To retrieve subsequent pages, make the call again
|
1504
|
+
# using the nextPageToken returned by the initial call.
|
1505
|
+
#
|
1506
|
+
# <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
|
1507
|
+
#
|
1508
|
+
# **Access Control**
|
1509
|
+
#
|
1510
|
+
# You can use IAM policies to control this action's access to Amazon
|
1511
|
+
# SWF resources as follows:
|
1512
|
+
#
|
1513
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
1514
|
+
# only specified domains.
|
1515
|
+
# * Use an `Action` element to allow or deny permission to call this
|
1516
|
+
# action.
|
1517
|
+
# * Constrain the following parameters by using a `Condition` element
|
1518
|
+
# with the appropriate keys.
|
1519
|
+
# * `tagFilter.tag`\: String constraint. The key is
|
1520
|
+
# `swf:tagFilter.tag`.
|
1521
|
+
# * `typeFilter.name`\: String constraint. The key is
|
1522
|
+
# `swf:typeFilter.name`.
|
1523
|
+
# * `typeFilter.version`\: String constraint. The key is
|
1524
|
+
# `swf:typeFilter.version`.
|
1525
|
+
#
|
1526
|
+
# If the caller does not have sufficient permissions to invoke the
|
1527
|
+
# action, or the parameter values fall outside the specified
|
1528
|
+
# constraints, the action fails. The associated event attribute's
|
1529
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
1530
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
1531
|
+
# Amazon SWF Workflows][1].
|
1532
|
+
#
|
1533
|
+
#
|
1534
|
+
#
|
1535
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
1536
|
+
# @option params [required, String] :domain
|
1537
|
+
# The name of the domain that contains the workflow executions to list.
|
1538
|
+
# @option params [required, Types::ExecutionTimeFilter] :start_time_filter
|
1539
|
+
# Workflow executions are included in the returned results based on
|
1540
|
+
# whether their start times are within the range specified by this
|
1541
|
+
# filter.
|
1542
|
+
# @option params [Types::WorkflowTypeFilter] :type_filter
|
1543
|
+
# If specified, only executions of the type specified in the filter are
|
1544
|
+
# returned.
|
1545
|
+
#
|
1546
|
+
# <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
1547
|
+
# @option params [Types::TagFilter] :tag_filter
|
1548
|
+
# If specified, only executions that have the matching tag are listed.
|
1549
|
+
#
|
1550
|
+
# <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
1551
|
+
# @option params [String] :next_page_token
|
1552
|
+
# If a `NextPageToken` was returned by a previous call, there are more
|
1553
|
+
# results available. To retrieve the next page of results, make the call
|
1554
|
+
# again using the returned token in `nextPageToken`. Keep all other
|
1555
|
+
# arguments unchanged.
|
1556
|
+
#
|
1557
|
+
# The configured `maximumPageSize` determines how many results can be
|
1558
|
+
# returned in a single call.
|
1559
|
+
# @option params [Integer] :maximum_page_size
|
1560
|
+
# The maximum number of results that will be returned per call.
|
1561
|
+
# `nextPageToken` can be used to obtain futher pages of results. The
|
1562
|
+
# default is 1000, which is the maximum allowed page size. You can,
|
1563
|
+
# however, specify a page size *smaller* than the maximum.
|
1564
|
+
#
|
1565
|
+
# This is an upper limit only; the actual number of results returned per
|
1566
|
+
# call may be fewer than the specified maximum.
|
1567
|
+
# @option params [Boolean] :reverse_order
|
1568
|
+
# When set to `true`, returns the results in reverse order. By default
|
1569
|
+
# the results are returned in descending order of the start time of the
|
1570
|
+
# executions.
|
1571
|
+
# @option params [Types::WorkflowExecutionFilter] :execution_filter
|
1572
|
+
# If specified, only workflow executions matching the workflow ID
|
1573
|
+
# specified in the filter are returned.
|
1574
|
+
#
|
1575
|
+
# <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
|
1576
|
+
# @return [Types::WorkflowExecutionInfos] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1577
|
+
#
|
1578
|
+
# * {Types::WorkflowExecutionInfos#execution_infos #executionInfos} => Array<Types::WorkflowExecutionInfo>
|
1579
|
+
# * {Types::WorkflowExecutionInfos#next_page_token #nextPageToken} => String
|
1580
|
+
#
|
1581
|
+
# @example Request syntax with placeholder values
|
1582
|
+
# resp = client.list_open_workflow_executions({
|
1583
|
+
# domain: "DomainName", # required
|
1584
|
+
# start_time_filter: { # required
|
1585
|
+
# oldest_date: Time.now, # required
|
1586
|
+
# latest_date: Time.now,
|
1587
|
+
# },
|
1588
|
+
# type_filter: {
|
1589
|
+
# name: "Name", # required
|
1590
|
+
# version: "VersionOptional",
|
1591
|
+
# },
|
1592
|
+
# tag_filter: {
|
1593
|
+
# tag: "Tag", # required
|
1594
|
+
# },
|
1595
|
+
# next_page_token: "PageToken",
|
1596
|
+
# maximum_page_size: 1,
|
1597
|
+
# reverse_order: false,
|
1598
|
+
# execution_filter: {
|
1599
|
+
# workflow_id: "WorkflowId", # required
|
1600
|
+
# },
|
1601
|
+
# })
|
1602
|
+
#
|
1603
|
+
# @example Response structure
|
1604
|
+
# resp.execution_infos #=> Array
|
1605
|
+
# resp.execution_infos[0].execution.workflow_id #=> String
|
1606
|
+
# resp.execution_infos[0].execution.run_id #=> String
|
1607
|
+
# resp.execution_infos[0].workflow_type.name #=> String
|
1608
|
+
# resp.execution_infos[0].workflow_type.version #=> String
|
1609
|
+
# resp.execution_infos[0].start_timestamp #=> Time
|
1610
|
+
# resp.execution_infos[0].close_timestamp #=> Time
|
1611
|
+
# resp.execution_infos[0].execution_status #=> String, one of "OPEN", "CLOSED"
|
1612
|
+
# resp.execution_infos[0].close_status #=> String, one of "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT"
|
1613
|
+
# resp.execution_infos[0].parent.workflow_id #=> String
|
1614
|
+
# resp.execution_infos[0].parent.run_id #=> String
|
1615
|
+
# resp.execution_infos[0].tag_list #=> Array
|
1616
|
+
# resp.execution_infos[0].tag_list[0] #=> String
|
1617
|
+
# resp.execution_infos[0].cancel_requested #=> Boolean
|
1618
|
+
# resp.next_page_token #=> String
|
1619
|
+
# @overload list_open_workflow_executions(params = {})
|
1620
|
+
# @param [Hash] params ({})
|
1621
|
+
def list_open_workflow_executions(params = {}, options = {})
|
1622
|
+
req = build_request(:list_open_workflow_executions, params)
|
1623
|
+
req.send_request(options)
|
1624
|
+
end
|
1625
|
+
|
1626
|
+
# Returns information about workflow types in the specified domain. The
|
1627
|
+
# results may be split into multiple pages that can be retrieved by
|
1628
|
+
# making the call repeatedly.
|
1629
|
+
#
|
1630
|
+
# **Access Control**
|
1631
|
+
#
|
1632
|
+
# You can use IAM policies to control this action's access to Amazon
|
1633
|
+
# SWF resources as follows:
|
1634
|
+
#
|
1635
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
1636
|
+
# only specified domains.
|
1637
|
+
# * Use an `Action` element to allow or deny permission to call this
|
1638
|
+
# action.
|
1639
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
1640
|
+
#
|
1641
|
+
# If the caller does not have sufficient permissions to invoke the
|
1642
|
+
# action, or the parameter values fall outside the specified
|
1643
|
+
# constraints, the action fails. The associated event attribute's
|
1644
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
1645
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
1646
|
+
# Amazon SWF Workflows][1].
|
1647
|
+
#
|
1648
|
+
#
|
1649
|
+
#
|
1650
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
1651
|
+
# @option params [required, String] :domain
|
1652
|
+
# The name of the domain in which the workflow types have been
|
1653
|
+
# registered.
|
1654
|
+
# @option params [String] :name
|
1655
|
+
# If specified, lists the workflow type with this name.
|
1656
|
+
# @option params [required, String] :registration_status
|
1657
|
+
# Specifies the registration status of the workflow types to list.
|
1658
|
+
# @option params [String] :next_page_token
|
1659
|
+
# If a `NextPageToken` was returned by a previous call, there are more
|
1660
|
+
# results available. To retrieve the next page of results, make the call
|
1661
|
+
# again using the returned token in `nextPageToken`. Keep all other
|
1662
|
+
# arguments unchanged.
|
1663
|
+
#
|
1664
|
+
# The configured `maximumPageSize` determines how many results can be
|
1665
|
+
# returned in a single call.
|
1666
|
+
# @option params [Integer] :maximum_page_size
|
1667
|
+
# The maximum number of results that will be returned per call.
|
1668
|
+
# `nextPageToken` can be used to obtain futher pages of results. The
|
1669
|
+
# default is 1000, which is the maximum allowed page size. You can,
|
1670
|
+
# however, specify a page size *smaller* than the maximum.
|
1671
|
+
#
|
1672
|
+
# This is an upper limit only; the actual number of results returned per
|
1673
|
+
# call may be fewer than the specified maximum.
|
1674
|
+
# @option params [Boolean] :reverse_order
|
1675
|
+
# When set to `true`, returns the results in reverse order. By default
|
1676
|
+
# the results are returned in ascending alphabetical order of the `name`
|
1677
|
+
# of the workflow types.
|
1678
|
+
# @return [Types::WorkflowTypeInfos] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1679
|
+
#
|
1680
|
+
# * {Types::WorkflowTypeInfos#type_infos #typeInfos} => Array<Types::WorkflowTypeInfo>
|
1681
|
+
# * {Types::WorkflowTypeInfos#next_page_token #nextPageToken} => String
|
1682
|
+
#
|
1683
|
+
# @example Request syntax with placeholder values
|
1684
|
+
# resp = client.list_workflow_types({
|
1685
|
+
# domain: "DomainName", # required
|
1686
|
+
# name: "Name",
|
1687
|
+
# registration_status: "REGISTERED", # required, accepts REGISTERED, DEPRECATED
|
1688
|
+
# next_page_token: "PageToken",
|
1689
|
+
# maximum_page_size: 1,
|
1690
|
+
# reverse_order: false,
|
1691
|
+
# })
|
1692
|
+
#
|
1693
|
+
# @example Response structure
|
1694
|
+
# resp.type_infos #=> Array
|
1695
|
+
# resp.type_infos[0].workflow_type.name #=> String
|
1696
|
+
# resp.type_infos[0].workflow_type.version #=> String
|
1697
|
+
# resp.type_infos[0].status #=> String, one of "REGISTERED", "DEPRECATED"
|
1698
|
+
# resp.type_infos[0].description #=> String
|
1699
|
+
# resp.type_infos[0].creation_date #=> Time
|
1700
|
+
# resp.type_infos[0].deprecation_date #=> Time
|
1701
|
+
# resp.next_page_token #=> String
|
1702
|
+
# @overload list_workflow_types(params = {})
|
1703
|
+
# @param [Hash] params ({})
|
1704
|
+
def list_workflow_types(params = {}, options = {})
|
1705
|
+
req = build_request(:list_workflow_types, params)
|
1706
|
+
req.send_request(options)
|
1707
|
+
end
|
1708
|
+
|
1709
|
+
# Used by workers to get an ActivityTask from the specified activity
|
1710
|
+
# `taskList`. This initiates a long poll, where the service holds the
|
1711
|
+
# HTTP connection open and responds as soon as a task becomes available.
|
1712
|
+
# The maximum time the service holds on to the request before responding
|
1713
|
+
# is 60 seconds. If no task is available within 60 seconds, the poll
|
1714
|
+
# will return an empty result. An empty result, in this context, means
|
1715
|
+
# that an ActivityTask is returned, but that the value of taskToken is
|
1716
|
+
# an empty string. If a task is returned, the worker should use its type
|
1717
|
+
# to identify and process it correctly.
|
1718
|
+
#
|
1719
|
+
# Workers should set their client side socket timeout to at least 70
|
1720
|
+
# seconds (10 seconds higher than the maximum time service may hold the
|
1721
|
+
# poll request).
|
1722
|
+
#
|
1723
|
+
# **Access Control**
|
1724
|
+
#
|
1725
|
+
# You can use IAM policies to control this action's access to Amazon
|
1726
|
+
# SWF resources as follows:
|
1727
|
+
#
|
1728
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
1729
|
+
# only specified domains.
|
1730
|
+
# * Use an `Action` element to allow or deny permission to call this
|
1731
|
+
# action.
|
1732
|
+
# * Constrain the `taskList.name` parameter by using a **Condition**
|
1733
|
+
# element with the `swf:taskList.name` key to allow the action to
|
1734
|
+
# access only certain task lists.
|
1735
|
+
#
|
1736
|
+
# If the caller does not have sufficient permissions to invoke the
|
1737
|
+
# action, or the parameter values fall outside the specified
|
1738
|
+
# constraints, the action fails. The associated event attribute's
|
1739
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
1740
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
1741
|
+
# Amazon SWF Workflows][1].
|
1742
|
+
#
|
1743
|
+
#
|
1744
|
+
#
|
1745
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
1746
|
+
# @option params [required, String] :domain
|
1747
|
+
# The name of the domain that contains the task lists being polled.
|
1748
|
+
# @option params [required, Types::TaskList] :task_list
|
1749
|
+
# Specifies the task list to poll for activity tasks.
|
1750
|
+
#
|
1751
|
+
# The specified string must not start or end with whitespace. It must
|
1752
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
1753
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
1754
|
+
# must not contain the literal string quotarnquot.
|
1755
|
+
# @option params [String] :identity
|
1756
|
+
# Identity of the worker making the request, recorded in the
|
1757
|
+
# `ActivityTaskStarted` event in the workflow history. This enables
|
1758
|
+
# diagnostic tracing when problems arise. The form of this identity is
|
1759
|
+
# user defined.
|
1760
|
+
# @return [Types::ActivityTask] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1761
|
+
#
|
1762
|
+
# * {Types::ActivityTask#task_token #taskToken} => String
|
1763
|
+
# * {Types::ActivityTask#activity_id #activityId} => String
|
1764
|
+
# * {Types::ActivityTask#started_event_id #startedEventId} => Integer
|
1765
|
+
# * {Types::ActivityTask#workflow_execution #workflowExecution} => Types::WorkflowExecution
|
1766
|
+
# * {Types::ActivityTask#activity_type #activityType} => Types::ActivityType
|
1767
|
+
# * {Types::ActivityTask#input #input} => String
|
1768
|
+
#
|
1769
|
+
# @example Request syntax with placeholder values
|
1770
|
+
# resp = client.poll_for_activity_task({
|
1771
|
+
# domain: "DomainName", # required
|
1772
|
+
# task_list: { # required
|
1773
|
+
# name: "Name", # required
|
1774
|
+
# },
|
1775
|
+
# identity: "Identity",
|
1776
|
+
# })
|
1777
|
+
#
|
1778
|
+
# @example Response structure
|
1779
|
+
# resp.task_token #=> String
|
1780
|
+
# resp.activity_id #=> String
|
1781
|
+
# resp.started_event_id #=> Integer
|
1782
|
+
# resp.workflow_execution.workflow_id #=> String
|
1783
|
+
# resp.workflow_execution.run_id #=> String
|
1784
|
+
# resp.activity_type.name #=> String
|
1785
|
+
# resp.activity_type.version #=> String
|
1786
|
+
# resp.input #=> String
|
1787
|
+
# @overload poll_for_activity_task(params = {})
|
1788
|
+
# @param [Hash] params ({})
|
1789
|
+
def poll_for_activity_task(params = {}, options = {})
|
1790
|
+
req = build_request(:poll_for_activity_task, params)
|
1791
|
+
req.send_request(options)
|
1792
|
+
end
|
1793
|
+
|
1794
|
+
# Used by deciders to get a DecisionTask from the specified decision
|
1795
|
+
# `taskList`. A decision task may be returned for any open workflow
|
1796
|
+
# execution that is using the specified task list. The task includes a
|
1797
|
+
# paginated view of the history of the workflow execution. The decider
|
1798
|
+
# should use the workflow type and the history to determine how to
|
1799
|
+
# properly handle the task.
|
1800
|
+
#
|
1801
|
+
# This action initiates a long poll, where the service holds the HTTP
|
1802
|
+
# connection open and responds as soon a task becomes available. If no
|
1803
|
+
# decision task is available in the specified task list before the
|
1804
|
+
# timeout of 60 seconds expires, an empty result is returned. An empty
|
1805
|
+
# result, in this context, means that a DecisionTask is returned, but
|
1806
|
+
# that the value of `taskToken` is an empty string.
|
1807
|
+
#
|
1808
|
+
# Deciders should set their client-side socket timeout to at least 70
|
1809
|
+
# seconds (10 seconds higher than the timeout).
|
1810
|
+
#
|
1811
|
+
# Because the number of workflow history events for a single workflow
|
1812
|
+
# execution might be very large, the result returned might be split up
|
1813
|
+
# across a number of pages. To retrieve subsequent pages, make
|
1814
|
+
# additional calls to `PollForDecisionTask` using the `nextPageToken`
|
1815
|
+
# returned by the initial call. Note that you do **not** call
|
1816
|
+
# `GetWorkflowExecutionHistory` with this `nextPageToken`. Instead, call
|
1817
|
+
# `PollForDecisionTask` again.
|
1818
|
+
#
|
1819
|
+
# **Access Control**
|
1820
|
+
#
|
1821
|
+
# You can use IAM policies to control this action's access to Amazon
|
1822
|
+
# SWF resources as follows:
|
1823
|
+
#
|
1824
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
1825
|
+
# only specified domains.
|
1826
|
+
# * Use an `Action` element to allow or deny permission to call this
|
1827
|
+
# action.
|
1828
|
+
# * Constrain the `taskList.name` parameter by using a **Condition**
|
1829
|
+
# element with the `swf:taskList.name` key to allow the action to
|
1830
|
+
# access only certain task lists.
|
1831
|
+
#
|
1832
|
+
# If the caller does not have sufficient permissions to invoke the
|
1833
|
+
# action, or the parameter values fall outside the specified
|
1834
|
+
# constraints, the action fails. The associated event attribute's
|
1835
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
1836
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
1837
|
+
# Amazon SWF Workflows][1].
|
1838
|
+
#
|
1839
|
+
#
|
1840
|
+
#
|
1841
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
1842
|
+
# @option params [required, String] :domain
|
1843
|
+
# The name of the domain containing the task lists to poll.
|
1844
|
+
# @option params [required, Types::TaskList] :task_list
|
1845
|
+
# Specifies the task list to poll for decision tasks.
|
1846
|
+
#
|
1847
|
+
# The specified string must not start or end with whitespace. It must
|
1848
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
1849
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
1850
|
+
# must not contain the literal string quotarnquot.
|
1851
|
+
# @option params [String] :identity
|
1852
|
+
# Identity of the decider making the request, which is recorded in the
|
1853
|
+
# DecisionTaskStarted event in the workflow history. This enables
|
1854
|
+
# diagnostic tracing when problems arise. The form of this identity is
|
1855
|
+
# user defined.
|
1856
|
+
# @option params [String] :next_page_token
|
1857
|
+
# If a `NextPageToken` was returned by a previous call, there are more
|
1858
|
+
# results available. To retrieve the next page of results, make the call
|
1859
|
+
# again using the returned token in `nextPageToken`. Keep all other
|
1860
|
+
# arguments unchanged.
|
1861
|
+
#
|
1862
|
+
# The configured `maximumPageSize` determines how many results can be
|
1863
|
+
# returned in a single call.
|
1864
|
+
#
|
1865
|
+
# <note>The `nextPageToken` returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the `nextPageToken`) to retrieve the next page of history records. Calling PollForDecisionTask with a `nextPageToken` will not return a new decision task.</note>
|
1866
|
+
#
|
1867
|
+
# .
|
1868
|
+
# @option params [Integer] :maximum_page_size
|
1869
|
+
# The maximum number of results that will be returned per call.
|
1870
|
+
# `nextPageToken` can be used to obtain futher pages of results. The
|
1871
|
+
# default is 1000, which is the maximum allowed page size. You can,
|
1872
|
+
# however, specify a page size *smaller* than the maximum.
|
1873
|
+
#
|
1874
|
+
# This is an upper limit only; the actual number of results returned per
|
1875
|
+
# call may be fewer than the specified maximum.
|
1876
|
+
# @option params [Boolean] :reverse_order
|
1877
|
+
# When set to `true`, returns the events in reverse order. By default
|
1878
|
+
# the results are returned in ascending order of the `eventTimestamp` of
|
1879
|
+
# the events.
|
1880
|
+
# @return [Types::DecisionTask] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1881
|
+
#
|
1882
|
+
# * {Types::DecisionTask#task_token #taskToken} => String
|
1883
|
+
# * {Types::DecisionTask#started_event_id #startedEventId} => Integer
|
1884
|
+
# * {Types::DecisionTask#workflow_execution #workflowExecution} => Types::WorkflowExecution
|
1885
|
+
# * {Types::DecisionTask#workflow_type #workflowType} => Types::WorkflowType
|
1886
|
+
# * {Types::DecisionTask#events #events} => Array<Types::HistoryEvent>
|
1887
|
+
# * {Types::DecisionTask#next_page_token #nextPageToken} => String
|
1888
|
+
# * {Types::DecisionTask#previous_started_event_id #previousStartedEventId} => Integer
|
1889
|
+
#
|
1890
|
+
# @example Request syntax with placeholder values
|
1891
|
+
# resp = client.poll_for_decision_task({
|
1892
|
+
# domain: "DomainName", # required
|
1893
|
+
# task_list: { # required
|
1894
|
+
# name: "Name", # required
|
1895
|
+
# },
|
1896
|
+
# identity: "Identity",
|
1897
|
+
# next_page_token: "PageToken",
|
1898
|
+
# maximum_page_size: 1,
|
1899
|
+
# reverse_order: false,
|
1900
|
+
# })
|
1901
|
+
#
|
1902
|
+
# @example Response structure
|
1903
|
+
# resp.task_token #=> String
|
1904
|
+
# resp.started_event_id #=> Integer
|
1905
|
+
# resp.workflow_execution.workflow_id #=> String
|
1906
|
+
# resp.workflow_execution.run_id #=> String
|
1907
|
+
# resp.workflow_type.name #=> String
|
1908
|
+
# resp.workflow_type.version #=> String
|
1909
|
+
# resp.events #=> Array
|
1910
|
+
# resp.events[0].event_timestamp #=> Time
|
1911
|
+
# resp.events[0].event_type #=> String, one of "WorkflowExecutionStarted", "WorkflowExecutionCancelRequested", "WorkflowExecutionCompleted", "CompleteWorkflowExecutionFailed", "WorkflowExecutionFailed", "FailWorkflowExecutionFailed", "WorkflowExecutionTimedOut", "WorkflowExecutionCanceled", "CancelWorkflowExecutionFailed", "WorkflowExecutionContinuedAsNew", "ContinueAsNewWorkflowExecutionFailed", "WorkflowExecutionTerminated", "DecisionTaskScheduled", "DecisionTaskStarted", "DecisionTaskCompleted", "DecisionTaskTimedOut", "ActivityTaskScheduled", "ScheduleActivityTaskFailed", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "ActivityTaskTimedOut", "ActivityTaskCanceled", "ActivityTaskCancelRequested", "RequestCancelActivityTaskFailed", "WorkflowExecutionSignaled", "MarkerRecorded", "RecordMarkerFailed", "TimerStarted", "StartTimerFailed", "TimerFired", "TimerCanceled", "CancelTimerFailed", "StartChildWorkflowExecutionInitiated", "StartChildWorkflowExecutionFailed", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed", "ChildWorkflowExecutionTimedOut", "ChildWorkflowExecutionCanceled", "ChildWorkflowExecutionTerminated", "SignalExternalWorkflowExecutionInitiated", "SignalExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionSignaled", "RequestCancelExternalWorkflowExecutionInitiated", "RequestCancelExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionCancelRequested", "LambdaFunctionScheduled", "LambdaFunctionStarted", "LambdaFunctionCompleted", "LambdaFunctionFailed", "LambdaFunctionTimedOut", "ScheduleLambdaFunctionFailed", "StartLambdaFunctionFailed"
|
1912
|
+
# resp.events[0].event_id #=> Integer
|
1913
|
+
# resp.events[0].workflow_execution_started_event_attributes.input #=> String
|
1914
|
+
# resp.events[0].workflow_execution_started_event_attributes.execution_start_to_close_timeout #=> String
|
1915
|
+
# resp.events[0].workflow_execution_started_event_attributes.task_start_to_close_timeout #=> String
|
1916
|
+
# resp.events[0].workflow_execution_started_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
1917
|
+
# resp.events[0].workflow_execution_started_event_attributes.task_list.name #=> String
|
1918
|
+
# resp.events[0].workflow_execution_started_event_attributes.workflow_type.name #=> String
|
1919
|
+
# resp.events[0].workflow_execution_started_event_attributes.workflow_type.version #=> String
|
1920
|
+
# resp.events[0].workflow_execution_started_event_attributes.tag_list #=> Array
|
1921
|
+
# resp.events[0].workflow_execution_started_event_attributes.tag_list[0] #=> String
|
1922
|
+
# resp.events[0].workflow_execution_started_event_attributes.task_priority #=> String
|
1923
|
+
# resp.events[0].workflow_execution_started_event_attributes.continued_execution_run_id #=> String
|
1924
|
+
# resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.workflow_id #=> String
|
1925
|
+
# resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.run_id #=> String
|
1926
|
+
# resp.events[0].workflow_execution_started_event_attributes.parent_initiated_event_id #=> Integer
|
1927
|
+
# resp.events[0].workflow_execution_started_event_attributes.lambda_role #=> String
|
1928
|
+
# resp.events[0].workflow_execution_completed_event_attributes.result #=> String
|
1929
|
+
# resp.events[0].workflow_execution_completed_event_attributes.decision_task_completed_event_id #=> Integer
|
1930
|
+
# resp.events[0].complete_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
|
1931
|
+
# resp.events[0].complete_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1932
|
+
# resp.events[0].workflow_execution_failed_event_attributes.reason #=> String
|
1933
|
+
# resp.events[0].workflow_execution_failed_event_attributes.details #=> String
|
1934
|
+
# resp.events[0].workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1935
|
+
# resp.events[0].fail_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
|
1936
|
+
# resp.events[0].fail_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1937
|
+
# resp.events[0].workflow_execution_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
|
1938
|
+
# resp.events[0].workflow_execution_timed_out_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
1939
|
+
# resp.events[0].workflow_execution_canceled_event_attributes.details #=> String
|
1940
|
+
# resp.events[0].workflow_execution_canceled_event_attributes.decision_task_completed_event_id #=> Integer
|
1941
|
+
# resp.events[0].cancel_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED"
|
1942
|
+
# resp.events[0].cancel_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1943
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.input #=> String
|
1944
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.decision_task_completed_event_id #=> Integer
|
1945
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.new_execution_run_id #=> String
|
1946
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.execution_start_to_close_timeout #=> String
|
1947
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.task_list.name #=> String
|
1948
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.task_priority #=> String
|
1949
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.task_start_to_close_timeout #=> String
|
1950
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
1951
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.tag_list #=> Array
|
1952
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.tag_list[0] #=> String
|
1953
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.workflow_type.name #=> String
|
1954
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.workflow_type.version #=> String
|
1955
|
+
# resp.events[0].workflow_execution_continued_as_new_event_attributes.lambda_role #=> String
|
1956
|
+
# resp.events[0].continue_as_new_workflow_execution_failed_event_attributes.cause #=> String, one of "UNHANDLED_DECISION", "WORKFLOW_TYPE_DEPRECATED", "WORKFLOW_TYPE_DOES_NOT_EXIST", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
|
1957
|
+
# resp.events[0].continue_as_new_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
1958
|
+
# resp.events[0].workflow_execution_terminated_event_attributes.reason #=> String
|
1959
|
+
# resp.events[0].workflow_execution_terminated_event_attributes.details #=> String
|
1960
|
+
# resp.events[0].workflow_execution_terminated_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
1961
|
+
# resp.events[0].workflow_execution_terminated_event_attributes.cause #=> String, one of "CHILD_POLICY_APPLIED", "EVENT_LIMIT_EXCEEDED", "OPERATOR_INITIATED"
|
1962
|
+
# resp.events[0].workflow_execution_cancel_requested_event_attributes.external_workflow_execution.workflow_id #=> String
|
1963
|
+
# resp.events[0].workflow_execution_cancel_requested_event_attributes.external_workflow_execution.run_id #=> String
|
1964
|
+
# resp.events[0].workflow_execution_cancel_requested_event_attributes.external_initiated_event_id #=> Integer
|
1965
|
+
# resp.events[0].workflow_execution_cancel_requested_event_attributes.cause #=> String, one of "CHILD_POLICY_APPLIED"
|
1966
|
+
# resp.events[0].decision_task_scheduled_event_attributes.task_list.name #=> String
|
1967
|
+
# resp.events[0].decision_task_scheduled_event_attributes.task_priority #=> String
|
1968
|
+
# resp.events[0].decision_task_scheduled_event_attributes.start_to_close_timeout #=> String
|
1969
|
+
# resp.events[0].decision_task_started_event_attributes.identity #=> String
|
1970
|
+
# resp.events[0].decision_task_started_event_attributes.scheduled_event_id #=> Integer
|
1971
|
+
# resp.events[0].decision_task_completed_event_attributes.execution_context #=> String
|
1972
|
+
# resp.events[0].decision_task_completed_event_attributes.scheduled_event_id #=> Integer
|
1973
|
+
# resp.events[0].decision_task_completed_event_attributes.started_event_id #=> Integer
|
1974
|
+
# resp.events[0].decision_task_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
|
1975
|
+
# resp.events[0].decision_task_timed_out_event_attributes.scheduled_event_id #=> Integer
|
1976
|
+
# resp.events[0].decision_task_timed_out_event_attributes.started_event_id #=> Integer
|
1977
|
+
# resp.events[0].activity_task_scheduled_event_attributes.activity_type.name #=> String
|
1978
|
+
# resp.events[0].activity_task_scheduled_event_attributes.activity_type.version #=> String
|
1979
|
+
# resp.events[0].activity_task_scheduled_event_attributes.activity_id #=> String
|
1980
|
+
# resp.events[0].activity_task_scheduled_event_attributes.input #=> String
|
1981
|
+
# resp.events[0].activity_task_scheduled_event_attributes.control #=> String
|
1982
|
+
# resp.events[0].activity_task_scheduled_event_attributes.schedule_to_start_timeout #=> String
|
1983
|
+
# resp.events[0].activity_task_scheduled_event_attributes.schedule_to_close_timeout #=> String
|
1984
|
+
# resp.events[0].activity_task_scheduled_event_attributes.start_to_close_timeout #=> String
|
1985
|
+
# resp.events[0].activity_task_scheduled_event_attributes.task_list.name #=> String
|
1986
|
+
# resp.events[0].activity_task_scheduled_event_attributes.task_priority #=> String
|
1987
|
+
# resp.events[0].activity_task_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
|
1988
|
+
# resp.events[0].activity_task_scheduled_event_attributes.heartbeat_timeout #=> String
|
1989
|
+
# resp.events[0].activity_task_started_event_attributes.identity #=> String
|
1990
|
+
# resp.events[0].activity_task_started_event_attributes.scheduled_event_id #=> Integer
|
1991
|
+
# resp.events[0].activity_task_completed_event_attributes.result #=> String
|
1992
|
+
# resp.events[0].activity_task_completed_event_attributes.scheduled_event_id #=> Integer
|
1993
|
+
# resp.events[0].activity_task_completed_event_attributes.started_event_id #=> Integer
|
1994
|
+
# resp.events[0].activity_task_failed_event_attributes.reason #=> String
|
1995
|
+
# resp.events[0].activity_task_failed_event_attributes.details #=> String
|
1996
|
+
# resp.events[0].activity_task_failed_event_attributes.scheduled_event_id #=> Integer
|
1997
|
+
# resp.events[0].activity_task_failed_event_attributes.started_event_id #=> Integer
|
1998
|
+
# resp.events[0].activity_task_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE", "SCHEDULE_TO_START", "SCHEDULE_TO_CLOSE", "HEARTBEAT"
|
1999
|
+
# resp.events[0].activity_task_timed_out_event_attributes.scheduled_event_id #=> Integer
|
2000
|
+
# resp.events[0].activity_task_timed_out_event_attributes.started_event_id #=> Integer
|
2001
|
+
# resp.events[0].activity_task_timed_out_event_attributes.details #=> String
|
2002
|
+
# resp.events[0].activity_task_canceled_event_attributes.details #=> String
|
2003
|
+
# resp.events[0].activity_task_canceled_event_attributes.scheduled_event_id #=> Integer
|
2004
|
+
# resp.events[0].activity_task_canceled_event_attributes.started_event_id #=> Integer
|
2005
|
+
# resp.events[0].activity_task_canceled_event_attributes.latest_cancel_requested_event_id #=> Integer
|
2006
|
+
# resp.events[0].activity_task_cancel_requested_event_attributes.decision_task_completed_event_id #=> Integer
|
2007
|
+
# resp.events[0].activity_task_cancel_requested_event_attributes.activity_id #=> String
|
2008
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.signal_name #=> String
|
2009
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.input #=> String
|
2010
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.external_workflow_execution.workflow_id #=> String
|
2011
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.external_workflow_execution.run_id #=> String
|
2012
|
+
# resp.events[0].workflow_execution_signaled_event_attributes.external_initiated_event_id #=> Integer
|
2013
|
+
# resp.events[0].marker_recorded_event_attributes.marker_name #=> String
|
2014
|
+
# resp.events[0].marker_recorded_event_attributes.details #=> String
|
2015
|
+
# resp.events[0].marker_recorded_event_attributes.decision_task_completed_event_id #=> Integer
|
2016
|
+
# resp.events[0].record_marker_failed_event_attributes.marker_name #=> String
|
2017
|
+
# resp.events[0].record_marker_failed_event_attributes.cause #=> String, one of "OPERATION_NOT_PERMITTED"
|
2018
|
+
# resp.events[0].record_marker_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2019
|
+
# resp.events[0].timer_started_event_attributes.timer_id #=> String
|
2020
|
+
# resp.events[0].timer_started_event_attributes.control #=> String
|
2021
|
+
# resp.events[0].timer_started_event_attributes.start_to_fire_timeout #=> String
|
2022
|
+
# resp.events[0].timer_started_event_attributes.decision_task_completed_event_id #=> Integer
|
2023
|
+
# resp.events[0].timer_fired_event_attributes.timer_id #=> String
|
2024
|
+
# resp.events[0].timer_fired_event_attributes.started_event_id #=> Integer
|
2025
|
+
# resp.events[0].timer_canceled_event_attributes.timer_id #=> String
|
2026
|
+
# resp.events[0].timer_canceled_event_attributes.started_event_id #=> Integer
|
2027
|
+
# resp.events[0].timer_canceled_event_attributes.decision_task_completed_event_id #=> Integer
|
2028
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_id #=> String
|
2029
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_type.name #=> String
|
2030
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.workflow_type.version #=> String
|
2031
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.control #=> String
|
2032
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.input #=> String
|
2033
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.execution_start_to_close_timeout #=> String
|
2034
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_list.name #=> String
|
2035
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_priority #=> String
|
2036
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
|
2037
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
|
2038
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.task_start_to_close_timeout #=> String
|
2039
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.tag_list #=> Array
|
2040
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.tag_list[0] #=> String
|
2041
|
+
# resp.events[0].start_child_workflow_execution_initiated_event_attributes.lambda_role #=> String
|
2042
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.workflow_execution.workflow_id #=> String
|
2043
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.workflow_execution.run_id #=> String
|
2044
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.workflow_type.name #=> String
|
2045
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.workflow_type.version #=> String
|
2046
|
+
# resp.events[0].child_workflow_execution_started_event_attributes.initiated_event_id #=> Integer
|
2047
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.workflow_execution.workflow_id #=> String
|
2048
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.workflow_execution.run_id #=> String
|
2049
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.workflow_type.name #=> String
|
2050
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.workflow_type.version #=> String
|
2051
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.result #=> String
|
2052
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.initiated_event_id #=> Integer
|
2053
|
+
# resp.events[0].child_workflow_execution_completed_event_attributes.started_event_id #=> Integer
|
2054
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.workflow_execution.workflow_id #=> String
|
2055
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.workflow_execution.run_id #=> String
|
2056
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.workflow_type.name #=> String
|
2057
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.workflow_type.version #=> String
|
2058
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.reason #=> String
|
2059
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.details #=> String
|
2060
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
|
2061
|
+
# resp.events[0].child_workflow_execution_failed_event_attributes.started_event_id #=> Integer
|
2062
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_execution.workflow_id #=> String
|
2063
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_execution.run_id #=> String
|
2064
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_type.name #=> String
|
2065
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.workflow_type.version #=> String
|
2066
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
|
2067
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.initiated_event_id #=> Integer
|
2068
|
+
# resp.events[0].child_workflow_execution_timed_out_event_attributes.started_event_id #=> Integer
|
2069
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_execution.workflow_id #=> String
|
2070
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_execution.run_id #=> String
|
2071
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_type.name #=> String
|
2072
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.workflow_type.version #=> String
|
2073
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.details #=> String
|
2074
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.initiated_event_id #=> Integer
|
2075
|
+
# resp.events[0].child_workflow_execution_canceled_event_attributes.started_event_id #=> Integer
|
2076
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_execution.workflow_id #=> String
|
2077
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_execution.run_id #=> String
|
2078
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_type.name #=> String
|
2079
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.workflow_type.version #=> String
|
2080
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.initiated_event_id #=> Integer
|
2081
|
+
# resp.events[0].child_workflow_execution_terminated_event_attributes.started_event_id #=> Integer
|
2082
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.workflow_id #=> String
|
2083
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.run_id #=> String
|
2084
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.signal_name #=> String
|
2085
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.input #=> String
|
2086
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
|
2087
|
+
# resp.events[0].signal_external_workflow_execution_initiated_event_attributes.control #=> String
|
2088
|
+
# resp.events[0].external_workflow_execution_signaled_event_attributes.workflow_execution.workflow_id #=> String
|
2089
|
+
# resp.events[0].external_workflow_execution_signaled_event_attributes.workflow_execution.run_id #=> String
|
2090
|
+
# resp.events[0].external_workflow_execution_signaled_event_attributes.initiated_event_id #=> Integer
|
2091
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.workflow_id #=> String
|
2092
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.run_id #=> String
|
2093
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.cause #=> String, one of "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
|
2094
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
|
2095
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2096
|
+
# resp.events[0].signal_external_workflow_execution_failed_event_attributes.control #=> String
|
2097
|
+
# resp.events[0].external_workflow_execution_cancel_requested_event_attributes.workflow_execution.workflow_id #=> String
|
2098
|
+
# resp.events[0].external_workflow_execution_cancel_requested_event_attributes.workflow_execution.run_id #=> String
|
2099
|
+
# resp.events[0].external_workflow_execution_cancel_requested_event_attributes.initiated_event_id #=> Integer
|
2100
|
+
# resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.workflow_id #=> String
|
2101
|
+
# resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.run_id #=> String
|
2102
|
+
# resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.decision_task_completed_event_id #=> Integer
|
2103
|
+
# resp.events[0].request_cancel_external_workflow_execution_initiated_event_attributes.control #=> String
|
2104
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.workflow_id #=> String
|
2105
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.run_id #=> String
|
2106
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.cause #=> String, one of "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
|
2107
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
|
2108
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2109
|
+
# resp.events[0].request_cancel_external_workflow_execution_failed_event_attributes.control #=> String
|
2110
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.activity_type.name #=> String
|
2111
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.activity_type.version #=> String
|
2112
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.activity_id #=> String
|
2113
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.cause #=> String, one of "ACTIVITY_TYPE_DEPRECATED", "ACTIVITY_TYPE_DOES_NOT_EXIST", "ACTIVITY_ID_ALREADY_IN_USE", "OPEN_ACTIVITIES_LIMIT_EXCEEDED", "ACTIVITY_CREATION_RATE_EXCEEDED", "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", "OPERATION_NOT_PERMITTED"
|
2114
|
+
# resp.events[0].schedule_activity_task_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2115
|
+
# resp.events[0].request_cancel_activity_task_failed_event_attributes.activity_id #=> String
|
2116
|
+
# resp.events[0].request_cancel_activity_task_failed_event_attributes.cause #=> String, one of "ACTIVITY_ID_UNKNOWN", "OPERATION_NOT_PERMITTED"
|
2117
|
+
# resp.events[0].request_cancel_activity_task_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2118
|
+
# resp.events[0].start_timer_failed_event_attributes.timer_id #=> String
|
2119
|
+
# resp.events[0].start_timer_failed_event_attributes.cause #=> String, one of "TIMER_ID_ALREADY_IN_USE", "OPEN_TIMERS_LIMIT_EXCEEDED", "TIMER_CREATION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED"
|
2120
|
+
# resp.events[0].start_timer_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2121
|
+
# resp.events[0].cancel_timer_failed_event_attributes.timer_id #=> String
|
2122
|
+
# resp.events[0].cancel_timer_failed_event_attributes.cause #=> String, one of "TIMER_ID_UNKNOWN", "OPERATION_NOT_PERMITTED"
|
2123
|
+
# resp.events[0].cancel_timer_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2124
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_type.name #=> String
|
2125
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_type.version #=> String
|
2126
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.cause #=> String, one of "WORKFLOW_TYPE_DOES_NOT_EXIST", "WORKFLOW_TYPE_DEPRECATED", "OPEN_CHILDREN_LIMIT_EXCEEDED", "OPEN_WORKFLOWS_LIMIT_EXCEEDED", "CHILD_CREATION_RATE_EXCEEDED", "WORKFLOW_ALREADY_RUNNING", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "OPERATION_NOT_PERMITTED"
|
2127
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.workflow_id #=> String
|
2128
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.initiated_event_id #=> Integer
|
2129
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2130
|
+
# resp.events[0].start_child_workflow_execution_failed_event_attributes.control #=> String
|
2131
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.id #=> String
|
2132
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.name #=> String
|
2133
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.input #=> String
|
2134
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.start_to_close_timeout #=> String
|
2135
|
+
# resp.events[0].lambda_function_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
|
2136
|
+
# resp.events[0].lambda_function_started_event_attributes.scheduled_event_id #=> Integer
|
2137
|
+
# resp.events[0].lambda_function_completed_event_attributes.scheduled_event_id #=> Integer
|
2138
|
+
# resp.events[0].lambda_function_completed_event_attributes.started_event_id #=> Integer
|
2139
|
+
# resp.events[0].lambda_function_completed_event_attributes.result #=> String
|
2140
|
+
# resp.events[0].lambda_function_failed_event_attributes.scheduled_event_id #=> Integer
|
2141
|
+
# resp.events[0].lambda_function_failed_event_attributes.started_event_id #=> Integer
|
2142
|
+
# resp.events[0].lambda_function_failed_event_attributes.reason #=> String
|
2143
|
+
# resp.events[0].lambda_function_failed_event_attributes.details #=> String
|
2144
|
+
# resp.events[0].lambda_function_timed_out_event_attributes.scheduled_event_id #=> Integer
|
2145
|
+
# resp.events[0].lambda_function_timed_out_event_attributes.started_event_id #=> Integer
|
2146
|
+
# resp.events[0].lambda_function_timed_out_event_attributes.timeout_type #=> String, one of "START_TO_CLOSE"
|
2147
|
+
# resp.events[0].schedule_lambda_function_failed_event_attributes.id #=> String
|
2148
|
+
# resp.events[0].schedule_lambda_function_failed_event_attributes.name #=> String
|
2149
|
+
# resp.events[0].schedule_lambda_function_failed_event_attributes.cause #=> String, one of "ID_ALREADY_IN_USE", "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED", "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED", "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"
|
2150
|
+
# resp.events[0].schedule_lambda_function_failed_event_attributes.decision_task_completed_event_id #=> Integer
|
2151
|
+
# resp.events[0].start_lambda_function_failed_event_attributes.scheduled_event_id #=> Integer
|
2152
|
+
# resp.events[0].start_lambda_function_failed_event_attributes.cause #=> String, one of "ASSUME_ROLE_FAILED"
|
2153
|
+
# resp.events[0].start_lambda_function_failed_event_attributes.message #=> String
|
2154
|
+
# resp.next_page_token #=> String
|
2155
|
+
# resp.previous_started_event_id #=> Integer
|
2156
|
+
# @overload poll_for_decision_task(params = {})
|
2157
|
+
# @param [Hash] params ({})
|
2158
|
+
def poll_for_decision_task(params = {}, options = {})
|
2159
|
+
req = build_request(:poll_for_decision_task, params)
|
2160
|
+
req.send_request(options)
|
2161
|
+
end
|
2162
|
+
|
2163
|
+
# Used by activity workers to report to the service that the
|
2164
|
+
# ActivityTask represented by the specified `taskToken` is still making
|
2165
|
+
# progress. The worker can also (optionally) specify details of the
|
2166
|
+
# progress, for example percent complete, using the `details` parameter.
|
2167
|
+
# This action can also be used by the worker as a mechanism to check if
|
2168
|
+
# cancellation is being requested for the activity task. If a
|
2169
|
+
# cancellation is being attempted for the specified task, then the
|
2170
|
+
# boolean `cancelRequested` flag returned by the service is set to
|
2171
|
+
# `true`.
|
2172
|
+
#
|
2173
|
+
# This action resets the `taskHeartbeatTimeout` clock. The
|
2174
|
+
# `taskHeartbeatTimeout` is specified in RegisterActivityType.
|
2175
|
+
#
|
2176
|
+
# This action does not in itself create an event in the workflow
|
2177
|
+
# execution history. However, if the task times out, the workflow
|
2178
|
+
# execution history will contain a `ActivityTaskTimedOut` event that
|
2179
|
+
# contains the information from the last heartbeat generated by the
|
2180
|
+
# activity worker.
|
2181
|
+
#
|
2182
|
+
# <note>The `taskStartToCloseTimeout` of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The `taskStartToCloseTimeout` is also specified in RegisterActivityType.</note>
|
2183
|
+
#
|
2184
|
+
# <note>This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. </note>
|
2185
|
+
#
|
2186
|
+
# If the `cancelRequested` flag returns `true`, a cancellation is being
|
2187
|
+
# attempted. If the worker can cancel the activity, it should respond
|
2188
|
+
# with RespondActivityTaskCanceled. Otherwise, it should ignore the
|
2189
|
+
# cancellation request.
|
2190
|
+
#
|
2191
|
+
# **Access Control**
|
2192
|
+
#
|
2193
|
+
# You can use IAM policies to control this action's access to Amazon
|
2194
|
+
# SWF resources as follows:
|
2195
|
+
#
|
2196
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
2197
|
+
# only specified domains.
|
2198
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2199
|
+
# action.
|
2200
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
2201
|
+
#
|
2202
|
+
# If the caller does not have sufficient permissions to invoke the
|
2203
|
+
# action, or the parameter values fall outside the specified
|
2204
|
+
# constraints, the action fails. The associated event attribute's
|
2205
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2206
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2207
|
+
# Amazon SWF Workflows][1].
|
2208
|
+
#
|
2209
|
+
#
|
2210
|
+
#
|
2211
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2212
|
+
# @option params [required, String] :task_token
|
2213
|
+
# The `taskToken` of the ActivityTask.
|
2214
|
+
#
|
2215
|
+
# `taskToken` is generated by the service and should be treated as an
|
2216
|
+
# opaque value. If the task is passed to another process, its
|
2217
|
+
# `taskToken` must also be passed. This enables it to provide its
|
2218
|
+
# progress and respond with results.
|
2219
|
+
# @option params [String] :details
|
2220
|
+
# If specified, contains details about the progress of the task.
|
2221
|
+
# @return [Types::ActivityTaskStatus] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2222
|
+
#
|
2223
|
+
# * {Types::ActivityTaskStatus#cancel_requested #cancelRequested} => Boolean
|
2224
|
+
#
|
2225
|
+
# @example Request syntax with placeholder values
|
2226
|
+
# resp = client.record_activity_task_heartbeat({
|
2227
|
+
# task_token: "TaskToken", # required
|
2228
|
+
# details: "LimitedData",
|
2229
|
+
# })
|
2230
|
+
#
|
2231
|
+
# @example Response structure
|
2232
|
+
# resp.cancel_requested #=> Boolean
|
2233
|
+
# @overload record_activity_task_heartbeat(params = {})
|
2234
|
+
# @param [Hash] params ({})
|
2235
|
+
def record_activity_task_heartbeat(params = {}, options = {})
|
2236
|
+
req = build_request(:record_activity_task_heartbeat, params)
|
2237
|
+
req.send_request(options)
|
2238
|
+
end
|
2239
|
+
|
2240
|
+
# Registers a new *activity type* along with its configuration settings
|
2241
|
+
# in the specified domain.
|
2242
|
+
#
|
2243
|
+
# A `TypeAlreadyExists` fault is returned if the type already exists in
|
2244
|
+
# the domain. You cannot change any configuration settings of the type
|
2245
|
+
# after its registration, and it must be registered as a new version.
|
2246
|
+
#
|
2247
|
+
# **Access Control**
|
2248
|
+
#
|
2249
|
+
# You can use IAM policies to control this action's access to Amazon
|
2250
|
+
# SWF resources as follows:
|
2251
|
+
#
|
2252
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
2253
|
+
# only specified domains.
|
2254
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2255
|
+
# action.
|
2256
|
+
# * Constrain the following parameters by using a `Condition` element
|
2257
|
+
# with the appropriate keys.
|
2258
|
+
# * `defaultTaskList.name`\: String constraint. The key is
|
2259
|
+
# `swf:defaultTaskList.name`.
|
2260
|
+
# * `name`\: String constraint. The key is `swf:name`.
|
2261
|
+
# * `version`\: String constraint. The key is `swf:version`.
|
2262
|
+
#
|
2263
|
+
# If the caller does not have sufficient permissions to invoke the
|
2264
|
+
# action, or the parameter values fall outside the specified
|
2265
|
+
# constraints, the action fails. The associated event attribute's
|
2266
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2267
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2268
|
+
# Amazon SWF Workflows][1].
|
2269
|
+
#
|
2270
|
+
#
|
2271
|
+
#
|
2272
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2273
|
+
# @option params [required, String] :domain
|
2274
|
+
# The name of the domain in which this activity is to be registered.
|
2275
|
+
# @option params [required, String] :name
|
2276
|
+
# The name of the activity type within the domain.
|
2277
|
+
#
|
2278
|
+
# The specified string must not start or end with whitespace. It must
|
2279
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
2280
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
2281
|
+
# must not contain the literal string quotarnquot.
|
2282
|
+
# @option params [required, String] :version
|
2283
|
+
# The version of the activity type.
|
2284
|
+
#
|
2285
|
+
# <note>The activity type consists of the name and version, the combination of which must be unique within the domain.</note>
|
2286
|
+
#
|
2287
|
+
# The specified string must not start or end with whitespace. It must
|
2288
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
2289
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
2290
|
+
# must not contain the literal string quotarnquot.
|
2291
|
+
# @option params [String] :description
|
2292
|
+
# A textual description of the activity type.
|
2293
|
+
# @option params [String] :default_task_start_to_close_timeout
|
2294
|
+
# If set, specifies the default maximum duration that a worker can take
|
2295
|
+
# to process tasks of this activity type. This default can be overridden
|
2296
|
+
# when scheduling an activity task using the `ScheduleActivityTask`
|
2297
|
+
# decision.
|
2298
|
+
#
|
2299
|
+
# The duration is specified in seconds; an integer greater than or equal
|
2300
|
+
# to 0. The value "NONE" can be used to specify unlimited duration.
|
2301
|
+
# @option params [String] :default_task_heartbeat_timeout
|
2302
|
+
# If set, specifies the default maximum time before which a worker
|
2303
|
+
# processing a task of this type must report progress by calling
|
2304
|
+
# RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity
|
2305
|
+
# task is automatically timed out. This default can be overridden when
|
2306
|
+
# scheduling an activity task using the `ScheduleActivityTask` decision.
|
2307
|
+
# If the activity worker subsequently attempts to record a heartbeat or
|
2308
|
+
# returns a result, the activity worker receives an `UnknownResource`
|
2309
|
+
# fault. In this case, Amazon SWF no longer considers the activity task
|
2310
|
+
# to be valid; the activity worker should clean up the activity task.
|
2311
|
+
#
|
2312
|
+
# The duration is specified in seconds; an integer greater than or equal
|
2313
|
+
# to 0. The value "NONE" can be used to specify unlimited duration.
|
2314
|
+
# @option params [Types::TaskList] :default_task_list
|
2315
|
+
# If set, specifies the default task list to use for scheduling tasks of
|
2316
|
+
# this activity type. This default task list is used if a task list is
|
2317
|
+
# not provided when a task is scheduled through the
|
2318
|
+
# `ScheduleActivityTask` decision.
|
2319
|
+
# @option params [String] :default_task_priority
|
2320
|
+
# The default task priority to assign to the activity type. If not
|
2321
|
+
# assigned, then "0" will be used. Valid values are integers that
|
2322
|
+
# range from Java's `Integer.MIN_VALUE` (-2147483648) to
|
2323
|
+
# `Integer.MAX_VALUE` (2147483647). Higher numbers indicate higher
|
2324
|
+
# priority.
|
2325
|
+
#
|
2326
|
+
# For more information about setting task priority, see [Setting Task
|
2327
|
+
# Priority][1] in the *Amazon Simple Workflow Developer Guide*.
|
2328
|
+
#
|
2329
|
+
#
|
2330
|
+
#
|
2331
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html
|
2332
|
+
# @option params [String] :default_task_schedule_to_start_timeout
|
2333
|
+
# If set, specifies the default maximum duration that a task of this
|
2334
|
+
# activity type can wait before being assigned to a worker. This default
|
2335
|
+
# can be overridden when scheduling an activity task using the
|
2336
|
+
# `ScheduleActivityTask` decision.
|
2337
|
+
#
|
2338
|
+
# The duration is specified in seconds; an integer greater than or equal
|
2339
|
+
# to 0. The value "NONE" can be used to specify unlimited duration.
|
2340
|
+
# @option params [String] :default_task_schedule_to_close_timeout
|
2341
|
+
# If set, specifies the default maximum duration for a task of this
|
2342
|
+
# activity type. This default can be overridden when scheduling an
|
2343
|
+
# activity task using the `ScheduleActivityTask` decision.
|
2344
|
+
#
|
2345
|
+
# The duration is specified in seconds; an integer greater than or equal
|
2346
|
+
# to 0. The value "NONE" can be used to specify unlimited duration.
|
2347
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2348
|
+
#
|
2349
|
+
# @example Request syntax with placeholder values
|
2350
|
+
# resp = client.register_activity_type({
|
2351
|
+
# domain: "DomainName", # required
|
2352
|
+
# name: "Name", # required
|
2353
|
+
# version: "Version", # required
|
2354
|
+
# description: "Description",
|
2355
|
+
# default_task_start_to_close_timeout: "DurationInSecondsOptional",
|
2356
|
+
# default_task_heartbeat_timeout: "DurationInSecondsOptional",
|
2357
|
+
# default_task_list: {
|
2358
|
+
# name: "Name", # required
|
2359
|
+
# },
|
2360
|
+
# default_task_priority: "TaskPriority",
|
2361
|
+
# default_task_schedule_to_start_timeout: "DurationInSecondsOptional",
|
2362
|
+
# default_task_schedule_to_close_timeout: "DurationInSecondsOptional",
|
2363
|
+
# })
|
2364
|
+
# @overload register_activity_type(params = {})
|
2365
|
+
# @param [Hash] params ({})
|
2366
|
+
def register_activity_type(params = {}, options = {})
|
2367
|
+
req = build_request(:register_activity_type, params)
|
2368
|
+
req.send_request(options)
|
2369
|
+
end
|
2370
|
+
|
2371
|
+
# Registers a new domain.
|
2372
|
+
#
|
2373
|
+
# **Access Control**
|
2374
|
+
#
|
2375
|
+
# You can use IAM policies to control this action's access to Amazon
|
2376
|
+
# SWF resources as follows:
|
2377
|
+
#
|
2378
|
+
# * You cannot use an IAM policy to control domain access for this
|
2379
|
+
# action. The name of the domain being registered is available as the
|
2380
|
+
# resource of this action.
|
2381
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2382
|
+
# action.
|
2383
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
2384
|
+
#
|
2385
|
+
# If the caller does not have sufficient permissions to invoke the
|
2386
|
+
# action, or the parameter values fall outside the specified
|
2387
|
+
# constraints, the action fails. The associated event attribute's
|
2388
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2389
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2390
|
+
# Amazon SWF Workflows][1].
|
2391
|
+
#
|
2392
|
+
#
|
2393
|
+
#
|
2394
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2395
|
+
# @option params [required, String] :name
|
2396
|
+
# Name of the domain to register. The name must be unique in the region
|
2397
|
+
# that the domain is registered in.
|
2398
|
+
#
|
2399
|
+
# The specified string must not start or end with whitespace. It must
|
2400
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
2401
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
2402
|
+
# must not contain the literal string quotarnquot.
|
2403
|
+
# @option params [String] :description
|
2404
|
+
# A text description of the domain.
|
2405
|
+
# @option params [required, String] :workflow_execution_retention_period_in_days
|
2406
|
+
# The duration (in days) that records and histories of workflow
|
2407
|
+
# executions on the domain should be kept by the service. After the
|
2408
|
+
# retention period, the workflow execution is not available in the
|
2409
|
+
# results of visibility calls.
|
2410
|
+
#
|
2411
|
+
# If you pass the value `NONE` or `0` (zero), then the workflow
|
2412
|
+
# execution history will not be retained. As soon as the workflow
|
2413
|
+
# execution completes, the execution record and its history are deleted.
|
2414
|
+
#
|
2415
|
+
# The maximum workflow execution retention period is 90 days. For more
|
2416
|
+
# information about Amazon SWF service limits, see: [Amazon SWF Service
|
2417
|
+
# Limits][1] in the *Amazon SWF Developer Guide*.
|
2418
|
+
#
|
2419
|
+
#
|
2420
|
+
#
|
2421
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-limits.html
|
2422
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2423
|
+
#
|
2424
|
+
# @example Request syntax with placeholder values
|
2425
|
+
# resp = client.register_domain({
|
2426
|
+
# name: "DomainName", # required
|
2427
|
+
# description: "Description",
|
2428
|
+
# workflow_execution_retention_period_in_days: "DurationInDays", # required
|
2429
|
+
# })
|
2430
|
+
# @overload register_domain(params = {})
|
2431
|
+
# @param [Hash] params ({})
|
2432
|
+
def register_domain(params = {}, options = {})
|
2433
|
+
req = build_request(:register_domain, params)
|
2434
|
+
req.send_request(options)
|
2435
|
+
end
|
2436
|
+
|
2437
|
+
# Registers a new *workflow type* and its configuration settings in the
|
2438
|
+
# specified domain.
|
2439
|
+
#
|
2440
|
+
# The retention period for the workflow history is set by the
|
2441
|
+
# RegisterDomain action.
|
2442
|
+
#
|
2443
|
+
# If the type already exists, then a `TypeAlreadyExists` fault is
|
2444
|
+
# returned. You cannot change the configuration settings of a workflow
|
2445
|
+
# type once it is registered and it must be registered as a new version.
|
2446
|
+
#
|
2447
|
+
# **Access Control**
|
2448
|
+
#
|
2449
|
+
# You can use IAM policies to control this action's access to Amazon
|
2450
|
+
# SWF resources as follows:
|
2451
|
+
#
|
2452
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
2453
|
+
# only specified domains.
|
2454
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2455
|
+
# action.
|
2456
|
+
# * Constrain the following parameters by using a `Condition` element
|
2457
|
+
# with the appropriate keys.
|
2458
|
+
# * `defaultTaskList.name`\: String constraint. The key is
|
2459
|
+
# `swf:defaultTaskList.name`.
|
2460
|
+
# * `name`\: String constraint. The key is `swf:name`.
|
2461
|
+
# * `version`\: String constraint. The key is `swf:version`.
|
2462
|
+
#
|
2463
|
+
# If the caller does not have sufficient permissions to invoke the
|
2464
|
+
# action, or the parameter values fall outside the specified
|
2465
|
+
# constraints, the action fails. The associated event attribute's
|
2466
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2467
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2468
|
+
# Amazon SWF Workflows][1].
|
2469
|
+
#
|
2470
|
+
#
|
2471
|
+
#
|
2472
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2473
|
+
# @option params [required, String] :domain
|
2474
|
+
# The name of the domain in which to register the workflow type.
|
2475
|
+
# @option params [required, String] :name
|
2476
|
+
# The name of the workflow type.
|
2477
|
+
#
|
2478
|
+
# The specified string must not start or end with whitespace. It must
|
2479
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
2480
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
2481
|
+
# must not contain the literal string quotarnquot.
|
2482
|
+
# @option params [required, String] :version
|
2483
|
+
# The version of the workflow type.
|
2484
|
+
#
|
2485
|
+
# <note>The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.</note>
|
2486
|
+
#
|
2487
|
+
# The specified string must not start or end with whitespace. It must
|
2488
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
2489
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
2490
|
+
# must not contain the literal string quotarnquot.
|
2491
|
+
# @option params [String] :description
|
2492
|
+
# Textual description of the workflow type.
|
2493
|
+
# @option params [String] :default_task_start_to_close_timeout
|
2494
|
+
# If set, specifies the default maximum duration of decision tasks for
|
2495
|
+
# this workflow type. This default can be overridden when starting a
|
2496
|
+
# workflow execution using the StartWorkflowExecution action or the
|
2497
|
+
# `StartChildWorkflowExecution` decision.
|
2498
|
+
#
|
2499
|
+
# The duration is specified in seconds; an integer greater than or equal
|
2500
|
+
# to 0. The value "NONE" can be used to specify unlimited duration.
|
2501
|
+
# @option params [String] :default_execution_start_to_close_timeout
|
2502
|
+
# If set, specifies the default maximum duration for executions of this
|
2503
|
+
# workflow type. You can override this default when starting an
|
2504
|
+
# execution through the StartWorkflowExecution action or
|
2505
|
+
# `StartChildWorkflowExecution` decision.
|
2506
|
+
#
|
2507
|
+
# The duration is specified in seconds; an integer greater than or equal
|
2508
|
+
# to 0. Unlike some of the other timeout parameters in Amazon SWF, you
|
2509
|
+
# cannot specify a value of "NONE" for
|
2510
|
+
# `defaultExecutionStartToCloseTimeout`; there is a one-year max limit
|
2511
|
+
# on the time that a workflow execution can run. Exceeding this limit
|
2512
|
+
# will always cause the workflow execution to time out.
|
2513
|
+
# @option params [Types::TaskList] :default_task_list
|
2514
|
+
# If set, specifies the default task list to use for scheduling decision
|
2515
|
+
# tasks for executions of this workflow type. This default is used only
|
2516
|
+
# if a task list is not provided when starting the execution through the
|
2517
|
+
# StartWorkflowExecution action or `StartChildWorkflowExecution`
|
2518
|
+
# decision.
|
2519
|
+
# @option params [String] :default_task_priority
|
2520
|
+
# The default task priority to assign to the workflow type. If not
|
2521
|
+
# assigned, then "0" will be used. Valid values are integers that
|
2522
|
+
# range from Java's `Integer.MIN_VALUE` (-2147483648) to
|
2523
|
+
# `Integer.MAX_VALUE` (2147483647). Higher numbers indicate higher
|
2524
|
+
# priority.
|
2525
|
+
#
|
2526
|
+
# For more information about setting task priority, see [Setting Task
|
2527
|
+
# Priority][1] in the *Amazon Simple Workflow Developer Guide*.
|
2528
|
+
#
|
2529
|
+
#
|
2530
|
+
#
|
2531
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html
|
2532
|
+
# @option params [String] :default_child_policy
|
2533
|
+
# If set, specifies the default policy to use for the child workflow
|
2534
|
+
# executions when a workflow execution of this type is terminated, by
|
2535
|
+
# calling the TerminateWorkflowExecution action explicitly or due to an
|
2536
|
+
# expired timeout. This default can be overridden when starting a
|
2537
|
+
# workflow execution using the StartWorkflowExecution action or the
|
2538
|
+
# `StartChildWorkflowExecution` decision.
|
2539
|
+
#
|
2540
|
+
# The supported child policies are:
|
2541
|
+
#
|
2542
|
+
# * **TERMINATE:** the child executions will be terminated.
|
2543
|
+
# * **REQUEST\_CANCEL:** a request to cancel will be attempted for each
|
2544
|
+
# child execution by recording a `WorkflowExecutionCancelRequested`
|
2545
|
+
# event in its history. It is up to the decider to take appropriate
|
2546
|
+
# actions when it receives an execution history with this event.
|
2547
|
+
# * **ABANDON:** no action will be taken. The child executions will
|
2548
|
+
# continue to run.
|
2549
|
+
# @option params [String] :default_lambda_role
|
2550
|
+
# The ARN of the default IAM role to use when a workflow execution of
|
2551
|
+
# this type invokes AWS Lambda functions.
|
2552
|
+
#
|
2553
|
+
# This default can be overridden when starting a workflow execution
|
2554
|
+
# using the StartWorkflowExecution action or the
|
2555
|
+
# `StartChildWorkflowExecution` and `ContinueAsNewWorkflowExecution`
|
2556
|
+
# decision.
|
2557
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2558
|
+
#
|
2559
|
+
# @example Request syntax with placeholder values
|
2560
|
+
# resp = client.register_workflow_type({
|
2561
|
+
# domain: "DomainName", # required
|
2562
|
+
# name: "Name", # required
|
2563
|
+
# version: "Version", # required
|
2564
|
+
# description: "Description",
|
2565
|
+
# default_task_start_to_close_timeout: "DurationInSecondsOptional",
|
2566
|
+
# default_execution_start_to_close_timeout: "DurationInSecondsOptional",
|
2567
|
+
# default_task_list: {
|
2568
|
+
# name: "Name", # required
|
2569
|
+
# },
|
2570
|
+
# default_task_priority: "TaskPriority",
|
2571
|
+
# default_child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
|
2572
|
+
# default_lambda_role: "Arn",
|
2573
|
+
# })
|
2574
|
+
# @overload register_workflow_type(params = {})
|
2575
|
+
# @param [Hash] params ({})
|
2576
|
+
def register_workflow_type(params = {}, options = {})
|
2577
|
+
req = build_request(:register_workflow_type, params)
|
2578
|
+
req.send_request(options)
|
2579
|
+
end
|
2580
|
+
|
2581
|
+
# Records a `WorkflowExecutionCancelRequested` event in the currently
|
2582
|
+
# running workflow execution identified by the given domain, workflowId,
|
2583
|
+
# and runId. This logically requests the cancellation of the workflow
|
2584
|
+
# execution as a whole. It is up to the decider to take appropriate
|
2585
|
+
# actions when it receives an execution history with this event.
|
2586
|
+
#
|
2587
|
+
# <note>If the runId is not specified, the `WorkflowExecutionCancelRequested` event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.</note>
|
2588
|
+
#
|
2589
|
+
# <note>Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.</note>
|
2590
|
+
#
|
2591
|
+
# **Access Control**
|
2592
|
+
#
|
2593
|
+
# You can use IAM policies to control this action's access to Amazon
|
2594
|
+
# SWF resources as follows:
|
2595
|
+
#
|
2596
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
2597
|
+
# only specified domains.
|
2598
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2599
|
+
# action.
|
2600
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
2601
|
+
#
|
2602
|
+
# If the caller does not have sufficient permissions to invoke the
|
2603
|
+
# action, or the parameter values fall outside the specified
|
2604
|
+
# constraints, the action fails. The associated event attribute's
|
2605
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2606
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2607
|
+
# Amazon SWF Workflows][1].
|
2608
|
+
#
|
2609
|
+
#
|
2610
|
+
#
|
2611
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2612
|
+
# @option params [required, String] :domain
|
2613
|
+
# The name of the domain containing the workflow execution to cancel.
|
2614
|
+
# @option params [required, String] :workflow_id
|
2615
|
+
# The workflowId of the workflow execution to cancel.
|
2616
|
+
# @option params [String] :run_id
|
2617
|
+
# The runId of the workflow execution to cancel.
|
2618
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2619
|
+
#
|
2620
|
+
# @example Request syntax with placeholder values
|
2621
|
+
# resp = client.request_cancel_workflow_execution({
|
2622
|
+
# domain: "DomainName", # required
|
2623
|
+
# workflow_id: "WorkflowId", # required
|
2624
|
+
# run_id: "RunIdOptional",
|
2625
|
+
# })
|
2626
|
+
# @overload request_cancel_workflow_execution(params = {})
|
2627
|
+
# @param [Hash] params ({})
|
2628
|
+
def request_cancel_workflow_execution(params = {}, options = {})
|
2629
|
+
req = build_request(:request_cancel_workflow_execution, params)
|
2630
|
+
req.send_request(options)
|
2631
|
+
end
|
2632
|
+
|
2633
|
+
# Used by workers to tell the service that the ActivityTask identified
|
2634
|
+
# by the `taskToken` was successfully canceled. Additional `details` can
|
2635
|
+
# be optionally provided using the `details` argument.
|
2636
|
+
#
|
2637
|
+
# These `details` (if provided) appear in the `ActivityTaskCanceled`
|
2638
|
+
# event added to the workflow history.
|
2639
|
+
#
|
2640
|
+
# Only use this operation if the `canceled` flag of a
|
2641
|
+
# RecordActivityTaskHeartbeat request returns `true` and if the activity
|
2642
|
+
# can be safely undone or abandoned.
|
2643
|
+
#
|
2644
|
+
# A task is considered open from the time that it is scheduled until it
|
2645
|
+
# is closed. Therefore a task is reported as open while a worker is
|
2646
|
+
# processing it. A task is closed after it has been specified in a call
|
2647
|
+
# to RespondActivityTaskCompleted, RespondActivityTaskCanceled,
|
2648
|
+
# RespondActivityTaskFailed, or the task has [timed out][1].
|
2649
|
+
#
|
2650
|
+
# **Access Control**
|
2651
|
+
#
|
2652
|
+
# You can use IAM policies to control this action's access to Amazon
|
2653
|
+
# SWF resources as follows:
|
2654
|
+
#
|
2655
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
2656
|
+
# only specified domains.
|
2657
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2658
|
+
# action.
|
2659
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
2660
|
+
#
|
2661
|
+
# If the caller does not have sufficient permissions to invoke the
|
2662
|
+
# action, or the parameter values fall outside the specified
|
2663
|
+
# constraints, the action fails. The associated event attribute's
|
2664
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2665
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2666
|
+
# Amazon SWF Workflows][2].
|
2667
|
+
#
|
2668
|
+
#
|
2669
|
+
#
|
2670
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types
|
2671
|
+
# [2]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2672
|
+
# @option params [required, String] :task_token
|
2673
|
+
# The `taskToken` of the ActivityTask.
|
2674
|
+
#
|
2675
|
+
# `taskToken` is generated by the service and should be treated as an
|
2676
|
+
# opaque value. If the task is passed to another process, its
|
2677
|
+
# `taskToken` must also be passed. This enables it to provide its
|
2678
|
+
# progress and respond with results.
|
2679
|
+
# @option params [String] :details
|
2680
|
+
# *Optional.* Information about the cancellation.
|
2681
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2682
|
+
#
|
2683
|
+
# @example Request syntax with placeholder values
|
2684
|
+
# resp = client.respond_activity_task_canceled({
|
2685
|
+
# task_token: "TaskToken", # required
|
2686
|
+
# details: "Data",
|
2687
|
+
# })
|
2688
|
+
# @overload respond_activity_task_canceled(params = {})
|
2689
|
+
# @param [Hash] params ({})
|
2690
|
+
def respond_activity_task_canceled(params = {}, options = {})
|
2691
|
+
req = build_request(:respond_activity_task_canceled, params)
|
2692
|
+
req.send_request(options)
|
2693
|
+
end
|
2694
|
+
|
2695
|
+
# Used by workers to tell the service that the ActivityTask identified
|
2696
|
+
# by the `taskToken` completed successfully with a `result` (if
|
2697
|
+
# provided). The `result` appears in the `ActivityTaskCompleted` event
|
2698
|
+
# in the workflow history.
|
2699
|
+
#
|
2700
|
+
# If the requested task does not complete successfully, use
|
2701
|
+
# RespondActivityTaskFailed instead. If the worker finds that the task
|
2702
|
+
# is canceled through the `canceled` flag returned by
|
2703
|
+
# RecordActivityTaskHeartbeat, it should cancel the task, clean up and
|
2704
|
+
# then call RespondActivityTaskCanceled.
|
2705
|
+
#
|
2706
|
+
# A task is considered open from the time that it is scheduled until it
|
2707
|
+
# is closed. Therefore a task is reported as open while a worker is
|
2708
|
+
# processing it. A task is closed after it has been specified in a call
|
2709
|
+
# to RespondActivityTaskCompleted, RespondActivityTaskCanceled,
|
2710
|
+
# RespondActivityTaskFailed, or the task has [timed out][1].
|
2711
|
+
#
|
2712
|
+
# **Access Control**
|
2713
|
+
#
|
2714
|
+
# You can use IAM policies to control this action's access to Amazon
|
2715
|
+
# SWF resources as follows:
|
2716
|
+
#
|
2717
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
2718
|
+
# only specified domains.
|
2719
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2720
|
+
# action.
|
2721
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
2722
|
+
#
|
2723
|
+
# If the caller does not have sufficient permissions to invoke the
|
2724
|
+
# action, or the parameter values fall outside the specified
|
2725
|
+
# constraints, the action fails. The associated event attribute's
|
2726
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2727
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2728
|
+
# Amazon SWF Workflows][2].
|
2729
|
+
#
|
2730
|
+
#
|
2731
|
+
#
|
2732
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types
|
2733
|
+
# [2]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2734
|
+
# @option params [required, String] :task_token
|
2735
|
+
# The `taskToken` of the ActivityTask.
|
2736
|
+
#
|
2737
|
+
# `taskToken` is generated by the service and should be treated as an
|
2738
|
+
# opaque value. If the task is passed to another process, its
|
2739
|
+
# `taskToken` must also be passed. This enables it to provide its
|
2740
|
+
# progress and respond with results.
|
2741
|
+
# @option params [String] :result
|
2742
|
+
# The result of the activity task. It is a free form string that is
|
2743
|
+
# implementation specific.
|
2744
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2745
|
+
#
|
2746
|
+
# @example Request syntax with placeholder values
|
2747
|
+
# resp = client.respond_activity_task_completed({
|
2748
|
+
# task_token: "TaskToken", # required
|
2749
|
+
# result: "Data",
|
2750
|
+
# })
|
2751
|
+
# @overload respond_activity_task_completed(params = {})
|
2752
|
+
# @param [Hash] params ({})
|
2753
|
+
def respond_activity_task_completed(params = {}, options = {})
|
2754
|
+
req = build_request(:respond_activity_task_completed, params)
|
2755
|
+
req.send_request(options)
|
2756
|
+
end
|
2757
|
+
|
2758
|
+
# Used by workers to tell the service that the ActivityTask identified
|
2759
|
+
# by the `taskToken` has failed with `reason` (if specified). The
|
2760
|
+
# `reason` and `details` appear in the `ActivityTaskFailed` event added
|
2761
|
+
# to the workflow history.
|
2762
|
+
#
|
2763
|
+
# A task is considered open from the time that it is scheduled until it
|
2764
|
+
# is closed. Therefore a task is reported as open while a worker is
|
2765
|
+
# processing it. A task is closed after it has been specified in a call
|
2766
|
+
# to RespondActivityTaskCompleted, RespondActivityTaskCanceled,
|
2767
|
+
# RespondActivityTaskFailed, or the task has [timed out][1].
|
2768
|
+
#
|
2769
|
+
# **Access Control**
|
2770
|
+
#
|
2771
|
+
# You can use IAM policies to control this action's access to Amazon
|
2772
|
+
# SWF resources as follows:
|
2773
|
+
#
|
2774
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
2775
|
+
# only specified domains.
|
2776
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2777
|
+
# action.
|
2778
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
2779
|
+
#
|
2780
|
+
# If the caller does not have sufficient permissions to invoke the
|
2781
|
+
# action, or the parameter values fall outside the specified
|
2782
|
+
# constraints, the action fails. The associated event attribute's
|
2783
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2784
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2785
|
+
# Amazon SWF Workflows][2].
|
2786
|
+
#
|
2787
|
+
#
|
2788
|
+
#
|
2789
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types
|
2790
|
+
# [2]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2791
|
+
# @option params [required, String] :task_token
|
2792
|
+
# The `taskToken` of the ActivityTask.
|
2793
|
+
#
|
2794
|
+
# `taskToken` is generated by the service and should be treated as an
|
2795
|
+
# opaque value. If the task is passed to another process, its
|
2796
|
+
# `taskToken` must also be passed. This enables it to provide its
|
2797
|
+
# progress and respond with results.
|
2798
|
+
# @option params [String] :reason
|
2799
|
+
# Description of the error that may assist in diagnostics.
|
2800
|
+
# @option params [String] :details
|
2801
|
+
# *Optional.* Detailed information about the failure.
|
2802
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2803
|
+
#
|
2804
|
+
# @example Request syntax with placeholder values
|
2805
|
+
# resp = client.respond_activity_task_failed({
|
2806
|
+
# task_token: "TaskToken", # required
|
2807
|
+
# reason: "FailureReason",
|
2808
|
+
# details: "Data",
|
2809
|
+
# })
|
2810
|
+
# @overload respond_activity_task_failed(params = {})
|
2811
|
+
# @param [Hash] params ({})
|
2812
|
+
def respond_activity_task_failed(params = {}, options = {})
|
2813
|
+
req = build_request(:respond_activity_task_failed, params)
|
2814
|
+
req.send_request(options)
|
2815
|
+
end
|
2816
|
+
|
2817
|
+
# Used by deciders to tell the service that the DecisionTask identified
|
2818
|
+
# by the `taskToken` has successfully completed. The `decisions`
|
2819
|
+
# argument specifies the list of decisions made while processing the
|
2820
|
+
# task.
|
2821
|
+
#
|
2822
|
+
# A `DecisionTaskCompleted` event is added to the workflow history. The
|
2823
|
+
# `executionContext` specified is attached to the event in the workflow
|
2824
|
+
# execution history.
|
2825
|
+
#
|
2826
|
+
# **Access Control**
|
2827
|
+
#
|
2828
|
+
# If an IAM policy grants permission to use
|
2829
|
+
# `RespondDecisionTaskCompleted`, it can express permissions for the
|
2830
|
+
# list of decisions in the `decisions` parameter. Each of the decisions
|
2831
|
+
# has one or more parameters, much like a regular API call. To allow for
|
2832
|
+
# policies to be as readable as possible, you can express permissions on
|
2833
|
+
# decisions as if they were actual API calls, including applying
|
2834
|
+
# conditions to some parameters. For more information, see [Using IAM to
|
2835
|
+
# Manage Access to Amazon SWF Workflows][1].
|
2836
|
+
#
|
2837
|
+
#
|
2838
|
+
#
|
2839
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2840
|
+
# @option params [required, String] :task_token
|
2841
|
+
# The `taskToken` from the DecisionTask.
|
2842
|
+
#
|
2843
|
+
# `taskToken` is generated by the service and should be treated as an
|
2844
|
+
# opaque value. If the task is passed to another process, its
|
2845
|
+
# `taskToken` must also be passed. This enables it to provide its
|
2846
|
+
# progress and respond with results.
|
2847
|
+
# @option params [Array<Types::Decision>] :decisions
|
2848
|
+
# The list of decisions (possibly empty) made by the decider while
|
2849
|
+
# processing this decision task. See the docs for the decision structure
|
2850
|
+
# for details.
|
2851
|
+
# @option params [String] :execution_context
|
2852
|
+
# User defined context to add to workflow execution.
|
2853
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2854
|
+
#
|
2855
|
+
# @example Request syntax with placeholder values
|
2856
|
+
# resp = client.respond_decision_task_completed({
|
2857
|
+
# task_token: "TaskToken", # required
|
2858
|
+
# decisions: [
|
2859
|
+
# {
|
2860
|
+
# decision_type: "ScheduleActivityTask", # required, accepts ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution, ScheduleLambdaFunction
|
2861
|
+
# schedule_activity_task_decision_attributes: {
|
2862
|
+
# activity_type: { # required
|
2863
|
+
# name: "Name", # required
|
2864
|
+
# version: "Version", # required
|
2865
|
+
# },
|
2866
|
+
# activity_id: "ActivityId", # required
|
2867
|
+
# control: "Data",
|
2868
|
+
# input: "Data",
|
2869
|
+
# schedule_to_close_timeout: "DurationInSecondsOptional",
|
2870
|
+
# task_list: {
|
2871
|
+
# name: "Name", # required
|
2872
|
+
# },
|
2873
|
+
# task_priority: "TaskPriority",
|
2874
|
+
# schedule_to_start_timeout: "DurationInSecondsOptional",
|
2875
|
+
# start_to_close_timeout: "DurationInSecondsOptional",
|
2876
|
+
# heartbeat_timeout: "DurationInSecondsOptional",
|
2877
|
+
# },
|
2878
|
+
# request_cancel_activity_task_decision_attributes: {
|
2879
|
+
# activity_id: "ActivityId", # required
|
2880
|
+
# },
|
2881
|
+
# complete_workflow_execution_decision_attributes: {
|
2882
|
+
# result: "Data",
|
2883
|
+
# },
|
2884
|
+
# fail_workflow_execution_decision_attributes: {
|
2885
|
+
# reason: "FailureReason",
|
2886
|
+
# details: "Data",
|
2887
|
+
# },
|
2888
|
+
# cancel_workflow_execution_decision_attributes: {
|
2889
|
+
# details: "Data",
|
2890
|
+
# },
|
2891
|
+
# continue_as_new_workflow_execution_decision_attributes: {
|
2892
|
+
# input: "Data",
|
2893
|
+
# execution_start_to_close_timeout: "DurationInSecondsOptional",
|
2894
|
+
# task_list: {
|
2895
|
+
# name: "Name", # required
|
2896
|
+
# },
|
2897
|
+
# task_priority: "TaskPriority",
|
2898
|
+
# task_start_to_close_timeout: "DurationInSecondsOptional",
|
2899
|
+
# child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
|
2900
|
+
# tag_list: ["Tag"],
|
2901
|
+
# workflow_type_version: "Version",
|
2902
|
+
# lambda_role: "Arn",
|
2903
|
+
# },
|
2904
|
+
# record_marker_decision_attributes: {
|
2905
|
+
# marker_name: "MarkerName", # required
|
2906
|
+
# details: "Data",
|
2907
|
+
# },
|
2908
|
+
# start_timer_decision_attributes: {
|
2909
|
+
# timer_id: "TimerId", # required
|
2910
|
+
# control: "Data",
|
2911
|
+
# start_to_fire_timeout: "DurationInSeconds", # required
|
2912
|
+
# },
|
2913
|
+
# cancel_timer_decision_attributes: {
|
2914
|
+
# timer_id: "TimerId", # required
|
2915
|
+
# },
|
2916
|
+
# signal_external_workflow_execution_decision_attributes: {
|
2917
|
+
# workflow_id: "WorkflowId", # required
|
2918
|
+
# run_id: "RunIdOptional",
|
2919
|
+
# signal_name: "SignalName", # required
|
2920
|
+
# input: "Data",
|
2921
|
+
# control: "Data",
|
2922
|
+
# },
|
2923
|
+
# request_cancel_external_workflow_execution_decision_attributes: {
|
2924
|
+
# workflow_id: "WorkflowId", # required
|
2925
|
+
# run_id: "RunIdOptional",
|
2926
|
+
# control: "Data",
|
2927
|
+
# },
|
2928
|
+
# start_child_workflow_execution_decision_attributes: {
|
2929
|
+
# workflow_type: { # required
|
2930
|
+
# name: "Name", # required
|
2931
|
+
# version: "Version", # required
|
2932
|
+
# },
|
2933
|
+
# workflow_id: "WorkflowId", # required
|
2934
|
+
# control: "Data",
|
2935
|
+
# input: "Data",
|
2936
|
+
# execution_start_to_close_timeout: "DurationInSecondsOptional",
|
2937
|
+
# task_list: {
|
2938
|
+
# name: "Name", # required
|
2939
|
+
# },
|
2940
|
+
# task_priority: "TaskPriority",
|
2941
|
+
# task_start_to_close_timeout: "DurationInSecondsOptional",
|
2942
|
+
# child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
|
2943
|
+
# tag_list: ["Tag"],
|
2944
|
+
# lambda_role: "Arn",
|
2945
|
+
# },
|
2946
|
+
# schedule_lambda_function_decision_attributes: {
|
2947
|
+
# id: "FunctionId", # required
|
2948
|
+
# name: "FunctionName", # required
|
2949
|
+
# input: "FunctionInput",
|
2950
|
+
# start_to_close_timeout: "DurationInSecondsOptional",
|
2951
|
+
# },
|
2952
|
+
# },
|
2953
|
+
# ],
|
2954
|
+
# execution_context: "Data",
|
2955
|
+
# })
|
2956
|
+
# @overload respond_decision_task_completed(params = {})
|
2957
|
+
# @param [Hash] params ({})
|
2958
|
+
def respond_decision_task_completed(params = {}, options = {})
|
2959
|
+
req = build_request(:respond_decision_task_completed, params)
|
2960
|
+
req.send_request(options)
|
2961
|
+
end
|
2962
|
+
|
2963
|
+
# Records a `WorkflowExecutionSignaled` event in the workflow execution
|
2964
|
+
# history and creates a decision task for the workflow execution
|
2965
|
+
# identified by the given domain, workflowId and runId. The event is
|
2966
|
+
# recorded with the specified user defined signalName and input (if
|
2967
|
+
# provided).
|
2968
|
+
#
|
2969
|
+
# <note> If a runId is not specified, then the `WorkflowExecutionSignaled` event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note>
|
2970
|
+
#
|
2971
|
+
# <note> If the specified workflow execution is not open, this method fails with `UnknownResource`.</note>
|
2972
|
+
#
|
2973
|
+
# **Access Control**
|
2974
|
+
#
|
2975
|
+
# You can use IAM policies to control this action's access to Amazon
|
2976
|
+
# SWF resources as follows:
|
2977
|
+
#
|
2978
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
2979
|
+
# only specified domains.
|
2980
|
+
# * Use an `Action` element to allow or deny permission to call this
|
2981
|
+
# action.
|
2982
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
2983
|
+
#
|
2984
|
+
# If the caller does not have sufficient permissions to invoke the
|
2985
|
+
# action, or the parameter values fall outside the specified
|
2986
|
+
# constraints, the action fails. The associated event attribute's
|
2987
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
2988
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
2989
|
+
# Amazon SWF Workflows][1].
|
2990
|
+
#
|
2991
|
+
#
|
2992
|
+
#
|
2993
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
2994
|
+
# @option params [required, String] :domain
|
2995
|
+
# The name of the domain containing the workflow execution to signal.
|
2996
|
+
# @option params [required, String] :workflow_id
|
2997
|
+
# The workflowId of the workflow execution to signal.
|
2998
|
+
# @option params [String] :run_id
|
2999
|
+
# The runId of the workflow execution to signal.
|
3000
|
+
# @option params [required, String] :signal_name
|
3001
|
+
# The name of the signal. This name must be meaningful to the target
|
3002
|
+
# workflow.
|
3003
|
+
# @option params [String] :input
|
3004
|
+
# Data to attach to the `WorkflowExecutionSignaled` event in the target
|
3005
|
+
# workflow execution's history.
|
3006
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3007
|
+
#
|
3008
|
+
# @example Request syntax with placeholder values
|
3009
|
+
# resp = client.signal_workflow_execution({
|
3010
|
+
# domain: "DomainName", # required
|
3011
|
+
# workflow_id: "WorkflowId", # required
|
3012
|
+
# run_id: "RunIdOptional",
|
3013
|
+
# signal_name: "SignalName", # required
|
3014
|
+
# input: "Data",
|
3015
|
+
# })
|
3016
|
+
# @overload signal_workflow_execution(params = {})
|
3017
|
+
# @param [Hash] params ({})
|
3018
|
+
def signal_workflow_execution(params = {}, options = {})
|
3019
|
+
req = build_request(:signal_workflow_execution, params)
|
3020
|
+
req.send_request(options)
|
3021
|
+
end
|
3022
|
+
|
3023
|
+
# Starts an execution of the workflow type in the specified domain using
|
3024
|
+
# the provided `workflowId` and input data.
|
3025
|
+
#
|
3026
|
+
# This action returns the newly started workflow execution.
|
3027
|
+
#
|
3028
|
+
# **Access Control**
|
3029
|
+
#
|
3030
|
+
# You can use IAM policies to control this action's access to Amazon
|
3031
|
+
# SWF resources as follows:
|
3032
|
+
#
|
3033
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
3034
|
+
# only specified domains.
|
3035
|
+
# * Use an `Action` element to allow or deny permission to call this
|
3036
|
+
# action.
|
3037
|
+
# * Constrain the following parameters by using a `Condition` element
|
3038
|
+
# with the appropriate keys.
|
3039
|
+
# * `tagList.member.0`\: The key is `swf:tagList.member.0`.
|
3040
|
+
# * `tagList.member.1`\: The key is `swf:tagList.member.1`.
|
3041
|
+
# * `tagList.member.2`\: The key is `swf:tagList.member.2`.
|
3042
|
+
# * `tagList.member.3`\: The key is `swf:tagList.member.3`.
|
3043
|
+
# * `tagList.member.4`\: The key is `swf:tagList.member.4`.
|
3044
|
+
# * `taskList`\: String constraint. The key is `swf:taskList.name`.
|
3045
|
+
# * `workflowType.name`\: String constraint. The key is
|
3046
|
+
# `swf:workflowType.name`.
|
3047
|
+
# * `workflowType.version`\: String constraint. The key is
|
3048
|
+
# `swf:workflowType.version`.
|
3049
|
+
#
|
3050
|
+
# If the caller does not have sufficient permissions to invoke the
|
3051
|
+
# action, or the parameter values fall outside the specified
|
3052
|
+
# constraints, the action fails. The associated event attribute's
|
3053
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
3054
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
3055
|
+
# Amazon SWF Workflows][1].
|
3056
|
+
#
|
3057
|
+
#
|
3058
|
+
#
|
3059
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
3060
|
+
# @option params [required, String] :domain
|
3061
|
+
# The name of the domain in which the workflow execution is created.
|
3062
|
+
# @option params [required, String] :workflow_id
|
3063
|
+
# The user defined identifier associated with the workflow execution.
|
3064
|
+
# You can use this to associate a custom identifier with the workflow
|
3065
|
+
# execution. You may specify the same identifier if a workflow execution
|
3066
|
+
# is logically a *restart* of a previous execution. You cannot have two
|
3067
|
+
# open workflow executions with the same `workflowId` at the same time.
|
3068
|
+
#
|
3069
|
+
# The specified string must not start or end with whitespace. It must
|
3070
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
3071
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
3072
|
+
# must not contain the literal string quotarnquot.
|
3073
|
+
# @option params [required, Types::WorkflowType] :workflow_type
|
3074
|
+
# The type of the workflow to start.
|
3075
|
+
# @option params [Types::TaskList] :task_list
|
3076
|
+
# The task list to use for the decision tasks generated for this
|
3077
|
+
# workflow execution. This overrides the `defaultTaskList` specified
|
3078
|
+
# when registering the workflow type.
|
3079
|
+
#
|
3080
|
+
# <note>A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.</note>
|
3081
|
+
#
|
3082
|
+
# The specified string must not start or end with whitespace. It must
|
3083
|
+
# not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
|
3084
|
+
# control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
|
3085
|
+
# must not contain the literal string quotarnquot.
|
3086
|
+
# @option params [String] :task_priority
|
3087
|
+
# The task priority to use for this workflow execution. This will
|
3088
|
+
# override any default priority that was assigned when the workflow type
|
3089
|
+
# was registered. If not set, then the default task priority for the
|
3090
|
+
# workflow type will be used. Valid values are integers that range from
|
3091
|
+
# Java's `Integer.MIN_VALUE` (-2147483648) to `Integer.MAX_VALUE`
|
3092
|
+
# (2147483647). Higher numbers indicate higher priority.
|
3093
|
+
#
|
3094
|
+
# For more information about setting task priority, see [Setting Task
|
3095
|
+
# Priority][1] in the *Amazon Simple Workflow Developer Guide*.
|
3096
|
+
#
|
3097
|
+
#
|
3098
|
+
#
|
3099
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html
|
3100
|
+
# @option params [String] :input
|
3101
|
+
# The input for the workflow execution. This is a free form string which
|
3102
|
+
# should be meaningful to the workflow you are starting. This `input` is
|
3103
|
+
# made available to the new workflow execution in the
|
3104
|
+
# `WorkflowExecutionStarted` history event.
|
3105
|
+
# @option params [String] :execution_start_to_close_timeout
|
3106
|
+
# The total duration for this workflow execution. This overrides the
|
3107
|
+
# defaultExecutionStartToCloseTimeout specified when registering the
|
3108
|
+
# workflow type.
|
3109
|
+
#
|
3110
|
+
# The duration is specified in seconds; an integer greater than or equal
|
3111
|
+
# to 0. Exceeding this limit will cause the workflow execution to time
|
3112
|
+
# out. Unlike some of the other timeout parameters in Amazon SWF, you
|
3113
|
+
# cannot specify a value of "NONE" for this timeout; there is a
|
3114
|
+
# one-year max limit on the time that a workflow execution can run.
|
3115
|
+
#
|
3116
|
+
# <note> An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.</note>
|
3117
|
+
# @option params [Array<String>] :tag_list
|
3118
|
+
# The list of tags to associate with the workflow execution. You can
|
3119
|
+
# specify a maximum of 5 tags. You can list workflow executions with a
|
3120
|
+
# specific tag by calling ListOpenWorkflowExecutions or
|
3121
|
+
# ListClosedWorkflowExecutions and specifying a TagFilter.
|
3122
|
+
# @option params [String] :task_start_to_close_timeout
|
3123
|
+
# Specifies the maximum duration of decision tasks for this workflow
|
3124
|
+
# execution. This parameter overrides the
|
3125
|
+
# `defaultTaskStartToCloseTimout` specified when registering the
|
3126
|
+
# workflow type using RegisterWorkflowType.
|
3127
|
+
#
|
3128
|
+
# The duration is specified in seconds; an integer greater than or equal
|
3129
|
+
# to 0. The value "NONE" can be used to specify unlimited duration.
|
3130
|
+
#
|
3131
|
+
# <note>A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.</note>
|
3132
|
+
# @option params [String] :child_policy
|
3133
|
+
# If set, specifies the policy to use for the child workflow executions
|
3134
|
+
# of this workflow execution if it is terminated, by calling the
|
3135
|
+
# TerminateWorkflowExecution action explicitly or due to an expired
|
3136
|
+
# timeout. This policy overrides the default child policy specified when
|
3137
|
+
# registering the workflow type using RegisterWorkflowType.
|
3138
|
+
#
|
3139
|
+
# The supported child policies are:
|
3140
|
+
#
|
3141
|
+
# * **TERMINATE:** the child executions will be terminated.
|
3142
|
+
# * **REQUEST\_CANCEL:** a request to cancel will be attempted for each
|
3143
|
+
# child execution by recording a `WorkflowExecutionCancelRequested`
|
3144
|
+
# event in its history. It is up to the decider to take appropriate
|
3145
|
+
# actions when it receives an execution history with this event.
|
3146
|
+
# * **ABANDON:** no action will be taken. The child executions will
|
3147
|
+
# continue to run.
|
3148
|
+
#
|
3149
|
+
# <note>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.</note>
|
3150
|
+
# @option params [String] :lambda_role
|
3151
|
+
# The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda
|
3152
|
+
# functions.
|
3153
|
+
#
|
3154
|
+
# <note>In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.</note>
|
3155
|
+
# @return [Types::Run] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3156
|
+
#
|
3157
|
+
# * {Types::Run#run_id #runId} => String
|
3158
|
+
#
|
3159
|
+
# @example Request syntax with placeholder values
|
3160
|
+
# resp = client.start_workflow_execution({
|
3161
|
+
# domain: "DomainName", # required
|
3162
|
+
# workflow_id: "WorkflowId", # required
|
3163
|
+
# workflow_type: { # required
|
3164
|
+
# name: "Name", # required
|
3165
|
+
# version: "Version", # required
|
3166
|
+
# },
|
3167
|
+
# task_list: {
|
3168
|
+
# name: "Name", # required
|
3169
|
+
# },
|
3170
|
+
# task_priority: "TaskPriority",
|
3171
|
+
# input: "Data",
|
3172
|
+
# execution_start_to_close_timeout: "DurationInSecondsOptional",
|
3173
|
+
# tag_list: ["Tag"],
|
3174
|
+
# task_start_to_close_timeout: "DurationInSecondsOptional",
|
3175
|
+
# child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
|
3176
|
+
# lambda_role: "Arn",
|
3177
|
+
# })
|
3178
|
+
#
|
3179
|
+
# @example Response structure
|
3180
|
+
# resp.run_id #=> String
|
3181
|
+
# @overload start_workflow_execution(params = {})
|
3182
|
+
# @param [Hash] params ({})
|
3183
|
+
def start_workflow_execution(params = {}, options = {})
|
3184
|
+
req = build_request(:start_workflow_execution, params)
|
3185
|
+
req.send_request(options)
|
3186
|
+
end
|
3187
|
+
|
3188
|
+
# Records a `WorkflowExecutionTerminated` event and forces closure of
|
3189
|
+
# the workflow execution identified by the given domain, runId, and
|
3190
|
+
# workflowId. The child policy, registered with the workflow type or
|
3191
|
+
# specified when starting this execution, is applied to any open child
|
3192
|
+
# workflow executions of this workflow execution.
|
3193
|
+
#
|
3194
|
+
# If the identified workflow execution was in progress, it is terminated
|
3195
|
+
# immediately.
|
3196
|
+
#
|
3197
|
+
# <note> If a runId is not specified, then the `WorkflowExecutionTerminated` event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note>
|
3198
|
+
#
|
3199
|
+
# <note> You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.</note>
|
3200
|
+
#
|
3201
|
+
# **Access Control**
|
3202
|
+
#
|
3203
|
+
# You can use IAM policies to control this action's access to Amazon
|
3204
|
+
# SWF resources as follows:
|
3205
|
+
#
|
3206
|
+
# * Use a `Resource` element with the domain name to limit the action to
|
3207
|
+
# only specified domains.
|
3208
|
+
# * Use an `Action` element to allow or deny permission to call this
|
3209
|
+
# action.
|
3210
|
+
# * You cannot use an IAM policy to constrain this action's parameters.
|
3211
|
+
#
|
3212
|
+
# If the caller does not have sufficient permissions to invoke the
|
3213
|
+
# action, or the parameter values fall outside the specified
|
3214
|
+
# constraints, the action fails. The associated event attribute's
|
3215
|
+
# **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
|
3216
|
+
# details and example IAM policies, see [Using IAM to Manage Access to
|
3217
|
+
# Amazon SWF Workflows][1].
|
3218
|
+
#
|
3219
|
+
#
|
3220
|
+
#
|
3221
|
+
# [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html
|
3222
|
+
# @option params [required, String] :domain
|
3223
|
+
# The domain of the workflow execution to terminate.
|
3224
|
+
# @option params [required, String] :workflow_id
|
3225
|
+
# The workflowId of the workflow execution to terminate.
|
3226
|
+
# @option params [String] :run_id
|
3227
|
+
# The runId of the workflow execution to terminate.
|
3228
|
+
# @option params [String] :reason
|
3229
|
+
# *Optional.* A descriptive reason for terminating the workflow
|
3230
|
+
# execution.
|
3231
|
+
# @option params [String] :details
|
3232
|
+
# *Optional.* Details for terminating the workflow execution.
|
3233
|
+
# @option params [String] :child_policy
|
3234
|
+
# If set, specifies the policy to use for the child workflow executions
|
3235
|
+
# of the workflow execution being terminated. This policy overrides the
|
3236
|
+
# child policy specified for the workflow execution at registration time
|
3237
|
+
# or when starting the execution.
|
3238
|
+
#
|
3239
|
+
# The supported child policies are:
|
3240
|
+
#
|
3241
|
+
# * **TERMINATE:** the child executions will be terminated.
|
3242
|
+
# * **REQUEST\_CANCEL:** a request to cancel will be attempted for each
|
3243
|
+
# child execution by recording a `WorkflowExecutionCancelRequested`
|
3244
|
+
# event in its history. It is up to the decider to take appropriate
|
3245
|
+
# actions when it receives an execution history with this event.
|
3246
|
+
# * **ABANDON:** no action will be taken. The child executions will
|
3247
|
+
# continue to run.
|
3248
|
+
#
|
3249
|
+
# <note>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.</note>
|
3250
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3251
|
+
#
|
3252
|
+
# @example Request syntax with placeholder values
|
3253
|
+
# resp = client.terminate_workflow_execution({
|
3254
|
+
# domain: "DomainName", # required
|
3255
|
+
# workflow_id: "WorkflowId", # required
|
3256
|
+
# run_id: "RunIdOptional",
|
3257
|
+
# reason: "TerminateReason",
|
3258
|
+
# details: "Data",
|
3259
|
+
# child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
|
3260
|
+
# })
|
3261
|
+
# @overload terminate_workflow_execution(params = {})
|
3262
|
+
# @param [Hash] params ({})
|
3263
|
+
def terminate_workflow_execution(params = {}, options = {})
|
3264
|
+
req = build_request(:terminate_workflow_execution, params)
|
3265
|
+
req.send_request(options)
|
3266
|
+
end
|
3267
|
+
|
3268
|
+
# @!endgroup
|
3269
|
+
|
3270
|
+
# @param params ({})
|
3271
|
+
# @api private
|
3272
|
+
def build_request(operation_name, params = {})
|
3273
|
+
handlers = @handlers.for(operation_name)
|
3274
|
+
context = Seahorse::Client::RequestContext.new(
|
3275
|
+
operation_name: operation_name,
|
3276
|
+
operation: config.api.operation(operation_name),
|
3277
|
+
client: self,
|
3278
|
+
params: params,
|
3279
|
+
config: config)
|
3280
|
+
context[:gem_name] = 'aws-sdk-swf'
|
3281
|
+
context[:gem_version] = '1.0.0.rc1'
|
3282
|
+
Seahorse::Client::Request.new(handlers, context)
|
3283
|
+
end
|
3284
|
+
|
3285
|
+
# @api private
|
3286
|
+
# @deprecated
|
3287
|
+
def waiter_names
|
3288
|
+
[]
|
3289
|
+
end
|
3290
|
+
|
3291
|
+
class << self
|
3292
|
+
|
3293
|
+
# @api private
|
3294
|
+
attr_reader :identifier
|
3295
|
+
|
3296
|
+
# @api private
|
3297
|
+
def errors_module
|
3298
|
+
Errors
|
3299
|
+
end
|
3300
|
+
|
3301
|
+
end
|
3302
|
+
end
|
3303
|
+
end
|
3304
|
+
end
|