aws-sdk 1.13.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +3 -3
- data/lib/aws/api_config/OpsWorks-2013-02-18.yml +55 -0
- data/lib/aws/api_config/SNS-2010-03-31.yml +0 -3
- data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +30 -0
- data/lib/aws/auto_scaling/client.rb +0 -530
- data/lib/aws/cloud_formation/client.rb +0 -356
- data/lib/aws/cloud_front/client.rb +0 -1567
- data/lib/aws/cloud_search/client.rb +0 -578
- data/lib/aws/cloud_watch/client.rb +0 -445
- data/lib/aws/data_pipeline/client.rb +0 -396
- data/lib/aws/direct_connect/client.rb +0 -248
- data/lib/aws/dynamo_db.rb +0 -1
- data/lib/aws/dynamo_db/client.rb +70 -1
- data/lib/aws/dynamo_db/client_v2.rb +1 -1
- data/lib/aws/ec2/client.rb +0 -3942
- data/lib/aws/ec2/reserved_instances_offering_collection.rb +9 -3
- data/lib/aws/ec2/tag_collection.rb +1 -1
- data/lib/aws/elastic_beanstalk/client.rb +0 -898
- data/lib/aws/elastic_transcoder/client.rb +0 -1755
- data/lib/aws/elasticache/client.rb +0 -947
- data/lib/aws/elb/client.rb +0 -509
- data/lib/aws/emr/client.rb +0 -314
- data/lib/aws/glacier/client.rb +0 -278
- data/lib/aws/iam/client.rb +0 -1155
- data/lib/aws/import_export/client.rb +0 -96
- data/lib/aws/ops_works/client.rb +0 -1255
- data/lib/aws/rds/client.rb +0 -2367
- data/lib/aws/redshift/client.rb +0 -1458
- data/lib/aws/route_53/client.rb +0 -420
- data/lib/aws/simple_db/client.rb +2 -250
- data/lib/aws/simple_email_service/client.rb +0 -282
- data/lib/aws/simple_workflow/client.rb +0 -1248
- data/lib/aws/sns/client.rb +0 -283
- data/lib/aws/sns/message.rb +1 -1
- data/lib/aws/sqs/client.rb +0 -255
- data/lib/aws/storage_gateway/client.rb +0 -582
- data/lib/aws/sts/client.rb +0 -183
- data/lib/aws/support/client.rb +0 -232
- data/lib/aws/version.rb +1 -1
- metadata +2 -3
- data/lib/aws/dynamo_db/client_base.rb +0 -92
@@ -28,288 +28,6 @@ module AWS
|
|
28
28
|
|
29
29
|
class Client::V20101201 < Client
|
30
30
|
|
31
|
-
# client methods #
|
32
|
-
|
33
|
-
# @!method delete_identity(options = {})
|
34
|
-
# Calls the DeleteIdentity API operation.
|
35
|
-
# @param [Hash] options
|
36
|
-
#
|
37
|
-
# * `:identity` - *required* - (String) The identity to be removed from
|
38
|
-
# the list of identities for the AWS Account.
|
39
|
-
# @return [Core::Response]
|
40
|
-
|
41
|
-
# @!method delete_verified_email_address(options = {})
|
42
|
-
# Calls the DeleteVerifiedEmailAddress API operation.
|
43
|
-
# @param [Hash] options
|
44
|
-
#
|
45
|
-
# * `:email_address` - *required* - (String) An email address to be
|
46
|
-
# removed from the list of verified addresses.
|
47
|
-
# @return [Core::Response]
|
48
|
-
|
49
|
-
# @!method get_identity_dkim_attributes(options = {})
|
50
|
-
# Calls the GetIdentityDkimAttributes API operation.
|
51
|
-
# @param [Hash] options
|
52
|
-
#
|
53
|
-
# * `:identities` - *required* - (Array<String>) A list of one or more
|
54
|
-
# verified identities - email addresses, domains, or both.
|
55
|
-
# @return [Core::Response]
|
56
|
-
# The #data method of the response object returns
|
57
|
-
# a hash with the following structure:
|
58
|
-
#
|
59
|
-
# * `:dkim_attributes` - (Hash<String,Hash>)
|
60
|
-
# * `:dkim_enabled` - (Boolean)
|
61
|
-
# * `:dkim_verification_status` - (String)
|
62
|
-
# * `:dkim_tokens` - (Array<String>)
|
63
|
-
|
64
|
-
# @!method get_identity_notification_attributes(options = {})
|
65
|
-
# Calls the GetIdentityNotificationAttributes API operation.
|
66
|
-
# @param [Hash] options
|
67
|
-
#
|
68
|
-
# * `:identities` - *required* - (Array<String>) A list of one or more
|
69
|
-
# identities.
|
70
|
-
# @return [Core::Response]
|
71
|
-
# The #data method of the response object returns
|
72
|
-
# a hash with the following structure:
|
73
|
-
#
|
74
|
-
# * `:notification_attributes` - (Hash<String,Hash>)
|
75
|
-
# * `:bounce_topic` - (String)
|
76
|
-
# * `:complaint_topic` - (String)
|
77
|
-
# * `:forwarding_enabled` - (Boolean)
|
78
|
-
|
79
|
-
# @!method get_identity_verification_attributes(options = {})
|
80
|
-
# Calls the GetIdentityVerificationAttributes API operation.
|
81
|
-
# @param [Hash] options
|
82
|
-
#
|
83
|
-
# * `:identities` - *required* - (Array<String>) A list of identities.
|
84
|
-
# @return [Core::Response]
|
85
|
-
# The #data method of the response object returns
|
86
|
-
# a hash with the following structure:
|
87
|
-
#
|
88
|
-
# * `:verification_attributes` - (Hash<String,Hash>)
|
89
|
-
# * `:verification_status` - (String)
|
90
|
-
# * `:verification_token` - (String)
|
91
|
-
|
92
|
-
# @!method get_send_quota(options = {})
|
93
|
-
# Calls the GetSendQuota API operation.
|
94
|
-
# @param [Hash] options
|
95
|
-
#
|
96
|
-
# @return [Core::Response]
|
97
|
-
# The #data method of the response object returns
|
98
|
-
# a hash with the following structure:
|
99
|
-
#
|
100
|
-
# * `:max_24_hour_send` - (Numeric)
|
101
|
-
# * `:max_send_rate` - (Numeric)
|
102
|
-
# * `:sent_last_24_hours` - (Numeric)
|
103
|
-
|
104
|
-
# @!method get_send_statistics(options = {})
|
105
|
-
# Calls the GetSendStatistics API operation.
|
106
|
-
# @param [Hash] options
|
107
|
-
#
|
108
|
-
# @return [Core::Response]
|
109
|
-
# The #data method of the response object returns
|
110
|
-
# a hash with the following structure:
|
111
|
-
#
|
112
|
-
# * `:send_data_points` - (Array<Hash>)
|
113
|
-
# * `:timestamp` - (Time)
|
114
|
-
# * `:delivery_attempts` - (Integer)
|
115
|
-
# * `:bounces` - (Integer)
|
116
|
-
# * `:complaints` - (Integer)
|
117
|
-
# * `:rejects` - (Integer)
|
118
|
-
|
119
|
-
# @!method list_identities(options = {})
|
120
|
-
# Calls the ListIdentities API operation.
|
121
|
-
# @param [Hash] options
|
122
|
-
#
|
123
|
-
# * `:identity_type` - (String) The type of the identities to list.
|
124
|
-
# Possible values are "EmailAddress" and "Domain". If this parameter
|
125
|
-
# is omitted, then all identities will be listed. Valid values
|
126
|
-
# include:
|
127
|
-
# * `EmailAddress`
|
128
|
-
# * `Domain`
|
129
|
-
# * `:next_token` - (String) The token to use for pagination.
|
130
|
-
# * `:max_items` - (Integer) The maximum number of identities per page.
|
131
|
-
# Possible values are 1-100 inclusive.
|
132
|
-
# @return [Core::Response]
|
133
|
-
# The #data method of the response object returns
|
134
|
-
# a hash with the following structure:
|
135
|
-
#
|
136
|
-
# * `:identities` - (Array<String>)
|
137
|
-
# * `:next_token` - (String)
|
138
|
-
|
139
|
-
# @!method list_verified_email_addresses(options = {})
|
140
|
-
# Calls the ListVerifiedEmailAddresses API operation.
|
141
|
-
# @param [Hash] options
|
142
|
-
#
|
143
|
-
# @return [Core::Response]
|
144
|
-
# The #data method of the response object returns
|
145
|
-
# a hash with the following structure:
|
146
|
-
#
|
147
|
-
# * `:verified_email_addresses` - (Array<String>)
|
148
|
-
|
149
|
-
# @!method send_email(options = {})
|
150
|
-
# Calls the SendEmail API operation.
|
151
|
-
# @param [Hash] options
|
152
|
-
#
|
153
|
-
# * `:source` - *required* - (String) The identity's email address.
|
154
|
-
# * `:destination` - *required* - (Hash) The destination for this
|
155
|
-
# email, composed of To:, CC:, and BCC: fields.
|
156
|
-
# * `:to_addresses` - (Array<String>) The To: field(s) of the
|
157
|
-
# message.
|
158
|
-
# * `:cc_addresses` - (Array<String>) The CC: field(s) of the
|
159
|
-
# message.
|
160
|
-
# * `:bcc_addresses` - (Array<String>) The BCC: field(s) of the
|
161
|
-
# message.
|
162
|
-
# * `:message` - *required* - (Hash) The message to be sent.
|
163
|
-
# * `:subject` - *required* - (Hash) The subject of the message: A
|
164
|
-
# short summary of the content, which will appear in the
|
165
|
-
# recipient's inbox.
|
166
|
-
# * `:data` - *required* - (String) The textual data of the
|
167
|
-
# content.
|
168
|
-
# * `:charset` - (String) The character set of the content.
|
169
|
-
# * `:body` - *required* - (Hash) The message body.
|
170
|
-
# * `:text` - (Hash) The content of the message, in text format.
|
171
|
-
# Use this for text-based email clients, or clients on
|
172
|
-
# high-latency networks (such as mobile devices).
|
173
|
-
# * `:data` - *required* - (String) The textual data of the
|
174
|
-
# content.
|
175
|
-
# * `:charset` - (String) The character set of the content.
|
176
|
-
# * `:html` - (Hash) The content of the message, in HTML format.
|
177
|
-
# Use this for email clients that can process HTML. You can
|
178
|
-
# include clickable links, formatted text, and much more in an
|
179
|
-
# HTML message.
|
180
|
-
# * `:data` - *required* - (String) The textual data of the
|
181
|
-
# content.
|
182
|
-
# * `:charset` - (String) The character set of the content.
|
183
|
-
# * `:reply_to_addresses` - (Array<String>) The reply-to email
|
184
|
-
# address(es) for the message. If the recipient replies to the
|
185
|
-
# message, each reply-to address will receive the reply.
|
186
|
-
# * `:return_path` - (String) The email address to which bounce
|
187
|
-
# notifications are to be forwarded. If the message cannot be
|
188
|
-
# delivered to the recipient, then an error message will be returned
|
189
|
-
# from the recipient's ISP; this message will then be forwarded to
|
190
|
-
# the email address specified by the ReturnPath parameter.
|
191
|
-
# @return [Core::Response]
|
192
|
-
# The #data method of the response object returns
|
193
|
-
# a hash with the following structure:
|
194
|
-
#
|
195
|
-
# * `:message_id` - (String)
|
196
|
-
|
197
|
-
# @!method send_raw_email(options = {})
|
198
|
-
# Calls the SendRawEmail API operation.
|
199
|
-
# @param [Hash] options
|
200
|
-
#
|
201
|
-
# * `:source` - (String) The identity's email address. If you specify
|
202
|
-
# the Source parameter, then bounce notifications and complaints will
|
203
|
-
# be sent to this email address. This takes precedence over any
|
204
|
-
# Return-Path header that you might include in the raw text of the
|
205
|
-
# message.
|
206
|
-
# * `:destinations` - (Array<String>) A list of destinations for the
|
207
|
-
# message.
|
208
|
-
# * `:raw_message` - *required* - (Hash) The raw text of the message.
|
209
|
-
# The client is responsible for ensuring the following: Message must
|
210
|
-
# contain a header and a body, separated by a blank line. All
|
211
|
-
# required header fields must be present. Each part of a multipart
|
212
|
-
# MIME message must be formatted properly. MIME content types must be
|
213
|
-
# among those supported by Amazon SES. Refer to the Amazon SES
|
214
|
-
# Developer Guide for more details. Content must be base64-encoded,
|
215
|
-
# if MIME requires it.
|
216
|
-
# * `:data` - *required* - (String) The raw data of the message. The
|
217
|
-
# client must ensure that the message format complies with Internet
|
218
|
-
# email standards regarding email header fields, MIME types, MIME
|
219
|
-
# encoding, and base64 encoding (if necessary). For more
|
220
|
-
# information, go to theAmazon SES Developer Guide.
|
221
|
-
# @return [Core::Response]
|
222
|
-
# The #data method of the response object returns
|
223
|
-
# a hash with the following structure:
|
224
|
-
#
|
225
|
-
# * `:message_id` - (String)
|
226
|
-
|
227
|
-
# @!method set_identity_dkim_enabled(options = {})
|
228
|
-
# Calls the SetIdentityDkimEnabled API operation.
|
229
|
-
# @param [Hash] options
|
230
|
-
#
|
231
|
-
# * `:identity` - *required* - (String) The identity for which DKIM
|
232
|
-
# signing should be enabled or disabled.
|
233
|
-
# * `:dkim_enabled` - *required* - (Boolean) Sets whether DKIM signing
|
234
|
-
# is enabled for an identity. Set to `true` to enable DKIM signing
|
235
|
-
# for this identity; `false` to disable it.
|
236
|
-
# @return [Core::Response]
|
237
|
-
|
238
|
-
# @!method set_identity_feedback_forwarding_enabled(options = {})
|
239
|
-
# Calls the SetIdentityFeedbackForwardingEnabled API operation.
|
240
|
-
# @param [Hash] options
|
241
|
-
#
|
242
|
-
# * `:identity` - *required* - (String) The identity for which to set
|
243
|
-
# feedback notification forwarding. Examples: user@example.com,
|
244
|
-
# example.com.
|
245
|
-
# * `:forwarding_enabled` - *required* - (Boolean) Sets whether Amazon
|
246
|
-
# SES will forward feedback notifications as email. `true` specifies
|
247
|
-
# that Amazon SES will forward feedback notifications as email, in
|
248
|
-
# addition to any Amazon SNS topic publishing otherwise specified.
|
249
|
-
# `false` specifies that Amazon SES will publish feedback
|
250
|
-
# notifications only through Amazon SNS. This value can only be set
|
251
|
-
# to `false` when topics are specified for both Bounce and Complaint
|
252
|
-
# topic types.
|
253
|
-
# @return [Core::Response]
|
254
|
-
|
255
|
-
# @!method set_identity_notification_topic(options = {})
|
256
|
-
# Calls the SetIdentityNotificationTopic API operation.
|
257
|
-
# @param [Hash] options
|
258
|
-
#
|
259
|
-
# * `:identity` - *required* - (String) The identity for which the
|
260
|
-
# topic will be set. Examples: user@example.com, example.com.
|
261
|
-
# * `:notification_type` - *required* - (String) The type of feedback
|
262
|
-
# notifications that will be published to the specified topic. Valid
|
263
|
-
# values include:
|
264
|
-
# * `Bounce`
|
265
|
-
# * `Complaint`
|
266
|
-
# * `:sns_topic` - (String) The Amazon Resource Name (ARN) of the
|
267
|
-
# Amazon Simple Notification Service (Amazon SNS) topic. If the
|
268
|
-
# parameter is ommited from the request or a null value is passed,
|
269
|
-
# the topic is cleared and publishing is disabled.
|
270
|
-
# @return [Core::Response]
|
271
|
-
|
272
|
-
# @!method verify_domain_dkim(options = {})
|
273
|
-
# Calls the VerifyDomainDkim API operation.
|
274
|
-
# @param [Hash] options
|
275
|
-
#
|
276
|
-
# * `:domain` - *required* - (String) The name of the domain to be
|
277
|
-
# verified for Easy DKIM signing.
|
278
|
-
# @return [Core::Response]
|
279
|
-
# The #data method of the response object returns
|
280
|
-
# a hash with the following structure:
|
281
|
-
#
|
282
|
-
# * `:dkim_tokens` - (Array<String>)
|
283
|
-
|
284
|
-
# @!method verify_domain_identity(options = {})
|
285
|
-
# Calls the VerifyDomainIdentity API operation.
|
286
|
-
# @param [Hash] options
|
287
|
-
#
|
288
|
-
# * `:domain` - *required* - (String) The domain to be verified.
|
289
|
-
# @return [Core::Response]
|
290
|
-
# The #data method of the response object returns
|
291
|
-
# a hash with the following structure:
|
292
|
-
#
|
293
|
-
# * `:verification_token` - (String)
|
294
|
-
|
295
|
-
# @!method verify_email_address(options = {})
|
296
|
-
# Calls the VerifyEmailAddress API operation.
|
297
|
-
# @param [Hash] options
|
298
|
-
#
|
299
|
-
# * `:email_address` - *required* - (String) The email address to be
|
300
|
-
# verified.
|
301
|
-
# @return [Core::Response]
|
302
|
-
|
303
|
-
# @!method verify_email_identity(options = {})
|
304
|
-
# Calls the VerifyEmailIdentity API operation.
|
305
|
-
# @param [Hash] options
|
306
|
-
#
|
307
|
-
# * `:email_address` - *required* - (String) The email address to be
|
308
|
-
# verified.
|
309
|
-
# @return [Core::Response]
|
310
|
-
|
311
|
-
# end client methods #
|
312
|
-
|
313
31
|
define_client_methods('2010-12-01')
|
314
32
|
|
315
33
|
end
|
@@ -60,1254 +60,6 @@ module AWS
|
|
60
60
|
|
61
61
|
class Client::V20120125 < Client
|
62
62
|
|
63
|
-
# client methods #
|
64
|
-
|
65
|
-
# @!method count_closed_workflow_executions(options = {})
|
66
|
-
# Calls the CountClosedWorkflowExecutions API operation.
|
67
|
-
# @param [Hash] options
|
68
|
-
#
|
69
|
-
# * `:domain` - *required* - (String)
|
70
|
-
# * `:start_time_filter` - (Hash)
|
71
|
-
# * `:oldest_date` - *required* - (Integer<unix timestamp>)
|
72
|
-
# * `:latest_date` - (Integer<unix timestamp>)
|
73
|
-
# * `:close_time_filter` - (Hash)
|
74
|
-
# * `:oldest_date` - *required* - (Integer<unix timestamp>)
|
75
|
-
# * `:latest_date` - (Integer<unix timestamp>)
|
76
|
-
# * `:execution_filter` - (Hash)
|
77
|
-
# * `:workflow_id` - *required* - (String)
|
78
|
-
# * `:type_filter` - (Hash)
|
79
|
-
# * `:name` - *required* - (String)
|
80
|
-
# * `:version` - (String)
|
81
|
-
# * `:tag_filter` - (Hash)
|
82
|
-
# * `:tag` - *required* - (String)
|
83
|
-
# * `:close_status_filter` - (Hash)
|
84
|
-
# * `:status` - *required* - (String) Valid values include:
|
85
|
-
# * `COMPLETED`
|
86
|
-
# * `FAILED`
|
87
|
-
# * `CANCELED`
|
88
|
-
# * `TERMINATED`
|
89
|
-
# * `CONTINUED_AS_NEW`
|
90
|
-
# * `TIMED_OUT`
|
91
|
-
# @return [Core::Response]
|
92
|
-
# The #data method of the response object returns
|
93
|
-
# a hash with the following structure:
|
94
|
-
#
|
95
|
-
# * `count` - (Integer)
|
96
|
-
# * `truncated` - (Boolean)
|
97
|
-
|
98
|
-
# @!method count_open_workflow_executions(options = {})
|
99
|
-
# Calls the CountOpenWorkflowExecutions API operation.
|
100
|
-
# @param [Hash] options
|
101
|
-
#
|
102
|
-
# * `:domain` - *required* - (String)
|
103
|
-
# * `:start_time_filter` - *required* - (Hash)
|
104
|
-
# * `:oldest_date` - *required* - (Integer<unix timestamp>)
|
105
|
-
# * `:latest_date` - (Integer<unix timestamp>)
|
106
|
-
# * `:type_filter` - (Hash)
|
107
|
-
# * `:name` - *required* - (String)
|
108
|
-
# * `:version` - (String)
|
109
|
-
# * `:tag_filter` - (Hash)
|
110
|
-
# * `:tag` - *required* - (String)
|
111
|
-
# * `:execution_filter` - (Hash)
|
112
|
-
# * `:workflow_id` - *required* - (String)
|
113
|
-
# @return [Core::Response]
|
114
|
-
# The #data method of the response object returns
|
115
|
-
# a hash with the following structure:
|
116
|
-
#
|
117
|
-
# * `count` - (Integer)
|
118
|
-
# * `truncated` - (Boolean)
|
119
|
-
|
120
|
-
# @!method count_pending_activity_tasks(options = {})
|
121
|
-
# Calls the CountPendingActivityTasks API operation.
|
122
|
-
# @param [Hash] options
|
123
|
-
#
|
124
|
-
# * `:domain` - *required* - (String)
|
125
|
-
# * `:task_list` - *required* - (Hash)
|
126
|
-
# * `:name` - *required* - (String)
|
127
|
-
# @return [Core::Response]
|
128
|
-
# The #data method of the response object returns
|
129
|
-
# a hash with the following structure:
|
130
|
-
#
|
131
|
-
# * `count` - (Integer)
|
132
|
-
# * `truncated` - (Boolean)
|
133
|
-
|
134
|
-
# @!method count_pending_decision_tasks(options = {})
|
135
|
-
# Calls the CountPendingDecisionTasks API operation.
|
136
|
-
# @param [Hash] options
|
137
|
-
#
|
138
|
-
# * `:domain` - *required* - (String)
|
139
|
-
# * `:task_list` - *required* - (Hash)
|
140
|
-
# * `:name` - *required* - (String)
|
141
|
-
# @return [Core::Response]
|
142
|
-
# The #data method of the response object returns
|
143
|
-
# a hash with the following structure:
|
144
|
-
#
|
145
|
-
# * `count` - (Integer)
|
146
|
-
# * `truncated` - (Boolean)
|
147
|
-
|
148
|
-
# @!method deprecate_activity_type(options = {})
|
149
|
-
# Calls the DeprecateActivityType API operation.
|
150
|
-
# @param [Hash] options
|
151
|
-
#
|
152
|
-
# * `:domain` - *required* - (String)
|
153
|
-
# * `:activity_type` - *required* - (Hash)
|
154
|
-
# * `:name` - *required* - (String)
|
155
|
-
# * `:version` - *required* - (String)
|
156
|
-
# @return [Core::Response]
|
157
|
-
|
158
|
-
# @!method deprecate_domain(options = {})
|
159
|
-
# Calls the DeprecateDomain API operation.
|
160
|
-
# @param [Hash] options
|
161
|
-
#
|
162
|
-
# * `:name` - *required* - (String)
|
163
|
-
# @return [Core::Response]
|
164
|
-
|
165
|
-
# @!method deprecate_workflow_type(options = {})
|
166
|
-
# Calls the DeprecateWorkflowType API operation.
|
167
|
-
# @param [Hash] options
|
168
|
-
#
|
169
|
-
# * `:domain` - *required* - (String)
|
170
|
-
# * `:workflow_type` - *required* - (Hash)
|
171
|
-
# * `:name` - *required* - (String)
|
172
|
-
# * `:version` - *required* - (String)
|
173
|
-
# @return [Core::Response]
|
174
|
-
|
175
|
-
# @!method describe_activity_type(options = {})
|
176
|
-
# Calls the DescribeActivityType API operation.
|
177
|
-
# @param [Hash] options
|
178
|
-
#
|
179
|
-
# * `:domain` - *required* - (String)
|
180
|
-
# * `:activity_type` - *required* - (Hash)
|
181
|
-
# * `:name` - *required* - (String)
|
182
|
-
# * `:version` - *required* - (String)
|
183
|
-
# @return [Core::Response]
|
184
|
-
# The #data method of the response object returns
|
185
|
-
# a hash with the following structure:
|
186
|
-
#
|
187
|
-
# * `typeInfo` - (Hash)
|
188
|
-
# * `activityType` - (Hash)
|
189
|
-
# * `name` - (String)
|
190
|
-
# * `version` - (String)
|
191
|
-
# * `status` - (String)
|
192
|
-
# * `description` - (String)
|
193
|
-
# * `creationDate` - (Time)
|
194
|
-
# * `deprecationDate` - (Time)
|
195
|
-
# * `configuration` - (Hash)
|
196
|
-
# * `defaultTaskStartToCloseTimeout` - (String)
|
197
|
-
# * `defaultTaskHeartbeatTimeout` - (String)
|
198
|
-
# * `defaultTaskList` - (Hash)
|
199
|
-
# * `name` - (String)
|
200
|
-
# * `defaultTaskScheduleToStartTimeout` - (String)
|
201
|
-
# * `defaultTaskScheduleToCloseTimeout` - (String)
|
202
|
-
|
203
|
-
# @!method describe_domain(options = {})
|
204
|
-
# Calls the DescribeDomain API operation.
|
205
|
-
# @param [Hash] options
|
206
|
-
#
|
207
|
-
# * `:name` - *required* - (String)
|
208
|
-
# @return [Core::Response]
|
209
|
-
# The #data method of the response object returns
|
210
|
-
# a hash with the following structure:
|
211
|
-
#
|
212
|
-
# * `domainInfo` - (Hash)
|
213
|
-
# * `name` - (String)
|
214
|
-
# * `status` - (String)
|
215
|
-
# * `description` - (String)
|
216
|
-
# * `configuration` - (Hash)
|
217
|
-
# * `workflowExecutionRetentionPeriodInDays` - (String)
|
218
|
-
|
219
|
-
# @!method describe_workflow_execution(options = {})
|
220
|
-
# Calls the DescribeWorkflowExecution API operation.
|
221
|
-
# @param [Hash] options
|
222
|
-
#
|
223
|
-
# * `:domain` - *required* - (String)
|
224
|
-
# * `:execution` - *required* - (Hash)
|
225
|
-
# * `:workflow_id` - *required* - (String)
|
226
|
-
# * `:run_id` - *required* - (String)
|
227
|
-
# @return [Core::Response]
|
228
|
-
# The #data method of the response object returns
|
229
|
-
# a hash with the following structure:
|
230
|
-
#
|
231
|
-
# * `executionInfo` - (Hash)
|
232
|
-
# * `execution` - (Hash)
|
233
|
-
# * `workflowId` - (String)
|
234
|
-
# * `runId` - (String)
|
235
|
-
# * `workflowType` - (Hash)
|
236
|
-
# * `name` - (String)
|
237
|
-
# * `version` - (String)
|
238
|
-
# * `startTimestamp` - (Time)
|
239
|
-
# * `closeTimestamp` - (Time)
|
240
|
-
# * `executionStatus` - (String)
|
241
|
-
# * `closeStatus` - (String)
|
242
|
-
# * `parent` - (Hash)
|
243
|
-
# * `workflowId` - (String)
|
244
|
-
# * `runId` - (String)
|
245
|
-
# * `tagList` - (Array<String>)
|
246
|
-
# * `cancelRequested` - (Boolean)
|
247
|
-
# * `executionConfiguration` - (Hash)
|
248
|
-
# * `taskStartToCloseTimeout` - (String)
|
249
|
-
# * `executionStartToCloseTimeout` - (String)
|
250
|
-
# * `taskList` - (Hash)
|
251
|
-
# * `name` - (String)
|
252
|
-
# * `childPolicy` - (String)
|
253
|
-
# * `openCounts` - (Hash)
|
254
|
-
# * `openActivityTasks` - (Integer)
|
255
|
-
# * `openDecisionTasks` - (Integer)
|
256
|
-
# * `openTimers` - (Integer)
|
257
|
-
# * `openChildWorkflowExecutions` - (Integer)
|
258
|
-
# * `latestActivityTaskTimestamp` - (Time)
|
259
|
-
# * `latestExecutionContext` - (String)
|
260
|
-
|
261
|
-
# @!method describe_workflow_type(options = {})
|
262
|
-
# Calls the DescribeWorkflowType API operation.
|
263
|
-
# @param [Hash] options
|
264
|
-
#
|
265
|
-
# * `:domain` - *required* - (String)
|
266
|
-
# * `:workflow_type` - *required* - (Hash)
|
267
|
-
# * `:name` - *required* - (String)
|
268
|
-
# * `:version` - *required* - (String)
|
269
|
-
# @return [Core::Response]
|
270
|
-
# The #data method of the response object returns
|
271
|
-
# a hash with the following structure:
|
272
|
-
#
|
273
|
-
# * `typeInfo` - (Hash)
|
274
|
-
# * `workflowType` - (Hash)
|
275
|
-
# * `name` - (String)
|
276
|
-
# * `version` - (String)
|
277
|
-
# * `status` - (String)
|
278
|
-
# * `description` - (String)
|
279
|
-
# * `creationDate` - (Time)
|
280
|
-
# * `deprecationDate` - (Time)
|
281
|
-
# * `configuration` - (Hash)
|
282
|
-
# * `defaultTaskStartToCloseTimeout` - (String)
|
283
|
-
# * `defaultExecutionStartToCloseTimeout` - (String)
|
284
|
-
# * `defaultTaskList` - (Hash)
|
285
|
-
# * `name` - (String)
|
286
|
-
# * `defaultChildPolicy` - (String)
|
287
|
-
|
288
|
-
# @!method get_workflow_execution_history(options = {})
|
289
|
-
# Calls the GetWorkflowExecutionHistory API operation.
|
290
|
-
# @param [Hash] options
|
291
|
-
#
|
292
|
-
# * `:domain` - *required* - (String)
|
293
|
-
# * `:execution` - *required* - (Hash)
|
294
|
-
# * `:workflow_id` - *required* - (String)
|
295
|
-
# * `:run_id` - *required* - (String)
|
296
|
-
# * `:next_page_token` - (String)
|
297
|
-
# * `:maximum_page_size` - (Integer)
|
298
|
-
# * `:reverse_order` - (Boolean)
|
299
|
-
# @return [Core::Response]
|
300
|
-
# The #data method of the response object returns
|
301
|
-
# a hash with the following structure:
|
302
|
-
#
|
303
|
-
# * `events` - (Array<Hash>)
|
304
|
-
# * `eventTimestamp` - (Time)
|
305
|
-
# * `eventType` - (String)
|
306
|
-
# * `eventId` - (Integer)
|
307
|
-
# * `workflowExecutionStartedEventAttributes` - (Hash)
|
308
|
-
# * `input` - (String)
|
309
|
-
# * `executionStartToCloseTimeout` - (String)
|
310
|
-
# * `taskStartToCloseTimeout` - (String)
|
311
|
-
# * `childPolicy` - (String)
|
312
|
-
# * `taskList` - (Hash)
|
313
|
-
# * `name` - (String)
|
314
|
-
# * `workflowType` - (Hash)
|
315
|
-
# * `name` - (String)
|
316
|
-
# * `version` - (String)
|
317
|
-
# * `tagList` - (Array<String>)
|
318
|
-
# * `continuedExecutionRunId` - (String)
|
319
|
-
# * `parentWorkflowExecution` - (Hash)
|
320
|
-
# * `workflowId` - (String)
|
321
|
-
# * `runId` - (String)
|
322
|
-
# * `parentInitiatedEventId` - (Integer)
|
323
|
-
# * `workflowExecutionCompletedEventAttributes` - (Hash)
|
324
|
-
# * `result` - (String)
|
325
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
326
|
-
# * `completeWorkflowExecutionFailedEventAttributes` - (Hash)
|
327
|
-
# * `cause` - (String)
|
328
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
329
|
-
# * `workflowExecutionFailedEventAttributes` - (Hash)
|
330
|
-
# * `reason` - (String)
|
331
|
-
# * `details` - (String)
|
332
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
333
|
-
# * `failWorkflowExecutionFailedEventAttributes` - (Hash)
|
334
|
-
# * `cause` - (String)
|
335
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
336
|
-
# * `workflowExecutionTimedOutEventAttributes` - (Hash)
|
337
|
-
# * `timeoutType` - (String)
|
338
|
-
# * `childPolicy` - (String)
|
339
|
-
# * `workflowExecutionCanceledEventAttributes` - (Hash)
|
340
|
-
# * `details` - (String)
|
341
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
342
|
-
# * `cancelWorkflowExecutionFailedEventAttributes` - (Hash)
|
343
|
-
# * `cause` - (String)
|
344
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
345
|
-
# * `workflowExecutionContinuedAsNewEventAttributes` - (Hash)
|
346
|
-
# * `input` - (String)
|
347
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
348
|
-
# * `newExecutionRunId` - (String)
|
349
|
-
# * `executionStartToCloseTimeout` - (String)
|
350
|
-
# * `taskList` - (Hash)
|
351
|
-
# * `name` - (String)
|
352
|
-
# * `taskStartToCloseTimeout` - (String)
|
353
|
-
# * `childPolicy` - (String)
|
354
|
-
# * `tagList` - (Array<String>)
|
355
|
-
# * `workflowType` - (Hash)
|
356
|
-
# * `name` - (String)
|
357
|
-
# * `version` - (String)
|
358
|
-
# * `continueAsNewWorkflowExecutionFailedEventAttributes` - (Hash)
|
359
|
-
# * `cause` - (String)
|
360
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
361
|
-
# * `workflowExecutionTerminatedEventAttributes` - (Hash)
|
362
|
-
# * `reason` - (String)
|
363
|
-
# * `details` - (String)
|
364
|
-
# * `childPolicy` - (String)
|
365
|
-
# * `cause` - (String)
|
366
|
-
# * `workflowExecutionCancelRequestedEventAttributes` - (Hash)
|
367
|
-
# * `externalWorkflowExecution` - (Hash)
|
368
|
-
# * `workflowId` - (String)
|
369
|
-
# * `runId` - (String)
|
370
|
-
# * `externalInitiatedEventId` - (Integer)
|
371
|
-
# * `cause` - (String)
|
372
|
-
# * `decisionTaskScheduledEventAttributes` - (Hash)
|
373
|
-
# * `taskList` - (Hash)
|
374
|
-
# * `name` - (String)
|
375
|
-
# * `startToCloseTimeout` - (String)
|
376
|
-
# * `decisionTaskStartedEventAttributes` - (Hash)
|
377
|
-
# * `identity` - (String)
|
378
|
-
# * `scheduledEventId` - (Integer)
|
379
|
-
# * `decisionTaskCompletedEventAttributes` - (Hash)
|
380
|
-
# * `executionContext` - (String)
|
381
|
-
# * `scheduledEventId` - (Integer)
|
382
|
-
# * `startedEventId` - (Integer)
|
383
|
-
# * `decisionTaskTimedOutEventAttributes` - (Hash)
|
384
|
-
# * `timeoutType` - (String)
|
385
|
-
# * `scheduledEventId` - (Integer)
|
386
|
-
# * `startedEventId` - (Integer)
|
387
|
-
# * `activityTaskScheduledEventAttributes` - (Hash)
|
388
|
-
# * `activityType` - (Hash)
|
389
|
-
# * `name` - (String)
|
390
|
-
# * `version` - (String)
|
391
|
-
# * `activityId` - (String)
|
392
|
-
# * `input` - (String)
|
393
|
-
# * `control` - (String)
|
394
|
-
# * `scheduleToStartTimeout` - (String)
|
395
|
-
# * `scheduleToCloseTimeout` - (String)
|
396
|
-
# * `startToCloseTimeout` - (String)
|
397
|
-
# * `taskList` - (Hash)
|
398
|
-
# * `name` - (String)
|
399
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
400
|
-
# * `heartbeatTimeout` - (String)
|
401
|
-
# * `activityTaskStartedEventAttributes` - (Hash)
|
402
|
-
# * `identity` - (String)
|
403
|
-
# * `scheduledEventId` - (Integer)
|
404
|
-
# * `activityTaskCompletedEventAttributes` - (Hash)
|
405
|
-
# * `result` - (String)
|
406
|
-
# * `scheduledEventId` - (Integer)
|
407
|
-
# * `startedEventId` - (Integer)
|
408
|
-
# * `activityTaskFailedEventAttributes` - (Hash)
|
409
|
-
# * `reason` - (String)
|
410
|
-
# * `details` - (String)
|
411
|
-
# * `scheduledEventId` - (Integer)
|
412
|
-
# * `startedEventId` - (Integer)
|
413
|
-
# * `activityTaskTimedOutEventAttributes` - (Hash)
|
414
|
-
# * `timeoutType` - (String)
|
415
|
-
# * `scheduledEventId` - (Integer)
|
416
|
-
# * `startedEventId` - (Integer)
|
417
|
-
# * `details` - (String)
|
418
|
-
# * `activityTaskCanceledEventAttributes` - (Hash)
|
419
|
-
# * `details` - (String)
|
420
|
-
# * `scheduledEventId` - (Integer)
|
421
|
-
# * `startedEventId` - (Integer)
|
422
|
-
# * `latestCancelRequestedEventId` - (Integer)
|
423
|
-
# * `activityTaskCancelRequestedEventAttributes` - (Hash)
|
424
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
425
|
-
# * `activityId` - (String)
|
426
|
-
# * `workflowExecutionSignaledEventAttributes` - (Hash)
|
427
|
-
# * `signalName` - (String)
|
428
|
-
# * `input` - (String)
|
429
|
-
# * `externalWorkflowExecution` - (Hash)
|
430
|
-
# * `workflowId` - (String)
|
431
|
-
# * `runId` - (String)
|
432
|
-
# * `externalInitiatedEventId` - (Integer)
|
433
|
-
# * `markerRecordedEventAttributes` - (Hash)
|
434
|
-
# * `markerName` - (String)
|
435
|
-
# * `details` - (String)
|
436
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
437
|
-
# * `timerStartedEventAttributes` - (Hash)
|
438
|
-
# * `timerId` - (String)
|
439
|
-
# * `control` - (String)
|
440
|
-
# * `startToFireTimeout` - (String)
|
441
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
442
|
-
# * `timerFiredEventAttributes` - (Hash)
|
443
|
-
# * `timerId` - (String)
|
444
|
-
# * `startedEventId` - (Integer)
|
445
|
-
# * `timerCanceledEventAttributes` - (Hash)
|
446
|
-
# * `timerId` - (String)
|
447
|
-
# * `startedEventId` - (Integer)
|
448
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
449
|
-
# * `startChildWorkflowExecutionInitiatedEventAttributes` - (Hash)
|
450
|
-
# * `workflowId` - (String)
|
451
|
-
# * `workflowType` - (Hash)
|
452
|
-
# * `name` - (String)
|
453
|
-
# * `version` - (String)
|
454
|
-
# * `control` - (String)
|
455
|
-
# * `input` - (String)
|
456
|
-
# * `executionStartToCloseTimeout` - (String)
|
457
|
-
# * `taskList` - (Hash)
|
458
|
-
# * `name` - (String)
|
459
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
460
|
-
# * `childPolicy` - (String)
|
461
|
-
# * `taskStartToCloseTimeout` - (String)
|
462
|
-
# * `tagList` - (Array<String>)
|
463
|
-
# * `childWorkflowExecutionStartedEventAttributes` - (Hash)
|
464
|
-
# * `workflowExecution` - (Hash)
|
465
|
-
# * `workflowId` - (String)
|
466
|
-
# * `runId` - (String)
|
467
|
-
# * `workflowType` - (Hash)
|
468
|
-
# * `name` - (String)
|
469
|
-
# * `version` - (String)
|
470
|
-
# * `initiatedEventId` - (Integer)
|
471
|
-
# * `childWorkflowExecutionCompletedEventAttributes` - (Hash)
|
472
|
-
# * `workflowExecution` - (Hash)
|
473
|
-
# * `workflowId` - (String)
|
474
|
-
# * `runId` - (String)
|
475
|
-
# * `workflowType` - (Hash)
|
476
|
-
# * `name` - (String)
|
477
|
-
# * `version` - (String)
|
478
|
-
# * `result` - (String)
|
479
|
-
# * `initiatedEventId` - (Integer)
|
480
|
-
# * `startedEventId` - (Integer)
|
481
|
-
# * `childWorkflowExecutionFailedEventAttributes` - (Hash)
|
482
|
-
# * `workflowExecution` - (Hash)
|
483
|
-
# * `workflowId` - (String)
|
484
|
-
# * `runId` - (String)
|
485
|
-
# * `workflowType` - (Hash)
|
486
|
-
# * `name` - (String)
|
487
|
-
# * `version` - (String)
|
488
|
-
# * `reason` - (String)
|
489
|
-
# * `details` - (String)
|
490
|
-
# * `initiatedEventId` - (Integer)
|
491
|
-
# * `startedEventId` - (Integer)
|
492
|
-
# * `childWorkflowExecutionTimedOutEventAttributes` - (Hash)
|
493
|
-
# * `workflowExecution` - (Hash)
|
494
|
-
# * `workflowId` - (String)
|
495
|
-
# * `runId` - (String)
|
496
|
-
# * `workflowType` - (Hash)
|
497
|
-
# * `name` - (String)
|
498
|
-
# * `version` - (String)
|
499
|
-
# * `timeoutType` - (String)
|
500
|
-
# * `initiatedEventId` - (Integer)
|
501
|
-
# * `startedEventId` - (Integer)
|
502
|
-
# * `childWorkflowExecutionCanceledEventAttributes` - (Hash)
|
503
|
-
# * `workflowExecution` - (Hash)
|
504
|
-
# * `workflowId` - (String)
|
505
|
-
# * `runId` - (String)
|
506
|
-
# * `workflowType` - (Hash)
|
507
|
-
# * `name` - (String)
|
508
|
-
# * `version` - (String)
|
509
|
-
# * `details` - (String)
|
510
|
-
# * `initiatedEventId` - (Integer)
|
511
|
-
# * `startedEventId` - (Integer)
|
512
|
-
# * `childWorkflowExecutionTerminatedEventAttributes` - (Hash)
|
513
|
-
# * `workflowExecution` - (Hash)
|
514
|
-
# * `workflowId` - (String)
|
515
|
-
# * `runId` - (String)
|
516
|
-
# * `workflowType` - (Hash)
|
517
|
-
# * `name` - (String)
|
518
|
-
# * `version` - (String)
|
519
|
-
# * `initiatedEventId` - (Integer)
|
520
|
-
# * `startedEventId` - (Integer)
|
521
|
-
# * `signalExternalWorkflowExecutionInitiatedEventAttributes` - (Hash)
|
522
|
-
# * `workflowId` - (String)
|
523
|
-
# * `runId` - (String)
|
524
|
-
# * `signalName` - (String)
|
525
|
-
# * `input` - (String)
|
526
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
527
|
-
# * `control` - (String)
|
528
|
-
# * `externalWorkflowExecutionSignaledEventAttributes` - (Hash)
|
529
|
-
# * `workflowExecution` - (Hash)
|
530
|
-
# * `workflowId` - (String)
|
531
|
-
# * `runId` - (String)
|
532
|
-
# * `initiatedEventId` - (Integer)
|
533
|
-
# * `signalExternalWorkflowExecutionFailedEventAttributes` - (Hash)
|
534
|
-
# * `workflowId` - (String)
|
535
|
-
# * `runId` - (String)
|
536
|
-
# * `cause` - (String)
|
537
|
-
# * `initiatedEventId` - (Integer)
|
538
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
539
|
-
# * `externalWorkflowExecutionCancelRequestedEventAttributes` - (Hash)
|
540
|
-
# * `workflowExecution` - (Hash)
|
541
|
-
# * `workflowId` - (String)
|
542
|
-
# * `runId` - (String)
|
543
|
-
# * `initiatedEventId` - (Integer)
|
544
|
-
# * `requestCancelExternalWorkflowExecutionInitiatedEventAttributes` - (Hash)
|
545
|
-
# * `workflowId` - (String)
|
546
|
-
# * `runId` - (String)
|
547
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
548
|
-
# * `control` - (String)
|
549
|
-
# * `requestCancelExternalWorkflowExecutionFailedEventAttributes` - (Hash)
|
550
|
-
# * `workflowId` - (String)
|
551
|
-
# * `runId` - (String)
|
552
|
-
# * `cause` - (String)
|
553
|
-
# * `initiatedEventId` - (Integer)
|
554
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
555
|
-
# * `scheduleActivityTaskFailedEventAttributes` - (Hash)
|
556
|
-
# * `activityType` - (Hash)
|
557
|
-
# * `name` - (String)
|
558
|
-
# * `version` - (String)
|
559
|
-
# * `activityId` - (String)
|
560
|
-
# * `cause` - (String)
|
561
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
562
|
-
# * `requestCancelActivityTaskFailedEventAttributes` - (Hash)
|
563
|
-
# * `activityId` - (String)
|
564
|
-
# * `cause` - (String)
|
565
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
566
|
-
# * `startTimerFailedEventAttributes` - (Hash)
|
567
|
-
# * `timerId` - (String)
|
568
|
-
# * `cause` - (String)
|
569
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
570
|
-
# * `cancelTimerFailedEventAttributes` - (Hash)
|
571
|
-
# * `timerId` - (String)
|
572
|
-
# * `cause` - (String)
|
573
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
574
|
-
# * `startChildWorkflowExecutionFailedEventAttributes` - (Hash)
|
575
|
-
# * `workflowType` - (Hash)
|
576
|
-
# * `name` - (String)
|
577
|
-
# * `version` - (String)
|
578
|
-
# * `cause` - (String)
|
579
|
-
# * `workflowId` - (String)
|
580
|
-
# * `initiatedEventId` - (Integer)
|
581
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
582
|
-
# * `nextPageToken` - (String)
|
583
|
-
|
584
|
-
# @!method list_activity_types(options = {})
|
585
|
-
# Calls the ListActivityTypes API operation.
|
586
|
-
# @param [Hash] options
|
587
|
-
#
|
588
|
-
# * `:domain` - *required* - (String)
|
589
|
-
# * `:name` - (String)
|
590
|
-
# * `:registration_status` - *required* - (String) Valid values
|
591
|
-
# include:
|
592
|
-
# * `REGISTERED`
|
593
|
-
# * `DEPRECATED`
|
594
|
-
# * `:next_page_token` - (String)
|
595
|
-
# * `:maximum_page_size` - (Integer)
|
596
|
-
# * `:reverse_order` - (Boolean)
|
597
|
-
# @return [Core::Response]
|
598
|
-
# The #data method of the response object returns
|
599
|
-
# a hash with the following structure:
|
600
|
-
#
|
601
|
-
# * `typeInfos` - (Array<Hash>)
|
602
|
-
# * `activityType` - (Hash)
|
603
|
-
# * `name` - (String)
|
604
|
-
# * `version` - (String)
|
605
|
-
# * `status` - (String)
|
606
|
-
# * `description` - (String)
|
607
|
-
# * `creationDate` - (Time)
|
608
|
-
# * `deprecationDate` - (Time)
|
609
|
-
# * `nextPageToken` - (String)
|
610
|
-
|
611
|
-
# @!method list_closed_workflow_executions(options = {})
|
612
|
-
# Calls the ListClosedWorkflowExecutions API operation.
|
613
|
-
# @param [Hash] options
|
614
|
-
#
|
615
|
-
# * `:domain` - *required* - (String)
|
616
|
-
# * `:start_time_filter` - (Hash)
|
617
|
-
# * `:oldest_date` - *required* - (Integer<unix timestamp>)
|
618
|
-
# * `:latest_date` - (Integer<unix timestamp>)
|
619
|
-
# * `:close_time_filter` - (Hash)
|
620
|
-
# * `:oldest_date` - *required* - (Integer<unix timestamp>)
|
621
|
-
# * `:latest_date` - (Integer<unix timestamp>)
|
622
|
-
# * `:execution_filter` - (Hash)
|
623
|
-
# * `:workflow_id` - *required* - (String)
|
624
|
-
# * `:close_status_filter` - (Hash)
|
625
|
-
# * `:status` - *required* - (String) Valid values include:
|
626
|
-
# * `COMPLETED`
|
627
|
-
# * `FAILED`
|
628
|
-
# * `CANCELED`
|
629
|
-
# * `TERMINATED`
|
630
|
-
# * `CONTINUED_AS_NEW`
|
631
|
-
# * `TIMED_OUT`
|
632
|
-
# * `:type_filter` - (Hash)
|
633
|
-
# * `:name` - *required* - (String)
|
634
|
-
# * `:version` - (String)
|
635
|
-
# * `:tag_filter` - (Hash)
|
636
|
-
# * `:tag` - *required* - (String)
|
637
|
-
# * `:next_page_token` - (String)
|
638
|
-
# * `:maximum_page_size` - (Integer)
|
639
|
-
# * `:reverse_order` - (Boolean)
|
640
|
-
# @return [Core::Response]
|
641
|
-
# The #data method of the response object returns
|
642
|
-
# a hash with the following structure:
|
643
|
-
#
|
644
|
-
# * `executionInfos` - (Array<Hash>)
|
645
|
-
# * `execution` - (Hash)
|
646
|
-
# * `workflowId` - (String)
|
647
|
-
# * `runId` - (String)
|
648
|
-
# * `workflowType` - (Hash)
|
649
|
-
# * `name` - (String)
|
650
|
-
# * `version` - (String)
|
651
|
-
# * `startTimestamp` - (Time)
|
652
|
-
# * `closeTimestamp` - (Time)
|
653
|
-
# * `executionStatus` - (String)
|
654
|
-
# * `closeStatus` - (String)
|
655
|
-
# * `parent` - (Hash)
|
656
|
-
# * `workflowId` - (String)
|
657
|
-
# * `runId` - (String)
|
658
|
-
# * `tagList` - (Array<String>)
|
659
|
-
# * `cancelRequested` - (Boolean)
|
660
|
-
# * `nextPageToken` - (String)
|
661
|
-
|
662
|
-
# @!method list_domains(options = {})
|
663
|
-
# Calls the ListDomains API operation.
|
664
|
-
# @param [Hash] options
|
665
|
-
#
|
666
|
-
# * `:next_page_token` - (String)
|
667
|
-
# * `:registration_status` - *required* - (String) Valid values
|
668
|
-
# include:
|
669
|
-
# * `REGISTERED`
|
670
|
-
# * `DEPRECATED`
|
671
|
-
# * `:maximum_page_size` - (Integer)
|
672
|
-
# * `:reverse_order` - (Boolean)
|
673
|
-
# @return [Core::Response]
|
674
|
-
# The #data method of the response object returns
|
675
|
-
# a hash with the following structure:
|
676
|
-
#
|
677
|
-
# * `domainInfos` - (Array<Hash>)
|
678
|
-
# * `name` - (String)
|
679
|
-
# * `status` - (String)
|
680
|
-
# * `description` - (String)
|
681
|
-
# * `nextPageToken` - (String)
|
682
|
-
|
683
|
-
# @!method list_open_workflow_executions(options = {})
|
684
|
-
# Calls the ListOpenWorkflowExecutions API operation.
|
685
|
-
# @param [Hash] options
|
686
|
-
#
|
687
|
-
# * `:domain` - *required* - (String)
|
688
|
-
# * `:start_time_filter` - *required* - (Hash)
|
689
|
-
# * `:oldest_date` - *required* - (Integer<unix timestamp>)
|
690
|
-
# * `:latest_date` - (Integer<unix timestamp>)
|
691
|
-
# * `:type_filter` - (Hash)
|
692
|
-
# * `:name` - *required* - (String)
|
693
|
-
# * `:version` - (String)
|
694
|
-
# * `:tag_filter` - (Hash)
|
695
|
-
# * `:tag` - *required* - (String)
|
696
|
-
# * `:next_page_token` - (String)
|
697
|
-
# * `:maximum_page_size` - (Integer)
|
698
|
-
# * `:reverse_order` - (Boolean)
|
699
|
-
# * `:execution_filter` - (Hash)
|
700
|
-
# * `:workflow_id` - *required* - (String)
|
701
|
-
# @return [Core::Response]
|
702
|
-
# The #data method of the response object returns
|
703
|
-
# a hash with the following structure:
|
704
|
-
#
|
705
|
-
# * `executionInfos` - (Array<Hash>)
|
706
|
-
# * `execution` - (Hash)
|
707
|
-
# * `workflowId` - (String)
|
708
|
-
# * `runId` - (String)
|
709
|
-
# * `workflowType` - (Hash)
|
710
|
-
# * `name` - (String)
|
711
|
-
# * `version` - (String)
|
712
|
-
# * `startTimestamp` - (Time)
|
713
|
-
# * `closeTimestamp` - (Time)
|
714
|
-
# * `executionStatus` - (String)
|
715
|
-
# * `closeStatus` - (String)
|
716
|
-
# * `parent` - (Hash)
|
717
|
-
# * `workflowId` - (String)
|
718
|
-
# * `runId` - (String)
|
719
|
-
# * `tagList` - (Array<String>)
|
720
|
-
# * `cancelRequested` - (Boolean)
|
721
|
-
# * `nextPageToken` - (String)
|
722
|
-
|
723
|
-
# @!method list_workflow_types(options = {})
|
724
|
-
# Calls the ListWorkflowTypes API operation.
|
725
|
-
# @param [Hash] options
|
726
|
-
#
|
727
|
-
# * `:domain` - *required* - (String)
|
728
|
-
# * `:name` - (String)
|
729
|
-
# * `:registration_status` - *required* - (String) Valid values
|
730
|
-
# include:
|
731
|
-
# * `REGISTERED`
|
732
|
-
# * `DEPRECATED`
|
733
|
-
# * `:next_page_token` - (String)
|
734
|
-
# * `:maximum_page_size` - (Integer)
|
735
|
-
# * `:reverse_order` - (Boolean)
|
736
|
-
# @return [Core::Response]
|
737
|
-
# The #data method of the response object returns
|
738
|
-
# a hash with the following structure:
|
739
|
-
#
|
740
|
-
# * `typeInfos` - (Array<Hash>)
|
741
|
-
# * `workflowType` - (Hash)
|
742
|
-
# * `name` - (String)
|
743
|
-
# * `version` - (String)
|
744
|
-
# * `status` - (String)
|
745
|
-
# * `description` - (String)
|
746
|
-
# * `creationDate` - (Time)
|
747
|
-
# * `deprecationDate` - (Time)
|
748
|
-
# * `nextPageToken` - (String)
|
749
|
-
|
750
|
-
# @!method poll_for_activity_task(options = {})
|
751
|
-
# Calls the PollForActivityTask API operation.
|
752
|
-
# @param [Hash] options
|
753
|
-
#
|
754
|
-
# * `:domain` - *required* - (String)
|
755
|
-
# * `:task_list` - *required* - (Hash)
|
756
|
-
# * `:name` - *required* - (String)
|
757
|
-
# * `:identity` - (String)
|
758
|
-
# @return [Core::Response]
|
759
|
-
# The #data method of the response object returns
|
760
|
-
# a hash with the following structure:
|
761
|
-
#
|
762
|
-
# * `taskToken` - (String)
|
763
|
-
# * `activityId` - (String)
|
764
|
-
# * `startedEventId` - (Integer)
|
765
|
-
# * `workflowExecution` - (Hash)
|
766
|
-
# * `workflowId` - (String)
|
767
|
-
# * `runId` - (String)
|
768
|
-
# * `activityType` - (Hash)
|
769
|
-
# * `name` - (String)
|
770
|
-
# * `version` - (String)
|
771
|
-
# * `input` - (String)
|
772
|
-
|
773
|
-
# @!method poll_for_decision_task(options = {})
|
774
|
-
# Calls the PollForDecisionTask API operation.
|
775
|
-
# @param [Hash] options
|
776
|
-
#
|
777
|
-
# * `:domain` - *required* - (String)
|
778
|
-
# * `:task_list` - *required* - (Hash)
|
779
|
-
# * `:name` - *required* - (String)
|
780
|
-
# * `:identity` - (String)
|
781
|
-
# * `:next_page_token` - (String)
|
782
|
-
# * `:maximum_page_size` - (Integer)
|
783
|
-
# * `:reverse_order` - (Boolean)
|
784
|
-
# @return [Core::Response]
|
785
|
-
# The #data method of the response object returns
|
786
|
-
# a hash with the following structure:
|
787
|
-
#
|
788
|
-
# * `taskToken` - (String)
|
789
|
-
# * `startedEventId` - (Integer)
|
790
|
-
# * `workflowExecution` - (Hash)
|
791
|
-
# * `workflowId` - (String)
|
792
|
-
# * `runId` - (String)
|
793
|
-
# * `workflowType` - (Hash)
|
794
|
-
# * `name` - (String)
|
795
|
-
# * `version` - (String)
|
796
|
-
# * `events` - (Array<Hash>)
|
797
|
-
# * `eventTimestamp` - (Time)
|
798
|
-
# * `eventType` - (String)
|
799
|
-
# * `eventId` - (Integer)
|
800
|
-
# * `workflowExecutionStartedEventAttributes` - (Hash)
|
801
|
-
# * `input` - (String)
|
802
|
-
# * `executionStartToCloseTimeout` - (String)
|
803
|
-
# * `taskStartToCloseTimeout` - (String)
|
804
|
-
# * `childPolicy` - (String)
|
805
|
-
# * `taskList` - (Hash)
|
806
|
-
# * `name` - (String)
|
807
|
-
# * `workflowType` - (Hash)
|
808
|
-
# * `name` - (String)
|
809
|
-
# * `version` - (String)
|
810
|
-
# * `tagList` - (Array<String>)
|
811
|
-
# * `continuedExecutionRunId` - (String)
|
812
|
-
# * `parentWorkflowExecution` - (Hash)
|
813
|
-
# * `workflowId` - (String)
|
814
|
-
# * `runId` - (String)
|
815
|
-
# * `parentInitiatedEventId` - (Integer)
|
816
|
-
# * `workflowExecutionCompletedEventAttributes` - (Hash)
|
817
|
-
# * `result` - (String)
|
818
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
819
|
-
# * `completeWorkflowExecutionFailedEventAttributes` - (Hash)
|
820
|
-
# * `cause` - (String)
|
821
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
822
|
-
# * `workflowExecutionFailedEventAttributes` - (Hash)
|
823
|
-
# * `reason` - (String)
|
824
|
-
# * `details` - (String)
|
825
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
826
|
-
# * `failWorkflowExecutionFailedEventAttributes` - (Hash)
|
827
|
-
# * `cause` - (String)
|
828
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
829
|
-
# * `workflowExecutionTimedOutEventAttributes` - (Hash)
|
830
|
-
# * `timeoutType` - (String)
|
831
|
-
# * `childPolicy` - (String)
|
832
|
-
# * `workflowExecutionCanceledEventAttributes` - (Hash)
|
833
|
-
# * `details` - (String)
|
834
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
835
|
-
# * `cancelWorkflowExecutionFailedEventAttributes` - (Hash)
|
836
|
-
# * `cause` - (String)
|
837
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
838
|
-
# * `workflowExecutionContinuedAsNewEventAttributes` - (Hash)
|
839
|
-
# * `input` - (String)
|
840
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
841
|
-
# * `newExecutionRunId` - (String)
|
842
|
-
# * `executionStartToCloseTimeout` - (String)
|
843
|
-
# * `taskList` - (Hash)
|
844
|
-
# * `name` - (String)
|
845
|
-
# * `taskStartToCloseTimeout` - (String)
|
846
|
-
# * `childPolicy` - (String)
|
847
|
-
# * `tagList` - (Array<String>)
|
848
|
-
# * `workflowType` - (Hash)
|
849
|
-
# * `name` - (String)
|
850
|
-
# * `version` - (String)
|
851
|
-
# * `continueAsNewWorkflowExecutionFailedEventAttributes` - (Hash)
|
852
|
-
# * `cause` - (String)
|
853
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
854
|
-
# * `workflowExecutionTerminatedEventAttributes` - (Hash)
|
855
|
-
# * `reason` - (String)
|
856
|
-
# * `details` - (String)
|
857
|
-
# * `childPolicy` - (String)
|
858
|
-
# * `cause` - (String)
|
859
|
-
# * `workflowExecutionCancelRequestedEventAttributes` - (Hash)
|
860
|
-
# * `externalWorkflowExecution` - (Hash)
|
861
|
-
# * `workflowId` - (String)
|
862
|
-
# * `runId` - (String)
|
863
|
-
# * `externalInitiatedEventId` - (Integer)
|
864
|
-
# * `cause` - (String)
|
865
|
-
# * `decisionTaskScheduledEventAttributes` - (Hash)
|
866
|
-
# * `taskList` - (Hash)
|
867
|
-
# * `name` - (String)
|
868
|
-
# * `startToCloseTimeout` - (String)
|
869
|
-
# * `decisionTaskStartedEventAttributes` - (Hash)
|
870
|
-
# * `identity` - (String)
|
871
|
-
# * `scheduledEventId` - (Integer)
|
872
|
-
# * `decisionTaskCompletedEventAttributes` - (Hash)
|
873
|
-
# * `executionContext` - (String)
|
874
|
-
# * `scheduledEventId` - (Integer)
|
875
|
-
# * `startedEventId` - (Integer)
|
876
|
-
# * `decisionTaskTimedOutEventAttributes` - (Hash)
|
877
|
-
# * `timeoutType` - (String)
|
878
|
-
# * `scheduledEventId` - (Integer)
|
879
|
-
# * `startedEventId` - (Integer)
|
880
|
-
# * `activityTaskScheduledEventAttributes` - (Hash)
|
881
|
-
# * `activityType` - (Hash)
|
882
|
-
# * `name` - (String)
|
883
|
-
# * `version` - (String)
|
884
|
-
# * `activityId` - (String)
|
885
|
-
# * `input` - (String)
|
886
|
-
# * `control` - (String)
|
887
|
-
# * `scheduleToStartTimeout` - (String)
|
888
|
-
# * `scheduleToCloseTimeout` - (String)
|
889
|
-
# * `startToCloseTimeout` - (String)
|
890
|
-
# * `taskList` - (Hash)
|
891
|
-
# * `name` - (String)
|
892
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
893
|
-
# * `heartbeatTimeout` - (String)
|
894
|
-
# * `activityTaskStartedEventAttributes` - (Hash)
|
895
|
-
# * `identity` - (String)
|
896
|
-
# * `scheduledEventId` - (Integer)
|
897
|
-
# * `activityTaskCompletedEventAttributes` - (Hash)
|
898
|
-
# * `result` - (String)
|
899
|
-
# * `scheduledEventId` - (Integer)
|
900
|
-
# * `startedEventId` - (Integer)
|
901
|
-
# * `activityTaskFailedEventAttributes` - (Hash)
|
902
|
-
# * `reason` - (String)
|
903
|
-
# * `details` - (String)
|
904
|
-
# * `scheduledEventId` - (Integer)
|
905
|
-
# * `startedEventId` - (Integer)
|
906
|
-
# * `activityTaskTimedOutEventAttributes` - (Hash)
|
907
|
-
# * `timeoutType` - (String)
|
908
|
-
# * `scheduledEventId` - (Integer)
|
909
|
-
# * `startedEventId` - (Integer)
|
910
|
-
# * `details` - (String)
|
911
|
-
# * `activityTaskCanceledEventAttributes` - (Hash)
|
912
|
-
# * `details` - (String)
|
913
|
-
# * `scheduledEventId` - (Integer)
|
914
|
-
# * `startedEventId` - (Integer)
|
915
|
-
# * `latestCancelRequestedEventId` - (Integer)
|
916
|
-
# * `activityTaskCancelRequestedEventAttributes` - (Hash)
|
917
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
918
|
-
# * `activityId` - (String)
|
919
|
-
# * `workflowExecutionSignaledEventAttributes` - (Hash)
|
920
|
-
# * `signalName` - (String)
|
921
|
-
# * `input` - (String)
|
922
|
-
# * `externalWorkflowExecution` - (Hash)
|
923
|
-
# * `workflowId` - (String)
|
924
|
-
# * `runId` - (String)
|
925
|
-
# * `externalInitiatedEventId` - (Integer)
|
926
|
-
# * `markerRecordedEventAttributes` - (Hash)
|
927
|
-
# * `markerName` - (String)
|
928
|
-
# * `details` - (String)
|
929
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
930
|
-
# * `timerStartedEventAttributes` - (Hash)
|
931
|
-
# * `timerId` - (String)
|
932
|
-
# * `control` - (String)
|
933
|
-
# * `startToFireTimeout` - (String)
|
934
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
935
|
-
# * `timerFiredEventAttributes` - (Hash)
|
936
|
-
# * `timerId` - (String)
|
937
|
-
# * `startedEventId` - (Integer)
|
938
|
-
# * `timerCanceledEventAttributes` - (Hash)
|
939
|
-
# * `timerId` - (String)
|
940
|
-
# * `startedEventId` - (Integer)
|
941
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
942
|
-
# * `startChildWorkflowExecutionInitiatedEventAttributes` - (Hash)
|
943
|
-
# * `workflowId` - (String)
|
944
|
-
# * `workflowType` - (Hash)
|
945
|
-
# * `name` - (String)
|
946
|
-
# * `version` - (String)
|
947
|
-
# * `control` - (String)
|
948
|
-
# * `input` - (String)
|
949
|
-
# * `executionStartToCloseTimeout` - (String)
|
950
|
-
# * `taskList` - (Hash)
|
951
|
-
# * `name` - (String)
|
952
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
953
|
-
# * `childPolicy` - (String)
|
954
|
-
# * `taskStartToCloseTimeout` - (String)
|
955
|
-
# * `tagList` - (Array<String>)
|
956
|
-
# * `childWorkflowExecutionStartedEventAttributes` - (Hash)
|
957
|
-
# * `workflowExecution` - (Hash)
|
958
|
-
# * `workflowId` - (String)
|
959
|
-
# * `runId` - (String)
|
960
|
-
# * `workflowType` - (Hash)
|
961
|
-
# * `name` - (String)
|
962
|
-
# * `version` - (String)
|
963
|
-
# * `initiatedEventId` - (Integer)
|
964
|
-
# * `childWorkflowExecutionCompletedEventAttributes` - (Hash)
|
965
|
-
# * `workflowExecution` - (Hash)
|
966
|
-
# * `workflowId` - (String)
|
967
|
-
# * `runId` - (String)
|
968
|
-
# * `workflowType` - (Hash)
|
969
|
-
# * `name` - (String)
|
970
|
-
# * `version` - (String)
|
971
|
-
# * `result` - (String)
|
972
|
-
# * `initiatedEventId` - (Integer)
|
973
|
-
# * `startedEventId` - (Integer)
|
974
|
-
# * `childWorkflowExecutionFailedEventAttributes` - (Hash)
|
975
|
-
# * `workflowExecution` - (Hash)
|
976
|
-
# * `workflowId` - (String)
|
977
|
-
# * `runId` - (String)
|
978
|
-
# * `workflowType` - (Hash)
|
979
|
-
# * `name` - (String)
|
980
|
-
# * `version` - (String)
|
981
|
-
# * `reason` - (String)
|
982
|
-
# * `details` - (String)
|
983
|
-
# * `initiatedEventId` - (Integer)
|
984
|
-
# * `startedEventId` - (Integer)
|
985
|
-
# * `childWorkflowExecutionTimedOutEventAttributes` - (Hash)
|
986
|
-
# * `workflowExecution` - (Hash)
|
987
|
-
# * `workflowId` - (String)
|
988
|
-
# * `runId` - (String)
|
989
|
-
# * `workflowType` - (Hash)
|
990
|
-
# * `name` - (String)
|
991
|
-
# * `version` - (String)
|
992
|
-
# * `timeoutType` - (String)
|
993
|
-
# * `initiatedEventId` - (Integer)
|
994
|
-
# * `startedEventId` - (Integer)
|
995
|
-
# * `childWorkflowExecutionCanceledEventAttributes` - (Hash)
|
996
|
-
# * `workflowExecution` - (Hash)
|
997
|
-
# * `workflowId` - (String)
|
998
|
-
# * `runId` - (String)
|
999
|
-
# * `workflowType` - (Hash)
|
1000
|
-
# * `name` - (String)
|
1001
|
-
# * `version` - (String)
|
1002
|
-
# * `details` - (String)
|
1003
|
-
# * `initiatedEventId` - (Integer)
|
1004
|
-
# * `startedEventId` - (Integer)
|
1005
|
-
# * `childWorkflowExecutionTerminatedEventAttributes` - (Hash)
|
1006
|
-
# * `workflowExecution` - (Hash)
|
1007
|
-
# * `workflowId` - (String)
|
1008
|
-
# * `runId` - (String)
|
1009
|
-
# * `workflowType` - (Hash)
|
1010
|
-
# * `name` - (String)
|
1011
|
-
# * `version` - (String)
|
1012
|
-
# * `initiatedEventId` - (Integer)
|
1013
|
-
# * `startedEventId` - (Integer)
|
1014
|
-
# * `signalExternalWorkflowExecutionInitiatedEventAttributes` - (Hash)
|
1015
|
-
# * `workflowId` - (String)
|
1016
|
-
# * `runId` - (String)
|
1017
|
-
# * `signalName` - (String)
|
1018
|
-
# * `input` - (String)
|
1019
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1020
|
-
# * `control` - (String)
|
1021
|
-
# * `externalWorkflowExecutionSignaledEventAttributes` - (Hash)
|
1022
|
-
# * `workflowExecution` - (Hash)
|
1023
|
-
# * `workflowId` - (String)
|
1024
|
-
# * `runId` - (String)
|
1025
|
-
# * `initiatedEventId` - (Integer)
|
1026
|
-
# * `signalExternalWorkflowExecutionFailedEventAttributes` - (Hash)
|
1027
|
-
# * `workflowId` - (String)
|
1028
|
-
# * `runId` - (String)
|
1029
|
-
# * `cause` - (String)
|
1030
|
-
# * `initiatedEventId` - (Integer)
|
1031
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1032
|
-
# * `externalWorkflowExecutionCancelRequestedEventAttributes` - (Hash)
|
1033
|
-
# * `workflowExecution` - (Hash)
|
1034
|
-
# * `workflowId` - (String)
|
1035
|
-
# * `runId` - (String)
|
1036
|
-
# * `initiatedEventId` - (Integer)
|
1037
|
-
# * `requestCancelExternalWorkflowExecutionInitiatedEventAttributes` - (Hash)
|
1038
|
-
# * `workflowId` - (String)
|
1039
|
-
# * `runId` - (String)
|
1040
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1041
|
-
# * `control` - (String)
|
1042
|
-
# * `requestCancelExternalWorkflowExecutionFailedEventAttributes` - (Hash)
|
1043
|
-
# * `workflowId` - (String)
|
1044
|
-
# * `runId` - (String)
|
1045
|
-
# * `cause` - (String)
|
1046
|
-
# * `initiatedEventId` - (Integer)
|
1047
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1048
|
-
# * `scheduleActivityTaskFailedEventAttributes` - (Hash)
|
1049
|
-
# * `activityType` - (Hash)
|
1050
|
-
# * `name` - (String)
|
1051
|
-
# * `version` - (String)
|
1052
|
-
# * `activityId` - (String)
|
1053
|
-
# * `cause` - (String)
|
1054
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1055
|
-
# * `requestCancelActivityTaskFailedEventAttributes` - (Hash)
|
1056
|
-
# * `activityId` - (String)
|
1057
|
-
# * `cause` - (String)
|
1058
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1059
|
-
# * `startTimerFailedEventAttributes` - (Hash)
|
1060
|
-
# * `timerId` - (String)
|
1061
|
-
# * `cause` - (String)
|
1062
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1063
|
-
# * `cancelTimerFailedEventAttributes` - (Hash)
|
1064
|
-
# * `timerId` - (String)
|
1065
|
-
# * `cause` - (String)
|
1066
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1067
|
-
# * `startChildWorkflowExecutionFailedEventAttributes` - (Hash)
|
1068
|
-
# * `workflowType` - (Hash)
|
1069
|
-
# * `name` - (String)
|
1070
|
-
# * `version` - (String)
|
1071
|
-
# * `cause` - (String)
|
1072
|
-
# * `workflowId` - (String)
|
1073
|
-
# * `initiatedEventId` - (Integer)
|
1074
|
-
# * `decisionTaskCompletedEventId` - (Integer)
|
1075
|
-
# * `nextPageToken` - (String)
|
1076
|
-
# * `previousStartedEventId` - (Integer)
|
1077
|
-
|
1078
|
-
# @!method record_activity_task_heartbeat(options = {})
|
1079
|
-
# Calls the RecordActivityTaskHeartbeat API operation.
|
1080
|
-
# @param [Hash] options
|
1081
|
-
#
|
1082
|
-
# * `:task_token` - *required* - (String)
|
1083
|
-
# * `:details` - (String)
|
1084
|
-
# @return [Core::Response]
|
1085
|
-
# The #data method of the response object returns
|
1086
|
-
# a hash with the following structure:
|
1087
|
-
#
|
1088
|
-
# * `cancelRequested` - (Boolean)
|
1089
|
-
|
1090
|
-
# @!method register_activity_type(options = {})
|
1091
|
-
# Calls the RegisterActivityType API operation.
|
1092
|
-
# @param [Hash] options
|
1093
|
-
#
|
1094
|
-
# * `:domain` - *required* - (String)
|
1095
|
-
# * `:name` - *required* - (String)
|
1096
|
-
# * `:version` - *required* - (String)
|
1097
|
-
# * `:description` - (String)
|
1098
|
-
# * `:default_task_start_to_close_timeout` - (String)
|
1099
|
-
# * `:default_task_heartbeat_timeout` - (String)
|
1100
|
-
# * `:default_task_list` - (Hash)
|
1101
|
-
# * `:name` - *required* - (String)
|
1102
|
-
# * `:default_task_schedule_to_start_timeout` - (String)
|
1103
|
-
# * `:default_task_schedule_to_close_timeout` - (String)
|
1104
|
-
# @return [Core::Response]
|
1105
|
-
|
1106
|
-
# @!method register_domain(options = {})
|
1107
|
-
# Calls the RegisterDomain API operation.
|
1108
|
-
# @param [Hash] options
|
1109
|
-
#
|
1110
|
-
# * `:name` - *required* - (String)
|
1111
|
-
# * `:description` - (String)
|
1112
|
-
# * `:workflow_execution_retention_period_in_days` - *required* - (String)
|
1113
|
-
# @return [Core::Response]
|
1114
|
-
|
1115
|
-
# @!method register_workflow_type(options = {})
|
1116
|
-
# Calls the RegisterWorkflowType API operation.
|
1117
|
-
# @param [Hash] options
|
1118
|
-
#
|
1119
|
-
# * `:domain` - *required* - (String)
|
1120
|
-
# * `:name` - *required* - (String)
|
1121
|
-
# * `:version` - *required* - (String)
|
1122
|
-
# * `:description` - (String)
|
1123
|
-
# * `:default_task_start_to_close_timeout` - (String)
|
1124
|
-
# * `:default_execution_start_to_close_timeout` - (String)
|
1125
|
-
# * `:default_task_list` - (Hash)
|
1126
|
-
# * `:name` - *required* - (String)
|
1127
|
-
# * `:default_child_policy` - (String) Valid values include:
|
1128
|
-
# * `TERMINATE`
|
1129
|
-
# * `REQUEST_CANCEL`
|
1130
|
-
# * `ABANDON`
|
1131
|
-
# @return [Core::Response]
|
1132
|
-
|
1133
|
-
# @!method request_cancel_workflow_execution(options = {})
|
1134
|
-
# Calls the RequestCancelWorkflowExecution API operation.
|
1135
|
-
# @param [Hash] options
|
1136
|
-
#
|
1137
|
-
# * `:domain` - *required* - (String)
|
1138
|
-
# * `:workflow_id` - *required* - (String)
|
1139
|
-
# * `:run_id` - (String)
|
1140
|
-
# @return [Core::Response]
|
1141
|
-
|
1142
|
-
# @!method respond_activity_task_canceled(options = {})
|
1143
|
-
# Calls the RespondActivityTaskCanceled API operation.
|
1144
|
-
# @param [Hash] options
|
1145
|
-
#
|
1146
|
-
# * `:task_token` - *required* - (String)
|
1147
|
-
# * `:details` - (String)
|
1148
|
-
# @return [Core::Response]
|
1149
|
-
|
1150
|
-
# @!method respond_activity_task_completed(options = {})
|
1151
|
-
# Calls the RespondActivityTaskCompleted API operation.
|
1152
|
-
# @param [Hash] options
|
1153
|
-
#
|
1154
|
-
# * `:task_token` - *required* - (String)
|
1155
|
-
# * `:result` - (String)
|
1156
|
-
# @return [Core::Response]
|
1157
|
-
|
1158
|
-
# @!method respond_activity_task_failed(options = {})
|
1159
|
-
# Calls the RespondActivityTaskFailed API operation.
|
1160
|
-
# @param [Hash] options
|
1161
|
-
#
|
1162
|
-
# * `:task_token` - *required* - (String)
|
1163
|
-
# * `:reason` - (String)
|
1164
|
-
# * `:details` - (String)
|
1165
|
-
# @return [Core::Response]
|
1166
|
-
|
1167
|
-
# @!method respond_decision_task_completed(options = {})
|
1168
|
-
# Calls the RespondDecisionTaskCompleted API operation.
|
1169
|
-
# @param [Hash] options
|
1170
|
-
#
|
1171
|
-
# * `:task_token` - *required* - (String)
|
1172
|
-
# * `:decisions` - (Array<Hash>)
|
1173
|
-
# * `:decision_type` - *required* - (String) Valid values include:
|
1174
|
-
# * `ScheduleActivityTask`
|
1175
|
-
# * `RequestCancelActivityTask`
|
1176
|
-
# * `CompleteWorkflowExecution`
|
1177
|
-
# * `FailWorkflowExecution`
|
1178
|
-
# * `CancelWorkflowExecution`
|
1179
|
-
# * `ContinueAsNewWorkflowExecution`
|
1180
|
-
# * `RecordMarker`
|
1181
|
-
# * `StartTimer`
|
1182
|
-
# * `CancelTimer`
|
1183
|
-
# * `SignalExternalWorkflowExecution`
|
1184
|
-
# * `RequestCancelExternalWorkflowExecution`
|
1185
|
-
# * `StartChildWorkflowExecution`
|
1186
|
-
# * `:schedule_activity_task_decision_attributes` - (Hash)
|
1187
|
-
# * `:activity_type` - *required* - (Hash)
|
1188
|
-
# * `:name` - *required* - (String)
|
1189
|
-
# * `:version` - *required* - (String)
|
1190
|
-
# * `:activity_id` - *required* - (String)
|
1191
|
-
# * `:control` - (String)
|
1192
|
-
# * `:input` - (String)
|
1193
|
-
# * `:schedule_to_close_timeout` - (String)
|
1194
|
-
# * `:task_list` - (Hash)
|
1195
|
-
# * `:name` - *required* - (String)
|
1196
|
-
# * `:schedule_to_start_timeout` - (String)
|
1197
|
-
# * `:start_to_close_timeout` - (String)
|
1198
|
-
# * `:heartbeat_timeout` - (String)
|
1199
|
-
# * `:request_cancel_activity_task_decision_attributes` - (Hash)
|
1200
|
-
# * `:activity_id` - *required* - (String)
|
1201
|
-
# * `:complete_workflow_execution_decision_attributes` - (Hash)
|
1202
|
-
# * `:result` - (String)
|
1203
|
-
# * `:fail_workflow_execution_decision_attributes` - (Hash)
|
1204
|
-
# * `:reason` - (String)
|
1205
|
-
# * `:details` - (String)
|
1206
|
-
# * `:cancel_workflow_execution_decision_attributes` - (Hash)
|
1207
|
-
# * `:details` - (String)
|
1208
|
-
# * `:continue_as_new_workflow_execution_decision_attributes` - (Hash)
|
1209
|
-
# * `:input` - (String)
|
1210
|
-
# * `:execution_start_to_close_timeout` - (String)
|
1211
|
-
# * `:task_list` - (Hash)
|
1212
|
-
# * `:name` - *required* - (String)
|
1213
|
-
# * `:task_start_to_close_timeout` - (String)
|
1214
|
-
# * `:child_policy` - (String) Valid values include:
|
1215
|
-
# * `TERMINATE`
|
1216
|
-
# * `REQUEST_CANCEL`
|
1217
|
-
# * `ABANDON`
|
1218
|
-
# * `:tag_list` - (Array<String>)
|
1219
|
-
# * `:workflow_type_version` - (String)
|
1220
|
-
# * `:record_marker_decision_attributes` - (Hash)
|
1221
|
-
# * `:marker_name` - *required* - (String)
|
1222
|
-
# * `:details` - (String)
|
1223
|
-
# * `:start_timer_decision_attributes` - (Hash)
|
1224
|
-
# * `:timer_id` - *required* - (String)
|
1225
|
-
# * `:control` - (String)
|
1226
|
-
# * `:start_to_fire_timeout` - *required* - (String)
|
1227
|
-
# * `:cancel_timer_decision_attributes` - (Hash)
|
1228
|
-
# * `:timer_id` - *required* - (String)
|
1229
|
-
# * `:signal_external_workflow_execution_decision_attributes` - (Hash)
|
1230
|
-
# * `:workflow_id` - *required* - (String)
|
1231
|
-
# * `:run_id` - (String)
|
1232
|
-
# * `:signal_name` - *required* - (String)
|
1233
|
-
# * `:input` - (String)
|
1234
|
-
# * `:control` - (String)
|
1235
|
-
# * `:request_cancel_external_workflow_execution_decision_attributes` - (Hash)
|
1236
|
-
# * `:workflow_id` - *required* - (String)
|
1237
|
-
# * `:run_id` - (String)
|
1238
|
-
# * `:control` - (String)
|
1239
|
-
# * `:start_child_workflow_execution_decision_attributes` - (Hash)
|
1240
|
-
# * `:workflow_type` - *required* - (Hash)
|
1241
|
-
# * `:name` - *required* - (String)
|
1242
|
-
# * `:version` - *required* - (String)
|
1243
|
-
# * `:workflow_id` - *required* - (String)
|
1244
|
-
# * `:control` - (String)
|
1245
|
-
# * `:input` - (String)
|
1246
|
-
# * `:execution_start_to_close_timeout` - (String)
|
1247
|
-
# * `:task_list` - (Hash)
|
1248
|
-
# * `:name` - *required* - (String)
|
1249
|
-
# * `:task_start_to_close_timeout` - (String)
|
1250
|
-
# * `:child_policy` - (String) Valid values include:
|
1251
|
-
# * `TERMINATE`
|
1252
|
-
# * `REQUEST_CANCEL`
|
1253
|
-
# * `ABANDON`
|
1254
|
-
# * `:tag_list` - (Array<String>)
|
1255
|
-
# * `:execution_context` - (String)
|
1256
|
-
# @return [Core::Response]
|
1257
|
-
|
1258
|
-
# @!method signal_workflow_execution(options = {})
|
1259
|
-
# Calls the SignalWorkflowExecution API operation.
|
1260
|
-
# @param [Hash] options
|
1261
|
-
#
|
1262
|
-
# * `:domain` - *required* - (String)
|
1263
|
-
# * `:workflow_id` - *required* - (String)
|
1264
|
-
# * `:run_id` - (String)
|
1265
|
-
# * `:signal_name` - *required* - (String)
|
1266
|
-
# * `:input` - (String)
|
1267
|
-
# @return [Core::Response]
|
1268
|
-
|
1269
|
-
# @!method start_workflow_execution(options = {})
|
1270
|
-
# Calls the StartWorkflowExecution API operation.
|
1271
|
-
# @param [Hash] options
|
1272
|
-
#
|
1273
|
-
# * `:domain` - *required* - (String)
|
1274
|
-
# * `:workflow_id` - *required* - (String)
|
1275
|
-
# * `:workflow_type` - *required* - (Hash)
|
1276
|
-
# * `:name` - *required* - (String)
|
1277
|
-
# * `:version` - *required* - (String)
|
1278
|
-
# * `:task_list` - (Hash)
|
1279
|
-
# * `:name` - *required* - (String)
|
1280
|
-
# * `:input` - (String)
|
1281
|
-
# * `:execution_start_to_close_timeout` - (String)
|
1282
|
-
# * `:tag_list` - (Array<String>)
|
1283
|
-
# * `:task_start_to_close_timeout` - (String)
|
1284
|
-
# * `:child_policy` - (String) Valid values include:
|
1285
|
-
# * `TERMINATE`
|
1286
|
-
# * `REQUEST_CANCEL`
|
1287
|
-
# * `ABANDON`
|
1288
|
-
# @return [Core::Response]
|
1289
|
-
# The #data method of the response object returns
|
1290
|
-
# a hash with the following structure:
|
1291
|
-
#
|
1292
|
-
# * `runId` - (String)
|
1293
|
-
|
1294
|
-
# @!method terminate_workflow_execution(options = {})
|
1295
|
-
# Calls the TerminateWorkflowExecution API operation.
|
1296
|
-
# @param [Hash] options
|
1297
|
-
#
|
1298
|
-
# * `:domain` - *required* - (String)
|
1299
|
-
# * `:workflow_id` - *required* - (String)
|
1300
|
-
# * `:run_id` - (String)
|
1301
|
-
# * `:reason` - (String)
|
1302
|
-
# * `:details` - (String)
|
1303
|
-
# * `:child_policy` - (String) Valid values include:
|
1304
|
-
# * `TERMINATE`
|
1305
|
-
# * `REQUEST_CANCEL`
|
1306
|
-
# * `ABANDON`
|
1307
|
-
# @return [Core::Response]
|
1308
|
-
|
1309
|
-
# end client methods #
|
1310
|
-
|
1311
63
|
define_client_methods('2012-01-25')
|
1312
64
|
|
1313
65
|
end
|