aws-sdk-sfn 1.0.0.rc2
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-sfn.rb +47 -0
- data/lib/aws-sdk-sfn/client.rb +763 -0
- data/lib/aws-sdk-sfn/client_api.rb +600 -0
- data/lib/aws-sdk-sfn/customizations.rb +0 -0
- data/lib/aws-sdk-sfn/errors.rb +23 -0
- data/lib/aws-sdk-sfn/resource.rb +25 -0
- data/lib/aws-sdk-sfn/types.rb +1074 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: f043990acbf0e9e951dab791e85b31cd6d3061e0
|
4
|
+
data.tar.gz: c824139a13d03f019eb31d4eaad982deda64532e
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 85dd5cc9ac08ed4e294ec310083eb2b35fc92ebf28a539c3649ea69f5024a7413b94f5e2ce57669401f2fe910778179b9923d38d43ce9232b205b2686f91f4db
|
7
|
+
data.tar.gz: 40a716a4a4cc55c1cbf94d7d4b7d658d7de015c84b3652588e327c952e124024f97242d0613f70cf0f0ba242ebe2a6438a4ebb58d1c7fb5fb518a94fcc2091e2
|
data/lib/aws-sdk-sfn.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-sfn/types'
|
12
|
+
require_relative 'aws-sdk-sfn/client_api'
|
13
|
+
require_relative 'aws-sdk-sfn/client'
|
14
|
+
require_relative 'aws-sdk-sfn/errors'
|
15
|
+
require_relative 'aws-sdk-sfn/resource'
|
16
|
+
require_relative 'aws-sdk-sfn/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Step Functions. This module is available in the
|
19
|
+
# `aws-sdk-sfn` 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 AWS Step Functions all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::SFN::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::SFN
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc2'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,763 @@
|
|
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
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:sfn)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module SFN
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :sfn
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
50
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
51
|
+
|
52
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
53
|
+
# Your AWS credentials. This can be an instance of any one of the
|
54
|
+
# following classes:
|
55
|
+
#
|
56
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
57
|
+
# credentials.
|
58
|
+
#
|
59
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
60
|
+
# from an EC2 IMDS on an EC2 instance.
|
61
|
+
#
|
62
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
63
|
+
# shared file, such as `~/.aws/config`.
|
64
|
+
#
|
65
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
66
|
+
#
|
67
|
+
# When `:credentials` are not configured directly, the following
|
68
|
+
# locations will be searched for credentials:
|
69
|
+
#
|
70
|
+
# * `Aws.config[:credentials]`
|
71
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
72
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
73
|
+
# * `~/.aws/credentials`
|
74
|
+
# * `~/.aws/config`
|
75
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
76
|
+
# very aggressive. Construct and pass an instance of
|
77
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
78
|
+
# timeouts.
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
# @option options [String] :access_key_id
|
91
|
+
# @option options [Boolean] :convert_params (true)
|
92
|
+
# When `true`, an attempt is made to coerce request parameters into
|
93
|
+
# the required types.
|
94
|
+
# @option options [String] :endpoint
|
95
|
+
# The client endpoint is normally constructed from the `:region`
|
96
|
+
# option. You should only configure an `:endpoint` when connecting
|
97
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
98
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
99
|
+
# The log formatter.
|
100
|
+
# @option options [Symbol] :log_level (:info)
|
101
|
+
# The log level to send messages to the `:logger` at.
|
102
|
+
# @option options [Logger] :logger
|
103
|
+
# The Logger instance to send log messages to. If this option
|
104
|
+
# is not set, logging will be disabled.
|
105
|
+
# @option options [String] :profile ("default")
|
106
|
+
# Used when loading credentials from the shared credentials file
|
107
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
108
|
+
# @option options [Integer] :retry_limit (3)
|
109
|
+
# The maximum number of times to retry failed requests. Only
|
110
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
111
|
+
# are retried. Generally, these are throttling errors, data
|
112
|
+
# checksum errors, networking errors, timeout errors and auth
|
113
|
+
# errors from expired credentials.
|
114
|
+
# @option options [String] :secret_access_key
|
115
|
+
# @option options [String] :session_token
|
116
|
+
# @option options [Boolean] :simple_json (false)
|
117
|
+
# Disables request parameter conversion, validation, and formatting.
|
118
|
+
# Also disable response data type conversions. This option is useful
|
119
|
+
# when you want to ensure the highest level of performance by
|
120
|
+
# avoiding overhead of walking request parameters and response data
|
121
|
+
# structures.
|
122
|
+
#
|
123
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
124
|
+
# be formatted exactly as the DynamoDB API expects.
|
125
|
+
# @option options [Boolean] :stub_responses (false)
|
126
|
+
# Causes the client to return stubbed responses. By default
|
127
|
+
# fake responses are generated and returned. You can specify
|
128
|
+
# the response data to return or errors to raise by calling
|
129
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
130
|
+
#
|
131
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
132
|
+
# requests are made, and retries are disabled.
|
133
|
+
# @option options [Boolean] :validate_params (true)
|
134
|
+
# When `true`, request parameters are validated before
|
135
|
+
# sending the request.
|
136
|
+
def initialize(*args)
|
137
|
+
super
|
138
|
+
end
|
139
|
+
|
140
|
+
# @!group API Operations
|
141
|
+
|
142
|
+
# Creates an activity.
|
143
|
+
# @option params [required, String] :name
|
144
|
+
# The name of the activity to create. This name must be unique for your
|
145
|
+
# AWS account and region.
|
146
|
+
# @return [Types::CreateActivityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
147
|
+
#
|
148
|
+
# * {Types::CreateActivityOutput#activity_arn #activityArn} => String
|
149
|
+
# * {Types::CreateActivityOutput#creation_date #creationDate} => Time
|
150
|
+
#
|
151
|
+
# @example Request syntax with placeholder values
|
152
|
+
# resp = client.create_activity({
|
153
|
+
# name: "Name", # required
|
154
|
+
# })
|
155
|
+
#
|
156
|
+
# @example Response structure
|
157
|
+
# resp.activity_arn #=> String
|
158
|
+
# resp.creation_date #=> Time
|
159
|
+
# @overload create_activity(params = {})
|
160
|
+
# @param [Hash] params ({})
|
161
|
+
def create_activity(params = {}, options = {})
|
162
|
+
req = build_request(:create_activity, params)
|
163
|
+
req.send_request(options)
|
164
|
+
end
|
165
|
+
|
166
|
+
# Creates a state machine.
|
167
|
+
# @option params [required, String] :name
|
168
|
+
# The name of the state machine. This name must be unique for your AWS
|
169
|
+
# account and region.
|
170
|
+
# @option params [required, String] :definition
|
171
|
+
# The Amazon States Language definition of the state machine.
|
172
|
+
# @option params [required, String] :role_arn
|
173
|
+
# The Amazon Resource Name (ARN) of the IAM role to use for this state
|
174
|
+
# machine.
|
175
|
+
# @return [Types::CreateStateMachineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
176
|
+
#
|
177
|
+
# * {Types::CreateStateMachineOutput#state_machine_arn #stateMachineArn} => String
|
178
|
+
# * {Types::CreateStateMachineOutput#creation_date #creationDate} => Time
|
179
|
+
#
|
180
|
+
# @example Request syntax with placeholder values
|
181
|
+
# resp = client.create_state_machine({
|
182
|
+
# name: "Name", # required
|
183
|
+
# definition: "Definition", # required
|
184
|
+
# role_arn: "Arn", # required
|
185
|
+
# })
|
186
|
+
#
|
187
|
+
# @example Response structure
|
188
|
+
# resp.state_machine_arn #=> String
|
189
|
+
# resp.creation_date #=> Time
|
190
|
+
# @overload create_state_machine(params = {})
|
191
|
+
# @param [Hash] params ({})
|
192
|
+
def create_state_machine(params = {}, options = {})
|
193
|
+
req = build_request(:create_state_machine, params)
|
194
|
+
req.send_request(options)
|
195
|
+
end
|
196
|
+
|
197
|
+
# Deletes an activity.
|
198
|
+
# @option params [required, String] :activity_arn
|
199
|
+
# The Amazon Resource Name (ARN) of the activity to delete.
|
200
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
201
|
+
#
|
202
|
+
# @example Request syntax with placeholder values
|
203
|
+
# resp = client.delete_activity({
|
204
|
+
# activity_arn: "Arn", # required
|
205
|
+
# })
|
206
|
+
# @overload delete_activity(params = {})
|
207
|
+
# @param [Hash] params ({})
|
208
|
+
def delete_activity(params = {}, options = {})
|
209
|
+
req = build_request(:delete_activity, params)
|
210
|
+
req.send_request(options)
|
211
|
+
end
|
212
|
+
|
213
|
+
# Deletes a state machine. This is an asynchronous operation-- it sets
|
214
|
+
# the state machine's status to "DELETING" and begins the delete
|
215
|
+
# process.
|
216
|
+
# @option params [required, String] :state_machine_arn
|
217
|
+
# The Amazon Resource Name (ARN) of the state machine to delete.
|
218
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
219
|
+
#
|
220
|
+
# @example Request syntax with placeholder values
|
221
|
+
# resp = client.delete_state_machine({
|
222
|
+
# state_machine_arn: "Arn", # required
|
223
|
+
# })
|
224
|
+
# @overload delete_state_machine(params = {})
|
225
|
+
# @param [Hash] params ({})
|
226
|
+
def delete_state_machine(params = {}, options = {})
|
227
|
+
req = build_request(:delete_state_machine, params)
|
228
|
+
req.send_request(options)
|
229
|
+
end
|
230
|
+
|
231
|
+
# Describes an activity.
|
232
|
+
# @option params [required, String] :activity_arn
|
233
|
+
# The Amazon Resource Name (ARN) of the activity to describe.
|
234
|
+
# @return [Types::DescribeActivityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
235
|
+
#
|
236
|
+
# * {Types::DescribeActivityOutput#activity_arn #activityArn} => String
|
237
|
+
# * {Types::DescribeActivityOutput#name #name} => String
|
238
|
+
# * {Types::DescribeActivityOutput#creation_date #creationDate} => Time
|
239
|
+
#
|
240
|
+
# @example Request syntax with placeholder values
|
241
|
+
# resp = client.describe_activity({
|
242
|
+
# activity_arn: "Arn", # required
|
243
|
+
# })
|
244
|
+
#
|
245
|
+
# @example Response structure
|
246
|
+
# resp.activity_arn #=> String
|
247
|
+
# resp.name #=> String
|
248
|
+
# resp.creation_date #=> Time
|
249
|
+
# @overload describe_activity(params = {})
|
250
|
+
# @param [Hash] params ({})
|
251
|
+
def describe_activity(params = {}, options = {})
|
252
|
+
req = build_request(:describe_activity, params)
|
253
|
+
req.send_request(options)
|
254
|
+
end
|
255
|
+
|
256
|
+
# Describes an execution.
|
257
|
+
# @option params [required, String] :execution_arn
|
258
|
+
# The Amazon Resource Name (ARN) of the execution to describe.
|
259
|
+
# @return [Types::DescribeExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
260
|
+
#
|
261
|
+
# * {Types::DescribeExecutionOutput#execution_arn #executionArn} => String
|
262
|
+
# * {Types::DescribeExecutionOutput#state_machine_arn #stateMachineArn} => String
|
263
|
+
# * {Types::DescribeExecutionOutput#name #name} => String
|
264
|
+
# * {Types::DescribeExecutionOutput#status #status} => String
|
265
|
+
# * {Types::DescribeExecutionOutput#start_date #startDate} => Time
|
266
|
+
# * {Types::DescribeExecutionOutput#stop_date #stopDate} => Time
|
267
|
+
# * {Types::DescribeExecutionOutput#input #input} => String
|
268
|
+
# * {Types::DescribeExecutionOutput#output #output} => String
|
269
|
+
#
|
270
|
+
# @example Request syntax with placeholder values
|
271
|
+
# resp = client.describe_execution({
|
272
|
+
# execution_arn: "Arn", # required
|
273
|
+
# })
|
274
|
+
#
|
275
|
+
# @example Response structure
|
276
|
+
# resp.execution_arn #=> String
|
277
|
+
# resp.state_machine_arn #=> String
|
278
|
+
# resp.name #=> String
|
279
|
+
# resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED"
|
280
|
+
# resp.start_date #=> Time
|
281
|
+
# resp.stop_date #=> Time
|
282
|
+
# resp.input #=> String
|
283
|
+
# resp.output #=> String
|
284
|
+
# @overload describe_execution(params = {})
|
285
|
+
# @param [Hash] params ({})
|
286
|
+
def describe_execution(params = {}, options = {})
|
287
|
+
req = build_request(:describe_execution, params)
|
288
|
+
req.send_request(options)
|
289
|
+
end
|
290
|
+
|
291
|
+
# Describes a state machine.
|
292
|
+
# @option params [required, String] :state_machine_arn
|
293
|
+
# The Amazon Resource Name (ARN) of the state machine to describe.
|
294
|
+
# @return [Types::DescribeStateMachineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
295
|
+
#
|
296
|
+
# * {Types::DescribeStateMachineOutput#state_machine_arn #stateMachineArn} => String
|
297
|
+
# * {Types::DescribeStateMachineOutput#name #name} => String
|
298
|
+
# * {Types::DescribeStateMachineOutput#status #status} => String
|
299
|
+
# * {Types::DescribeStateMachineOutput#definition #definition} => String
|
300
|
+
# * {Types::DescribeStateMachineOutput#role_arn #roleArn} => String
|
301
|
+
# * {Types::DescribeStateMachineOutput#creation_date #creationDate} => Time
|
302
|
+
#
|
303
|
+
# @example Request syntax with placeholder values
|
304
|
+
# resp = client.describe_state_machine({
|
305
|
+
# state_machine_arn: "Arn", # required
|
306
|
+
# })
|
307
|
+
#
|
308
|
+
# @example Response structure
|
309
|
+
# resp.state_machine_arn #=> String
|
310
|
+
# resp.name #=> String
|
311
|
+
# resp.status #=> String, one of "ACTIVE", "DELETING"
|
312
|
+
# resp.definition #=> String
|
313
|
+
# resp.role_arn #=> String
|
314
|
+
# resp.creation_date #=> Time
|
315
|
+
# @overload describe_state_machine(params = {})
|
316
|
+
# @param [Hash] params ({})
|
317
|
+
def describe_state_machine(params = {}, options = {})
|
318
|
+
req = build_request(:describe_state_machine, params)
|
319
|
+
req.send_request(options)
|
320
|
+
end
|
321
|
+
|
322
|
+
# Used by workers to retrieve a task (with the specified activity ARN)
|
323
|
+
# scheduled for execution by a running state machine. This initiates a
|
324
|
+
# long poll, where the service holds the HTTP connection open and
|
325
|
+
# responds as soon as a task becomes available (i.e. an execution of a
|
326
|
+
# task of this type is needed.) The maximum time the service holds on to
|
327
|
+
# the request before responding is 60 seconds. If no task is available
|
328
|
+
# within 60 seconds, the poll will return an empty result, that is, the
|
329
|
+
# `taskToken` returned is an empty string.
|
330
|
+
#
|
331
|
+
# Workers should set their client side socket timeout to at least 65
|
332
|
+
# seconds (5 seconds higher than the maximum time the service may hold
|
333
|
+
# the poll request).
|
334
|
+
# @option params [required, String] :activity_arn
|
335
|
+
# The Amazon Resource Name (ARN) of the activity to retrieve tasks from.
|
336
|
+
# @option params [String] :worker_name
|
337
|
+
# An arbitrary name may be provided in order to identify the worker that
|
338
|
+
# the task is assigned to. This name will be used when it is logged in
|
339
|
+
# the execution history.
|
340
|
+
# @return [Types::GetActivityTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
341
|
+
#
|
342
|
+
# * {Types::GetActivityTaskOutput#task_token #taskToken} => String
|
343
|
+
# * {Types::GetActivityTaskOutput#input #input} => String
|
344
|
+
#
|
345
|
+
# @example Request syntax with placeholder values
|
346
|
+
# resp = client.get_activity_task({
|
347
|
+
# activity_arn: "Arn", # required
|
348
|
+
# worker_name: "Name",
|
349
|
+
# })
|
350
|
+
#
|
351
|
+
# @example Response structure
|
352
|
+
# resp.task_token #=> String
|
353
|
+
# resp.input #=> String
|
354
|
+
# @overload get_activity_task(params = {})
|
355
|
+
# @param [Hash] params ({})
|
356
|
+
def get_activity_task(params = {}, options = {})
|
357
|
+
req = build_request(:get_activity_task, params)
|
358
|
+
req.send_request(options)
|
359
|
+
end
|
360
|
+
|
361
|
+
# Returns the history of the specified execution as a list of events. By
|
362
|
+
# default, the results are returned in ascending order of the
|
363
|
+
# `timeStamp` of the events. Use the `reverseOrder` parameter to get the
|
364
|
+
# latest events first. The results may be split into multiple pages. To
|
365
|
+
# retrieve subsequent pages, make the call again using the `nextToken`
|
366
|
+
# returned by the previous call.
|
367
|
+
# @option params [required, String] :execution_arn
|
368
|
+
# The Amazon Resource Name (ARN) of the execution.
|
369
|
+
# @option params [Integer] :max_results
|
370
|
+
# The maximum number of results that will be returned per call.
|
371
|
+
# `nextToken` can be used to obtain further pages of results. The
|
372
|
+
# default is 100 and the maximum allowed page size is 1000.
|
373
|
+
#
|
374
|
+
# This is an upper limit only; the actual number of results returned per
|
375
|
+
# call may be fewer than the specified maximum.
|
376
|
+
# @option params [Boolean] :reverse_order
|
377
|
+
# Lists events in descending order of their `timeStamp`.
|
378
|
+
# @option params [String] :next_token
|
379
|
+
# If a `nextToken` was returned by a previous call, there are more
|
380
|
+
# results available. To retrieve the next page of results, make the call
|
381
|
+
# again using the returned token in `nextToken`. Keep all other
|
382
|
+
# arguments unchanged.
|
383
|
+
#
|
384
|
+
# The configured `maxResults` determines how many results can be
|
385
|
+
# returned in a single call.
|
386
|
+
# @return [Types::GetExecutionHistoryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
387
|
+
#
|
388
|
+
# * {Types::GetExecutionHistoryOutput#events #events} => Array<Types::HistoryEvent>
|
389
|
+
# * {Types::GetExecutionHistoryOutput#next_token #nextToken} => String
|
390
|
+
#
|
391
|
+
# @example Request syntax with placeholder values
|
392
|
+
# resp = client.get_execution_history({
|
393
|
+
# execution_arn: "Arn", # required
|
394
|
+
# max_results: 1,
|
395
|
+
# reverse_order: false,
|
396
|
+
# next_token: "PageToken",
|
397
|
+
# })
|
398
|
+
#
|
399
|
+
# @example Response structure
|
400
|
+
# resp.events #=> Array
|
401
|
+
# resp.events[0].timestamp #=> Time
|
402
|
+
# resp.events[0].type #=> String, one of "ActivityFailed", "ActivityScheduleFailed", "ActivityScheduled", "ActivityStarted", "ActivitySucceeded", "ActivityTimedOut", "ChoiceStateEntered", "ChoiceStateExited", "ExecutionFailed", "ExecutionStarted", "ExecutionSucceeded", "ExecutionAborted", "ExecutionTimedOut", "FailStateEntered", "LambdaFunctionFailed", "LambdaFunctionScheduleFailed", "LambdaFunctionScheduled", "LambdaFunctionStartFailed", "LambdaFunctionStarted", "LambdaFunctionSucceeded", "LambdaFunctionTimedOut", "SucceedStateEntered", "SucceedStateExited", "TaskStateEntered", "TaskStateExited", "PassStateEntered", "PassStateExited", "ParallelStateEntered", "ParallelStateExited", "WaitStateEntered", "WaitStateExited"
|
403
|
+
# resp.events[0].id #=> Integer
|
404
|
+
# resp.events[0].previous_event_id #=> Integer
|
405
|
+
# resp.events[0].activity_failed_event_details.error #=> String
|
406
|
+
# resp.events[0].activity_failed_event_details.cause #=> String
|
407
|
+
# resp.events[0].activity_schedule_failed_event_details.error #=> String
|
408
|
+
# resp.events[0].activity_schedule_failed_event_details.cause #=> String
|
409
|
+
# resp.events[0].activity_scheduled_event_details.resource #=> String
|
410
|
+
# resp.events[0].activity_scheduled_event_details.input #=> String
|
411
|
+
# resp.events[0].activity_scheduled_event_details.timeout_in_seconds #=> Integer
|
412
|
+
# resp.events[0].activity_scheduled_event_details.heartbeat_in_seconds #=> Integer
|
413
|
+
# resp.events[0].activity_started_event_details.worker_name #=> String
|
414
|
+
# resp.events[0].activity_succeeded_event_details.output #=> String
|
415
|
+
# resp.events[0].activity_timed_out_event_details.error #=> String
|
416
|
+
# resp.events[0].activity_timed_out_event_details.cause #=> String
|
417
|
+
# resp.events[0].execution_failed_event_details.error #=> String
|
418
|
+
# resp.events[0].execution_failed_event_details.cause #=> String
|
419
|
+
# resp.events[0].execution_started_event_details.input #=> String
|
420
|
+
# resp.events[0].execution_started_event_details.role_arn #=> String
|
421
|
+
# resp.events[0].execution_succeeded_event_details.output #=> String
|
422
|
+
# resp.events[0].execution_aborted_event_details.error #=> String
|
423
|
+
# resp.events[0].execution_aborted_event_details.cause #=> String
|
424
|
+
# resp.events[0].execution_timed_out_event_details.error #=> String
|
425
|
+
# resp.events[0].execution_timed_out_event_details.cause #=> String
|
426
|
+
# resp.events[0].lambda_function_failed_event_details.error #=> String
|
427
|
+
# resp.events[0].lambda_function_failed_event_details.cause #=> String
|
428
|
+
# resp.events[0].lambda_function_schedule_failed_event_details.error #=> String
|
429
|
+
# resp.events[0].lambda_function_schedule_failed_event_details.cause #=> String
|
430
|
+
# resp.events[0].lambda_function_scheduled_event_details.resource #=> String
|
431
|
+
# resp.events[0].lambda_function_scheduled_event_details.input #=> String
|
432
|
+
# resp.events[0].lambda_function_scheduled_event_details.timeout_in_seconds #=> Integer
|
433
|
+
# resp.events[0].lambda_function_start_failed_event_details.error #=> String
|
434
|
+
# resp.events[0].lambda_function_start_failed_event_details.cause #=> String
|
435
|
+
# resp.events[0].lambda_function_succeeded_event_details.output #=> String
|
436
|
+
# resp.events[0].lambda_function_timed_out_event_details.error #=> String
|
437
|
+
# resp.events[0].lambda_function_timed_out_event_details.cause #=> String
|
438
|
+
# resp.events[0].state_entered_event_details.name #=> String
|
439
|
+
# resp.events[0].state_entered_event_details.input #=> String
|
440
|
+
# resp.events[0].state_exited_event_details.name #=> String
|
441
|
+
# resp.events[0].state_exited_event_details.output #=> String
|
442
|
+
# resp.next_token #=> String
|
443
|
+
# @overload get_execution_history(params = {})
|
444
|
+
# @param [Hash] params ({})
|
445
|
+
def get_execution_history(params = {}, options = {})
|
446
|
+
req = build_request(:get_execution_history, params)
|
447
|
+
req.send_request(options)
|
448
|
+
end
|
449
|
+
|
450
|
+
# Lists the existing activities. The results may be split into multiple
|
451
|
+
# pages. To retrieve subsequent pages, make the call again using the
|
452
|
+
# `nextToken` returned by the previous call.
|
453
|
+
# @option params [Integer] :max_results
|
454
|
+
# The maximum number of results that will be returned per call.
|
455
|
+
# `nextToken` can be used to obtain further pages of results. The
|
456
|
+
# default is 100 and the maximum allowed page size is 1000.
|
457
|
+
#
|
458
|
+
# This is an upper limit only; the actual number of results returned per
|
459
|
+
# call may be fewer than the specified maximum.
|
460
|
+
# @option params [String] :next_token
|
461
|
+
# If a `nextToken` was returned by a previous call, there are more
|
462
|
+
# results available. To retrieve the next page of results, make the call
|
463
|
+
# again using the returned token in `nextToken`. Keep all other
|
464
|
+
# arguments unchanged.
|
465
|
+
#
|
466
|
+
# The configured `maxResults` determines how many results can be
|
467
|
+
# returned in a single call.
|
468
|
+
# @return [Types::ListActivitiesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
469
|
+
#
|
470
|
+
# * {Types::ListActivitiesOutput#activities #activities} => Array<Types::ActivityListItem>
|
471
|
+
# * {Types::ListActivitiesOutput#next_token #nextToken} => String
|
472
|
+
#
|
473
|
+
# @example Request syntax with placeholder values
|
474
|
+
# resp = client.list_activities({
|
475
|
+
# max_results: 1,
|
476
|
+
# next_token: "PageToken",
|
477
|
+
# })
|
478
|
+
#
|
479
|
+
# @example Response structure
|
480
|
+
# resp.activities #=> Array
|
481
|
+
# resp.activities[0].activity_arn #=> String
|
482
|
+
# resp.activities[0].name #=> String
|
483
|
+
# resp.activities[0].creation_date #=> Time
|
484
|
+
# resp.next_token #=> String
|
485
|
+
# @overload list_activities(params = {})
|
486
|
+
# @param [Hash] params ({})
|
487
|
+
def list_activities(params = {}, options = {})
|
488
|
+
req = build_request(:list_activities, params)
|
489
|
+
req.send_request(options)
|
490
|
+
end
|
491
|
+
|
492
|
+
# Lists the executions of a state machine that meet the filtering
|
493
|
+
# criteria. The results may be split into multiple pages. To retrieve
|
494
|
+
# subsequent pages, make the call again using the `nextToken` returned
|
495
|
+
# by the previous call.
|
496
|
+
# @option params [required, String] :state_machine_arn
|
497
|
+
# The Amazon Resource Name (ARN) of the state machine whose executions
|
498
|
+
# will be listed.
|
499
|
+
# @option params [String] :status_filter
|
500
|
+
# If specified, only list the executions whose current execution status
|
501
|
+
# matches the given filter.
|
502
|
+
# @option params [Integer] :max_results
|
503
|
+
# The maximum number of results that will be returned per call.
|
504
|
+
# `nextToken` can be used to obtain further pages of results. The
|
505
|
+
# default is 100 and the maximum allowed page size is 1000.
|
506
|
+
#
|
507
|
+
# This is an upper limit only; the actual number of results returned per
|
508
|
+
# call may be fewer than the specified maximum.
|
509
|
+
# @option params [String] :next_token
|
510
|
+
# If a `nextToken` was returned by a previous call, there are more
|
511
|
+
# results available. To retrieve the next page of results, make the call
|
512
|
+
# again using the returned token in `nextToken`. Keep all other
|
513
|
+
# arguments unchanged.
|
514
|
+
#
|
515
|
+
# The configured `maxResults` determines how many results can be
|
516
|
+
# returned in a single call.
|
517
|
+
# @return [Types::ListExecutionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
518
|
+
#
|
519
|
+
# * {Types::ListExecutionsOutput#executions #executions} => Array<Types::ExecutionListItem>
|
520
|
+
# * {Types::ListExecutionsOutput#next_token #nextToken} => String
|
521
|
+
#
|
522
|
+
# @example Request syntax with placeholder values
|
523
|
+
# resp = client.list_executions({
|
524
|
+
# state_machine_arn: "Arn", # required
|
525
|
+
# status_filter: "RUNNING", # accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED
|
526
|
+
# max_results: 1,
|
527
|
+
# next_token: "PageToken",
|
528
|
+
# })
|
529
|
+
#
|
530
|
+
# @example Response structure
|
531
|
+
# resp.executions #=> Array
|
532
|
+
# resp.executions[0].execution_arn #=> String
|
533
|
+
# resp.executions[0].state_machine_arn #=> String
|
534
|
+
# resp.executions[0].name #=> String
|
535
|
+
# resp.executions[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED"
|
536
|
+
# resp.executions[0].start_date #=> Time
|
537
|
+
# resp.executions[0].stop_date #=> Time
|
538
|
+
# resp.next_token #=> String
|
539
|
+
# @overload list_executions(params = {})
|
540
|
+
# @param [Hash] params ({})
|
541
|
+
def list_executions(params = {}, options = {})
|
542
|
+
req = build_request(:list_executions, params)
|
543
|
+
req.send_request(options)
|
544
|
+
end
|
545
|
+
|
546
|
+
# Lists the existing state machines. The results may be split into
|
547
|
+
# multiple pages. To retrieve subsequent pages, make the call again
|
548
|
+
# using the `nextToken` returned by the previous call.
|
549
|
+
# @option params [Integer] :max_results
|
550
|
+
# The maximum number of results that will be returned per call.
|
551
|
+
# `nextToken` can be used to obtain further pages of results. The
|
552
|
+
# default is 100 and the maximum allowed page size is 1000.
|
553
|
+
#
|
554
|
+
# This is an upper limit only; the actual number of results returned per
|
555
|
+
# call may be fewer than the specified maximum.
|
556
|
+
# @option params [String] :next_token
|
557
|
+
# If a `nextToken` was returned by a previous call, there are more
|
558
|
+
# results available. To retrieve the next page of results, make the call
|
559
|
+
# again using the returned token in `nextToken`. Keep all other
|
560
|
+
# arguments unchanged.
|
561
|
+
#
|
562
|
+
# The configured `maxResults` determines how many results can be
|
563
|
+
# returned in a single call.
|
564
|
+
# @return [Types::ListStateMachinesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
565
|
+
#
|
566
|
+
# * {Types::ListStateMachinesOutput#state_machines #stateMachines} => Array<Types::StateMachineListItem>
|
567
|
+
# * {Types::ListStateMachinesOutput#next_token #nextToken} => String
|
568
|
+
#
|
569
|
+
# @example Request syntax with placeholder values
|
570
|
+
# resp = client.list_state_machines({
|
571
|
+
# max_results: 1,
|
572
|
+
# next_token: "PageToken",
|
573
|
+
# })
|
574
|
+
#
|
575
|
+
# @example Response structure
|
576
|
+
# resp.state_machines #=> Array
|
577
|
+
# resp.state_machines[0].state_machine_arn #=> String
|
578
|
+
# resp.state_machines[0].name #=> String
|
579
|
+
# resp.state_machines[0].creation_date #=> Time
|
580
|
+
# resp.next_token #=> String
|
581
|
+
# @overload list_state_machines(params = {})
|
582
|
+
# @param [Hash] params ({})
|
583
|
+
def list_state_machines(params = {}, options = {})
|
584
|
+
req = build_request(:list_state_machines, params)
|
585
|
+
req.send_request(options)
|
586
|
+
end
|
587
|
+
|
588
|
+
# Used by workers to report that the task identified by the `taskToken`
|
589
|
+
# failed.
|
590
|
+
# @option params [required, String] :task_token
|
591
|
+
# The token that represents this task. Task tokens are generated by the
|
592
|
+
# service when the tasks are assigned to a worker (see
|
593
|
+
# GetActivityTask::taskToken).
|
594
|
+
# @option params [String] :error
|
595
|
+
# An arbitrary error code that identifies the cause of the failure.
|
596
|
+
# @option params [String] :cause
|
597
|
+
# A more detailed explanation of the cause of the failure.
|
598
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
599
|
+
#
|
600
|
+
# @example Request syntax with placeholder values
|
601
|
+
# resp = client.send_task_failure({
|
602
|
+
# task_token: "TaskToken", # required
|
603
|
+
# error: "Error",
|
604
|
+
# cause: "Cause",
|
605
|
+
# })
|
606
|
+
# @overload send_task_failure(params = {})
|
607
|
+
# @param [Hash] params ({})
|
608
|
+
def send_task_failure(params = {}, options = {})
|
609
|
+
req = build_request(:send_task_failure, params)
|
610
|
+
req.send_request(options)
|
611
|
+
end
|
612
|
+
|
613
|
+
# Used by workers to report to the service that the task represented by
|
614
|
+
# the specified `taskToken` is still making progress. This action resets
|
615
|
+
# the `Heartbeat` clock. The `Heartbeat` threshold is specified in the
|
616
|
+
# state machine's Amazon States Language definition. This action does
|
617
|
+
# not in itself create an event in the execution history. However, if
|
618
|
+
# the task times out, the execution history will contain an
|
619
|
+
# `ActivityTimedOut` event.
|
620
|
+
#
|
621
|
+
# <note markdown="1"> The `Timeout` of a task, defined in the state machine's Amazon States
|
622
|
+
# Language definition, is its maximum allowed duration, regardless of
|
623
|
+
# the number of SendTaskHeartbeat requests received.
|
624
|
+
#
|
625
|
+
# </note>
|
626
|
+
#
|
627
|
+
# <note markdown="1"> This operation is only useful for long-lived tasks to report the
|
628
|
+
# liveliness of the task.
|
629
|
+
#
|
630
|
+
# </note>
|
631
|
+
# @option params [required, String] :task_token
|
632
|
+
# The token that represents this task. Task tokens are generated by the
|
633
|
+
# service when the tasks are assigned to a worker (see
|
634
|
+
# GetActivityTask::taskToken).
|
635
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
636
|
+
#
|
637
|
+
# @example Request syntax with placeholder values
|
638
|
+
# resp = client.send_task_heartbeat({
|
639
|
+
# task_token: "TaskToken", # required
|
640
|
+
# })
|
641
|
+
# @overload send_task_heartbeat(params = {})
|
642
|
+
# @param [Hash] params ({})
|
643
|
+
def send_task_heartbeat(params = {}, options = {})
|
644
|
+
req = build_request(:send_task_heartbeat, params)
|
645
|
+
req.send_request(options)
|
646
|
+
end
|
647
|
+
|
648
|
+
# Used by workers to report that the task identified by the `taskToken`
|
649
|
+
# completed successfully.
|
650
|
+
# @option params [required, String] :task_token
|
651
|
+
# The token that represents this task. Task tokens are generated by the
|
652
|
+
# service when the tasks are assigned to a worker (see
|
653
|
+
# GetActivityTask::taskToken).
|
654
|
+
# @option params [required, String] :output
|
655
|
+
# The JSON output of the task.
|
656
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
657
|
+
#
|
658
|
+
# @example Request syntax with placeholder values
|
659
|
+
# resp = client.send_task_success({
|
660
|
+
# task_token: "TaskToken", # required
|
661
|
+
# output: "Data", # required
|
662
|
+
# })
|
663
|
+
# @overload send_task_success(params = {})
|
664
|
+
# @param [Hash] params ({})
|
665
|
+
def send_task_success(params = {}, options = {})
|
666
|
+
req = build_request(:send_task_success, params)
|
667
|
+
req.send_request(options)
|
668
|
+
end
|
669
|
+
|
670
|
+
# Starts a state machine execution.
|
671
|
+
# @option params [required, String] :state_machine_arn
|
672
|
+
# The Amazon Resource Name (ARN) of the state machine to execute.
|
673
|
+
# @option params [String] :name
|
674
|
+
# The name of the execution. This name must be unique for your AWS
|
675
|
+
# account and region.
|
676
|
+
# @option params [String] :input
|
677
|
+
# The JSON input data for the execution.
|
678
|
+
# @return [Types::StartExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
679
|
+
#
|
680
|
+
# * {Types::StartExecutionOutput#execution_arn #executionArn} => String
|
681
|
+
# * {Types::StartExecutionOutput#start_date #startDate} => Time
|
682
|
+
#
|
683
|
+
# @example Request syntax with placeholder values
|
684
|
+
# resp = client.start_execution({
|
685
|
+
# state_machine_arn: "Arn", # required
|
686
|
+
# name: "Name",
|
687
|
+
# input: "Data",
|
688
|
+
# })
|
689
|
+
#
|
690
|
+
# @example Response structure
|
691
|
+
# resp.execution_arn #=> String
|
692
|
+
# resp.start_date #=> Time
|
693
|
+
# @overload start_execution(params = {})
|
694
|
+
# @param [Hash] params ({})
|
695
|
+
def start_execution(params = {}, options = {})
|
696
|
+
req = build_request(:start_execution, params)
|
697
|
+
req.send_request(options)
|
698
|
+
end
|
699
|
+
|
700
|
+
# Stops an execution.
|
701
|
+
# @option params [required, String] :execution_arn
|
702
|
+
# The Amazon Resource Name (ARN) of the execution to stop.
|
703
|
+
# @option params [String] :error
|
704
|
+
# An arbitrary error code that identifies the cause of the termination.
|
705
|
+
# @option params [String] :cause
|
706
|
+
# A more detailed explanation of the cause of the termination.
|
707
|
+
# @return [Types::StopExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
708
|
+
#
|
709
|
+
# * {Types::StopExecutionOutput#stop_date #stopDate} => Time
|
710
|
+
#
|
711
|
+
# @example Request syntax with placeholder values
|
712
|
+
# resp = client.stop_execution({
|
713
|
+
# execution_arn: "Arn", # required
|
714
|
+
# error: "Error",
|
715
|
+
# cause: "Cause",
|
716
|
+
# })
|
717
|
+
#
|
718
|
+
# @example Response structure
|
719
|
+
# resp.stop_date #=> Time
|
720
|
+
# @overload stop_execution(params = {})
|
721
|
+
# @param [Hash] params ({})
|
722
|
+
def stop_execution(params = {}, options = {})
|
723
|
+
req = build_request(:stop_execution, params)
|
724
|
+
req.send_request(options)
|
725
|
+
end
|
726
|
+
|
727
|
+
# @!endgroup
|
728
|
+
|
729
|
+
# @param params ({})
|
730
|
+
# @api private
|
731
|
+
def build_request(operation_name, params = {})
|
732
|
+
handlers = @handlers.for(operation_name)
|
733
|
+
context = Seahorse::Client::RequestContext.new(
|
734
|
+
operation_name: operation_name,
|
735
|
+
operation: config.api.operation(operation_name),
|
736
|
+
client: self,
|
737
|
+
params: params,
|
738
|
+
config: config)
|
739
|
+
context[:gem_name] = 'aws-sdk-sfn'
|
740
|
+
context[:gem_version] = '1.0.0.rc2'
|
741
|
+
Seahorse::Client::Request.new(handlers, context)
|
742
|
+
end
|
743
|
+
|
744
|
+
# @api private
|
745
|
+
# @deprecated
|
746
|
+
def waiter_names
|
747
|
+
[]
|
748
|
+
end
|
749
|
+
|
750
|
+
class << self
|
751
|
+
|
752
|
+
# @api private
|
753
|
+
attr_reader :identifier
|
754
|
+
|
755
|
+
# @api private
|
756
|
+
def errors_module
|
757
|
+
Errors
|
758
|
+
end
|
759
|
+
|
760
|
+
end
|
761
|
+
end
|
762
|
+
end
|
763
|
+
end
|