aws-sdk-states 1.0.0.rc1

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.
File without changes
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::States
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::States
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,1255 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::States
9
+ module Types
10
+
11
+ # @!attribute [rw] error
12
+ # The error code of the failure.
13
+ # @return [String]
14
+ #
15
+ # @!attribute [rw] cause
16
+ # A more detailed explanation of the cause of the failure.
17
+ # @return [String]
18
+ #
19
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityFailedEventDetails AWS API Documentation
20
+ #
21
+ class ActivityFailedEventDetails < Struct.new(
22
+ :error,
23
+ :cause)
24
+ include Aws::Structure
25
+ end
26
+
27
+ # @!attribute [rw] activity_arn
28
+ # The Amazon Resource Name (ARN) that identifies the activity.
29
+ # @return [String]
30
+ #
31
+ # @!attribute [rw] name
32
+ # The name of the activity.
33
+ # @return [String]
34
+ #
35
+ # @!attribute [rw] creation_date
36
+ # The date the activity was created.
37
+ # @return [Time]
38
+ #
39
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityListItem AWS API Documentation
40
+ #
41
+ class ActivityListItem < Struct.new(
42
+ :activity_arn,
43
+ :name,
44
+ :creation_date)
45
+ include Aws::Structure
46
+ end
47
+
48
+ # @!attribute [rw] error
49
+ # The error code of the failure.
50
+ # @return [String]
51
+ #
52
+ # @!attribute [rw] cause
53
+ # A more detailed explanation of the cause of the failure.
54
+ # @return [String]
55
+ #
56
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityScheduleFailedEventDetails AWS API Documentation
57
+ #
58
+ class ActivityScheduleFailedEventDetails < Struct.new(
59
+ :error,
60
+ :cause)
61
+ include Aws::Structure
62
+ end
63
+
64
+ # @!attribute [rw] resource
65
+ # The Amazon Resource Name (ARN) of the scheduled activity.
66
+ # @return [String]
67
+ #
68
+ # @!attribute [rw] input
69
+ # The JSON data input to the activity task.
70
+ # @return [String]
71
+ #
72
+ # @!attribute [rw] timeout_in_seconds
73
+ # The maximum allowed duration of the activity task.
74
+ # @return [Integer]
75
+ #
76
+ # @!attribute [rw] heartbeat_in_seconds
77
+ # The maximum allowed duration between two heartbeats for the activity
78
+ # task.
79
+ # @return [Integer]
80
+ #
81
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityScheduledEventDetails AWS API Documentation
82
+ #
83
+ class ActivityScheduledEventDetails < Struct.new(
84
+ :resource,
85
+ :input,
86
+ :timeout_in_seconds,
87
+ :heartbeat_in_seconds)
88
+ include Aws::Structure
89
+ end
90
+
91
+ # @!attribute [rw] worker_name
92
+ # The name of the worker that the task was assigned to. These names
93
+ # are provided by the workers when calling GetActivityTask.
94
+ # @return [String]
95
+ #
96
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityStartedEventDetails AWS API Documentation
97
+ #
98
+ class ActivityStartedEventDetails < Struct.new(
99
+ :worker_name)
100
+ include Aws::Structure
101
+ end
102
+
103
+ # @!attribute [rw] output
104
+ # The JSON data output by the activity task.
105
+ # @return [String]
106
+ #
107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivitySucceededEventDetails AWS API Documentation
108
+ #
109
+ class ActivitySucceededEventDetails < Struct.new(
110
+ :output)
111
+ include Aws::Structure
112
+ end
113
+
114
+ # @!attribute [rw] error
115
+ # The error code of the failure.
116
+ # @return [String]
117
+ #
118
+ # @!attribute [rw] cause
119
+ # A more detailed explanation of the cause of the timeout.
120
+ # @return [String]
121
+ #
122
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivityTimedOutEventDetails AWS API Documentation
123
+ #
124
+ class ActivityTimedOutEventDetails < Struct.new(
125
+ :error,
126
+ :cause)
127
+ include Aws::Structure
128
+ end
129
+
130
+ # @note When making an API call, you may pass CreateActivityInput
131
+ # data as a hash:
132
+ #
133
+ # {
134
+ # name: "Name", # required
135
+ # }
136
+ #
137
+ # @!attribute [rw] name
138
+ # The name of the activity to create. This name must be unique for
139
+ # your AWS account and region.
140
+ # @return [String]
141
+ #
142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivityInput AWS API Documentation
143
+ #
144
+ class CreateActivityInput < Struct.new(
145
+ :name)
146
+ include Aws::Structure
147
+ end
148
+
149
+ # @!attribute [rw] activity_arn
150
+ # The Amazon Resource Name (ARN) that identifies the created activity.
151
+ # @return [String]
152
+ #
153
+ # @!attribute [rw] creation_date
154
+ # The date the activity was created.
155
+ # @return [Time]
156
+ #
157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivityOutput AWS API Documentation
158
+ #
159
+ class CreateActivityOutput < Struct.new(
160
+ :activity_arn,
161
+ :creation_date)
162
+ include Aws::Structure
163
+ end
164
+
165
+ # @note When making an API call, you may pass CreateStateMachineInput
166
+ # data as a hash:
167
+ #
168
+ # {
169
+ # name: "Name", # required
170
+ # definition: "Definition", # required
171
+ # role_arn: "Arn", # required
172
+ # }
173
+ #
174
+ # @!attribute [rw] name
175
+ # The name of the state machine. This name must be unique for your AWS
176
+ # account and region.
177
+ # @return [String]
178
+ #
179
+ # @!attribute [rw] definition
180
+ # The Amazon States Language definition of the state machine.
181
+ # @return [String]
182
+ #
183
+ # @!attribute [rw] role_arn
184
+ # The Amazon Resource Name (ARN) of the IAM role to use for this state
185
+ # machine.
186
+ # @return [String]
187
+ #
188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineInput AWS API Documentation
189
+ #
190
+ class CreateStateMachineInput < Struct.new(
191
+ :name,
192
+ :definition,
193
+ :role_arn)
194
+ include Aws::Structure
195
+ end
196
+
197
+ # @!attribute [rw] state_machine_arn
198
+ # The Amazon Resource Name (ARN) that identifies the created state
199
+ # machine.
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] creation_date
203
+ # The date the state machine was created.
204
+ # @return [Time]
205
+ #
206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineOutput AWS API Documentation
207
+ #
208
+ class CreateStateMachineOutput < Struct.new(
209
+ :state_machine_arn,
210
+ :creation_date)
211
+ include Aws::Structure
212
+ end
213
+
214
+ # @note When making an API call, you may pass DeleteActivityInput
215
+ # data as a hash:
216
+ #
217
+ # {
218
+ # activity_arn: "Arn", # required
219
+ # }
220
+ #
221
+ # @!attribute [rw] activity_arn
222
+ # The Amazon Resource Name (ARN) of the activity to delete.
223
+ # @return [String]
224
+ #
225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivityInput AWS API Documentation
226
+ #
227
+ class DeleteActivityInput < Struct.new(
228
+ :activity_arn)
229
+ include Aws::Structure
230
+ end
231
+
232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivityOutput AWS API Documentation
233
+ #
234
+ class DeleteActivityOutput < Aws::EmptyStructure; end
235
+
236
+ # @note When making an API call, you may pass DeleteStateMachineInput
237
+ # data as a hash:
238
+ #
239
+ # {
240
+ # state_machine_arn: "Arn", # required
241
+ # }
242
+ #
243
+ # @!attribute [rw] state_machine_arn
244
+ # The Amazon Resource Name (ARN) of the state machine to delete.
245
+ # @return [String]
246
+ #
247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineInput AWS API Documentation
248
+ #
249
+ class DeleteStateMachineInput < Struct.new(
250
+ :state_machine_arn)
251
+ include Aws::Structure
252
+ end
253
+
254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachineOutput AWS API Documentation
255
+ #
256
+ class DeleteStateMachineOutput < Aws::EmptyStructure; end
257
+
258
+ # @note When making an API call, you may pass DescribeActivityInput
259
+ # data as a hash:
260
+ #
261
+ # {
262
+ # activity_arn: "Arn", # required
263
+ # }
264
+ #
265
+ # @!attribute [rw] activity_arn
266
+ # The Amazon Resource Name (ARN) of the activity to describe.
267
+ # @return [String]
268
+ #
269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivityInput AWS API Documentation
270
+ #
271
+ class DescribeActivityInput < Struct.new(
272
+ :activity_arn)
273
+ include Aws::Structure
274
+ end
275
+
276
+ # @!attribute [rw] activity_arn
277
+ # The Amazon Resource Name (ARN) that identifies the activity.
278
+ # @return [String]
279
+ #
280
+ # @!attribute [rw] name
281
+ # The name of the activity.
282
+ # @return [String]
283
+ #
284
+ # @!attribute [rw] creation_date
285
+ # The date the activity was created.
286
+ # @return [Time]
287
+ #
288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivityOutput AWS API Documentation
289
+ #
290
+ class DescribeActivityOutput < Struct.new(
291
+ :activity_arn,
292
+ :name,
293
+ :creation_date)
294
+ include Aws::Structure
295
+ end
296
+
297
+ # @note When making an API call, you may pass DescribeExecutionInput
298
+ # data as a hash:
299
+ #
300
+ # {
301
+ # execution_arn: "Arn", # required
302
+ # }
303
+ #
304
+ # @!attribute [rw] execution_arn
305
+ # The Amazon Resource Name (ARN) of the execution to describe.
306
+ # @return [String]
307
+ #
308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecutionInput AWS API Documentation
309
+ #
310
+ class DescribeExecutionInput < Struct.new(
311
+ :execution_arn)
312
+ include Aws::Structure
313
+ end
314
+
315
+ # @!attribute [rw] execution_arn
316
+ # The Amazon Resource Name (ARN) that identifies the execution.
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] state_machine_arn
320
+ # The Amazon Resource Name (ARN) of the executed stated machine.
321
+ # @return [String]
322
+ #
323
+ # @!attribute [rw] name
324
+ # The name of the execution.
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] status
328
+ # The current status of the execution.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] start_date
332
+ # The date the execution was started.
333
+ # @return [Time]
334
+ #
335
+ # @!attribute [rw] stop_date
336
+ # If the execution has already ended, the date the execution stopped.
337
+ # @return [Time]
338
+ #
339
+ # @!attribute [rw] input
340
+ # The JSON input data of the execution.
341
+ # @return [String]
342
+ #
343
+ # @!attribute [rw] output
344
+ # The JSON output data of the execution.
345
+ # @return [String]
346
+ #
347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecutionOutput AWS API Documentation
348
+ #
349
+ class DescribeExecutionOutput < Struct.new(
350
+ :execution_arn,
351
+ :state_machine_arn,
352
+ :name,
353
+ :status,
354
+ :start_date,
355
+ :stop_date,
356
+ :input,
357
+ :output)
358
+ include Aws::Structure
359
+ end
360
+
361
+ # @note When making an API call, you may pass DescribeStateMachineInput
362
+ # data as a hash:
363
+ #
364
+ # {
365
+ # state_machine_arn: "Arn", # required
366
+ # }
367
+ #
368
+ # @!attribute [rw] state_machine_arn
369
+ # The Amazon Resource Name (ARN) of the state machine to describe.
370
+ # @return [String]
371
+ #
372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineInput AWS API Documentation
373
+ #
374
+ class DescribeStateMachineInput < Struct.new(
375
+ :state_machine_arn)
376
+ include Aws::Structure
377
+ end
378
+
379
+ # @!attribute [rw] state_machine_arn
380
+ # The Amazon Resource Name (ARN) that identifies the state machine.
381
+ # @return [String]
382
+ #
383
+ # @!attribute [rw] name
384
+ # The name of the state machine.
385
+ # @return [String]
386
+ #
387
+ # @!attribute [rw] status
388
+ # The current status of the state machine.
389
+ # @return [String]
390
+ #
391
+ # @!attribute [rw] definition
392
+ # The Amazon States Language definition of the state machine.
393
+ # @return [String]
394
+ #
395
+ # @!attribute [rw] role_arn
396
+ # The Amazon Resource Name (ARN) of the IAM role used for executing
397
+ # this state machine.
398
+ # @return [String]
399
+ #
400
+ # @!attribute [rw] creation_date
401
+ # The date the state machine was created.
402
+ # @return [Time]
403
+ #
404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineOutput AWS API Documentation
405
+ #
406
+ class DescribeStateMachineOutput < Struct.new(
407
+ :state_machine_arn,
408
+ :name,
409
+ :status,
410
+ :definition,
411
+ :role_arn,
412
+ :creation_date)
413
+ include Aws::Structure
414
+ end
415
+
416
+ # @!attribute [rw] error
417
+ # The error code of the failure.
418
+ # @return [String]
419
+ #
420
+ # @!attribute [rw] cause
421
+ # A more detailed explanation of the cause of the failure.
422
+ # @return [String]
423
+ #
424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionAbortedEventDetails AWS API Documentation
425
+ #
426
+ class ExecutionAbortedEventDetails < Struct.new(
427
+ :error,
428
+ :cause)
429
+ include Aws::Structure
430
+ end
431
+
432
+ # @!attribute [rw] error
433
+ # The error code of the failure.
434
+ # @return [String]
435
+ #
436
+ # @!attribute [rw] cause
437
+ # A more detailed explanation of the cause of the failure.
438
+ # @return [String]
439
+ #
440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionFailedEventDetails AWS API Documentation
441
+ #
442
+ class ExecutionFailedEventDetails < Struct.new(
443
+ :error,
444
+ :cause)
445
+ include Aws::Structure
446
+ end
447
+
448
+ # @!attribute [rw] execution_arn
449
+ # The Amazon Resource Name (ARN) that identifies the execution.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] state_machine_arn
453
+ # The Amazon Resource Name (ARN) of the executed state machine.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] name
457
+ # The name of the execution.
458
+ # @return [String]
459
+ #
460
+ # @!attribute [rw] status
461
+ # The current status of the execution.
462
+ # @return [String]
463
+ #
464
+ # @!attribute [rw] start_date
465
+ # The date the execution started.
466
+ # @return [Time]
467
+ #
468
+ # @!attribute [rw] stop_date
469
+ # If the execution already ended, the date the execution stopped.
470
+ # @return [Time]
471
+ #
472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionListItem AWS API Documentation
473
+ #
474
+ class ExecutionListItem < Struct.new(
475
+ :execution_arn,
476
+ :state_machine_arn,
477
+ :name,
478
+ :status,
479
+ :start_date,
480
+ :stop_date)
481
+ include Aws::Structure
482
+ end
483
+
484
+ # @!attribute [rw] input
485
+ # The JSON data input to the execution.
486
+ # @return [String]
487
+ #
488
+ # @!attribute [rw] role_arn
489
+ # The Amazon Resource Name (ARN) of the IAM role used for executing
490
+ # AWS Lambda tasks.
491
+ # @return [String]
492
+ #
493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionStartedEventDetails AWS API Documentation
494
+ #
495
+ class ExecutionStartedEventDetails < Struct.new(
496
+ :input,
497
+ :role_arn)
498
+ include Aws::Structure
499
+ end
500
+
501
+ # @!attribute [rw] output
502
+ # The JSON data output by the execution.
503
+ # @return [String]
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionSucceededEventDetails AWS API Documentation
506
+ #
507
+ class ExecutionSucceededEventDetails < Struct.new(
508
+ :output)
509
+ include Aws::Structure
510
+ end
511
+
512
+ # @!attribute [rw] error
513
+ # The error code of the failure.
514
+ # @return [String]
515
+ #
516
+ # @!attribute [rw] cause
517
+ # A more detailed explanation of the cause of the timeout.
518
+ # @return [String]
519
+ #
520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionTimedOutEventDetails AWS API Documentation
521
+ #
522
+ class ExecutionTimedOutEventDetails < Struct.new(
523
+ :error,
524
+ :cause)
525
+ include Aws::Structure
526
+ end
527
+
528
+ # @note When making an API call, you may pass GetActivityTaskInput
529
+ # data as a hash:
530
+ #
531
+ # {
532
+ # activity_arn: "Arn", # required
533
+ # worker_name: "Name",
534
+ # }
535
+ #
536
+ # @!attribute [rw] activity_arn
537
+ # The Amazon Resource Name (ARN) of the activity to retrieve tasks
538
+ # from.
539
+ # @return [String]
540
+ #
541
+ # @!attribute [rw] worker_name
542
+ # An arbitrary name may be provided in order to identify the worker
543
+ # that the task is assigned to. This name will be used when it is
544
+ # logged in the execution history.
545
+ # @return [String]
546
+ #
547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTaskInput AWS API Documentation
548
+ #
549
+ class GetActivityTaskInput < Struct.new(
550
+ :activity_arn,
551
+ :worker_name)
552
+ include Aws::Structure
553
+ end
554
+
555
+ # @!attribute [rw] task_token
556
+ # A token that identifies the scheduled task. This token must be
557
+ # copied and included in subsequent calls to SendTaskHeartbeat,
558
+ # SendTaskSuccess or SendTaskFailure in order to report the progress
559
+ # or completion of the task.
560
+ # @return [String]
561
+ #
562
+ # @!attribute [rw] input
563
+ # The JSON input data for the task.
564
+ # @return [String]
565
+ #
566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTaskOutput AWS API Documentation
567
+ #
568
+ class GetActivityTaskOutput < Struct.new(
569
+ :task_token,
570
+ :input)
571
+ include Aws::Structure
572
+ end
573
+
574
+ # @note When making an API call, you may pass GetExecutionHistoryInput
575
+ # data as a hash:
576
+ #
577
+ # {
578
+ # execution_arn: "Arn", # required
579
+ # max_results: 1,
580
+ # reverse_order: false,
581
+ # next_token: "PageToken",
582
+ # }
583
+ #
584
+ # @!attribute [rw] execution_arn
585
+ # The Amazon Resource Name (ARN) of the execution.
586
+ # @return [String]
587
+ #
588
+ # @!attribute [rw] max_results
589
+ # The maximum number of results that will be returned per call.
590
+ # `nextToken` can be used to obtain further pages of results. The
591
+ # default is 100 and the maximum allowed page size is 1000.
592
+ #
593
+ # This is an upper limit only; the actual number of results returned
594
+ # per call may be fewer than the specified maximum.
595
+ # @return [Integer]
596
+ #
597
+ # @!attribute [rw] reverse_order
598
+ # Lists events in descending order of their `timeStamp`.
599
+ # @return [Boolean]
600
+ #
601
+ # @!attribute [rw] next_token
602
+ # If a `nextToken` was returned by a previous call, there are more
603
+ # results available. To retrieve the next page of results, make the
604
+ # call again using the returned token in `nextToken`. Keep all other
605
+ # arguments unchanged.
606
+ #
607
+ # The configured `maxResults` determines how many results can be
608
+ # returned in a single call.
609
+ # @return [String]
610
+ #
611
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistoryInput AWS API Documentation
612
+ #
613
+ class GetExecutionHistoryInput < Struct.new(
614
+ :execution_arn,
615
+ :max_results,
616
+ :reverse_order,
617
+ :next_token)
618
+ include Aws::Structure
619
+ end
620
+
621
+ # @!attribute [rw] events
622
+ # The list of events that occurred in the execution.
623
+ # @return [Array<Types::HistoryEvent>]
624
+ #
625
+ # @!attribute [rw] next_token
626
+ # If a `nextToken` is returned, there are more results available. To
627
+ # retrieve the next page of results, make the call again using the
628
+ # returned token in `nextToken`. Keep all other arguments unchanged.
629
+ #
630
+ # The configured `maxResults` determines how many results can be
631
+ # returned in a single call.
632
+ # @return [String]
633
+ #
634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistoryOutput AWS API Documentation
635
+ #
636
+ class GetExecutionHistoryOutput < Struct.new(
637
+ :events,
638
+ :next_token)
639
+ include Aws::Structure
640
+ end
641
+
642
+ # @!attribute [rw] timestamp
643
+ # The date the event occured.
644
+ # @return [Time]
645
+ #
646
+ # @!attribute [rw] type
647
+ # The type of the event.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] id
651
+ # The id of the event. Events are numbered sequentially, starting at
652
+ # one.
653
+ # @return [Integer]
654
+ #
655
+ # @!attribute [rw] previous_event_id
656
+ # The id of the previous event.
657
+ # @return [Integer]
658
+ #
659
+ # @!attribute [rw] activity_failed_event_details
660
+ # @return [Types::ActivityFailedEventDetails]
661
+ #
662
+ # @!attribute [rw] activity_schedule_failed_event_details
663
+ # @return [Types::ActivityScheduleFailedEventDetails]
664
+ #
665
+ # @!attribute [rw] activity_scheduled_event_details
666
+ # @return [Types::ActivityScheduledEventDetails]
667
+ #
668
+ # @!attribute [rw] activity_started_event_details
669
+ # @return [Types::ActivityStartedEventDetails]
670
+ #
671
+ # @!attribute [rw] activity_succeeded_event_details
672
+ # @return [Types::ActivitySucceededEventDetails]
673
+ #
674
+ # @!attribute [rw] activity_timed_out_event_details
675
+ # @return [Types::ActivityTimedOutEventDetails]
676
+ #
677
+ # @!attribute [rw] execution_failed_event_details
678
+ # @return [Types::ExecutionFailedEventDetails]
679
+ #
680
+ # @!attribute [rw] execution_started_event_details
681
+ # @return [Types::ExecutionStartedEventDetails]
682
+ #
683
+ # @!attribute [rw] execution_succeeded_event_details
684
+ # @return [Types::ExecutionSucceededEventDetails]
685
+ #
686
+ # @!attribute [rw] execution_aborted_event_details
687
+ # @return [Types::ExecutionAbortedEventDetails]
688
+ #
689
+ # @!attribute [rw] execution_timed_out_event_details
690
+ # @return [Types::ExecutionTimedOutEventDetails]
691
+ #
692
+ # @!attribute [rw] lambda_function_failed_event_details
693
+ # @return [Types::LambdaFunctionFailedEventDetails]
694
+ #
695
+ # @!attribute [rw] lambda_function_schedule_failed_event_details
696
+ # @return [Types::LambdaFunctionScheduleFailedEventDetails]
697
+ #
698
+ # @!attribute [rw] lambda_function_scheduled_event_details
699
+ # @return [Types::LambdaFunctionScheduledEventDetails]
700
+ #
701
+ # @!attribute [rw] lambda_function_start_failed_event_details
702
+ # @return [Types::LambdaFunctionStartFailedEventDetails]
703
+ #
704
+ # @!attribute [rw] lambda_function_succeeded_event_details
705
+ # @return [Types::LambdaFunctionSucceededEventDetails]
706
+ #
707
+ # @!attribute [rw] lambda_function_timed_out_event_details
708
+ # @return [Types::LambdaFunctionTimedOutEventDetails]
709
+ #
710
+ # @!attribute [rw] state_entered_event_details
711
+ # @return [Types::StateEnteredEventDetails]
712
+ #
713
+ # @!attribute [rw] state_exited_event_details
714
+ # @return [Types::StateExitedEventDetails]
715
+ #
716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/HistoryEvent AWS API Documentation
717
+ #
718
+ class HistoryEvent < Struct.new(
719
+ :timestamp,
720
+ :type,
721
+ :id,
722
+ :previous_event_id,
723
+ :activity_failed_event_details,
724
+ :activity_schedule_failed_event_details,
725
+ :activity_scheduled_event_details,
726
+ :activity_started_event_details,
727
+ :activity_succeeded_event_details,
728
+ :activity_timed_out_event_details,
729
+ :execution_failed_event_details,
730
+ :execution_started_event_details,
731
+ :execution_succeeded_event_details,
732
+ :execution_aborted_event_details,
733
+ :execution_timed_out_event_details,
734
+ :lambda_function_failed_event_details,
735
+ :lambda_function_schedule_failed_event_details,
736
+ :lambda_function_scheduled_event_details,
737
+ :lambda_function_start_failed_event_details,
738
+ :lambda_function_succeeded_event_details,
739
+ :lambda_function_timed_out_event_details,
740
+ :state_entered_event_details,
741
+ :state_exited_event_details)
742
+ include Aws::Structure
743
+ end
744
+
745
+ # @!attribute [rw] error
746
+ # The error code of the failure.
747
+ # @return [String]
748
+ #
749
+ # @!attribute [rw] cause
750
+ # A more detailed explanation of the cause of the failure.
751
+ # @return [String]
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionFailedEventDetails AWS API Documentation
754
+ #
755
+ class LambdaFunctionFailedEventDetails < Struct.new(
756
+ :error,
757
+ :cause)
758
+ include Aws::Structure
759
+ end
760
+
761
+ # @!attribute [rw] error
762
+ # The error code of the failure.
763
+ # @return [String]
764
+ #
765
+ # @!attribute [rw] cause
766
+ # A more detailed explanation of the cause of the failure.
767
+ # @return [String]
768
+ #
769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionScheduleFailedEventDetails AWS API Documentation
770
+ #
771
+ class LambdaFunctionScheduleFailedEventDetails < Struct.new(
772
+ :error,
773
+ :cause)
774
+ include Aws::Structure
775
+ end
776
+
777
+ # @!attribute [rw] resource
778
+ # The Amazon Resource Name (ARN) of the scheduled lambda function.
779
+ # @return [String]
780
+ #
781
+ # @!attribute [rw] input
782
+ # The JSON data input to the lambda function.
783
+ # @return [String]
784
+ #
785
+ # @!attribute [rw] timeout_in_seconds
786
+ # The maximum allowed duration of the lambda function.
787
+ # @return [Integer]
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionScheduledEventDetails AWS API Documentation
790
+ #
791
+ class LambdaFunctionScheduledEventDetails < Struct.new(
792
+ :resource,
793
+ :input,
794
+ :timeout_in_seconds)
795
+ include Aws::Structure
796
+ end
797
+
798
+ # @!attribute [rw] error
799
+ # The error code of the failure.
800
+ # @return [String]
801
+ #
802
+ # @!attribute [rw] cause
803
+ # A more detailed explanation of the cause of the failure.
804
+ # @return [String]
805
+ #
806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionStartFailedEventDetails AWS API Documentation
807
+ #
808
+ class LambdaFunctionStartFailedEventDetails < Struct.new(
809
+ :error,
810
+ :cause)
811
+ include Aws::Structure
812
+ end
813
+
814
+ # @!attribute [rw] output
815
+ # The JSON data output by the lambda function.
816
+ # @return [String]
817
+ #
818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionSucceededEventDetails AWS API Documentation
819
+ #
820
+ class LambdaFunctionSucceededEventDetails < Struct.new(
821
+ :output)
822
+ include Aws::Structure
823
+ end
824
+
825
+ # @!attribute [rw] error
826
+ # The error code of the failure.
827
+ # @return [String]
828
+ #
829
+ # @!attribute [rw] cause
830
+ # A more detailed explanation of the cause of the timeout.
831
+ # @return [String]
832
+ #
833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionTimedOutEventDetails AWS API Documentation
834
+ #
835
+ class LambdaFunctionTimedOutEventDetails < Struct.new(
836
+ :error,
837
+ :cause)
838
+ include Aws::Structure
839
+ end
840
+
841
+ # @note When making an API call, you may pass ListActivitiesInput
842
+ # data as a hash:
843
+ #
844
+ # {
845
+ # max_results: 1,
846
+ # next_token: "PageToken",
847
+ # }
848
+ #
849
+ # @!attribute [rw] max_results
850
+ # The maximum number of results that will be returned per call.
851
+ # `nextToken` can be used to obtain further pages of results. The
852
+ # default is 100 and the maximum allowed page size is 1000.
853
+ #
854
+ # This is an upper limit only; the actual number of results returned
855
+ # per call may be fewer than the specified maximum.
856
+ # @return [Integer]
857
+ #
858
+ # @!attribute [rw] next_token
859
+ # If a `nextToken` was returned by a previous call, there are more
860
+ # results available. To retrieve the next page of results, make the
861
+ # call again using the returned token in `nextToken`. Keep all other
862
+ # arguments unchanged.
863
+ #
864
+ # The configured `maxResults` determines how many results can be
865
+ # returned in a single call.
866
+ # @return [String]
867
+ #
868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivitiesInput AWS API Documentation
869
+ #
870
+ class ListActivitiesInput < Struct.new(
871
+ :max_results,
872
+ :next_token)
873
+ include Aws::Structure
874
+ end
875
+
876
+ # @!attribute [rw] activities
877
+ # The list of activities.
878
+ # @return [Array<Types::ActivityListItem>]
879
+ #
880
+ # @!attribute [rw] next_token
881
+ # If a `nextToken` is returned, there are more results available. To
882
+ # retrieve the next page of results, make the call again using the
883
+ # returned token in `nextToken`. Keep all other arguments unchanged.
884
+ #
885
+ # The configured `maxResults` determines how many results can be
886
+ # returned in a single call.
887
+ # @return [String]
888
+ #
889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivitiesOutput AWS API Documentation
890
+ #
891
+ class ListActivitiesOutput < Struct.new(
892
+ :activities,
893
+ :next_token)
894
+ include Aws::Structure
895
+ end
896
+
897
+ # @note When making an API call, you may pass ListExecutionsInput
898
+ # data as a hash:
899
+ #
900
+ # {
901
+ # state_machine_arn: "Arn", # required
902
+ # status_filter: "RUNNING", # accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED
903
+ # max_results: 1,
904
+ # next_token: "PageToken",
905
+ # }
906
+ #
907
+ # @!attribute [rw] state_machine_arn
908
+ # The Amazon Resource Name (ARN) of the state machine whose executions
909
+ # will be listed.
910
+ # @return [String]
911
+ #
912
+ # @!attribute [rw] status_filter
913
+ # If specified, only list the executions whose current execution
914
+ # status matches the given filter.
915
+ # @return [String]
916
+ #
917
+ # @!attribute [rw] max_results
918
+ # The maximum number of results that will be returned per call.
919
+ # `nextToken` can be used to obtain further pages of results. The
920
+ # default is 100 and the maximum allowed page size is 1000.
921
+ #
922
+ # This is an upper limit only; the actual number of results returned
923
+ # per call may be fewer than the specified maximum.
924
+ # @return [Integer]
925
+ #
926
+ # @!attribute [rw] next_token
927
+ # If a `nextToken` was returned by a previous call, there are more
928
+ # results available. To retrieve the next page of results, make the
929
+ # call again using the returned token in `nextToken`. Keep all other
930
+ # arguments unchanged.
931
+ #
932
+ # The configured `maxResults` determines how many results can be
933
+ # returned in a single call.
934
+ # @return [String]
935
+ #
936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutionsInput AWS API Documentation
937
+ #
938
+ class ListExecutionsInput < Struct.new(
939
+ :state_machine_arn,
940
+ :status_filter,
941
+ :max_results,
942
+ :next_token)
943
+ include Aws::Structure
944
+ end
945
+
946
+ # @!attribute [rw] executions
947
+ # The list of matching executions.
948
+ # @return [Array<Types::ExecutionListItem>]
949
+ #
950
+ # @!attribute [rw] next_token
951
+ # If a `nextToken` is returned, there are more results available. To
952
+ # retrieve the next page of results, make the call again using the
953
+ # returned token in `nextToken`. Keep all other arguments unchanged.
954
+ #
955
+ # The configured `maxResults` determines how many results can be
956
+ # returned in a single call.
957
+ # @return [String]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutionsOutput AWS API Documentation
960
+ #
961
+ class ListExecutionsOutput < Struct.new(
962
+ :executions,
963
+ :next_token)
964
+ include Aws::Structure
965
+ end
966
+
967
+ # @note When making an API call, you may pass ListStateMachinesInput
968
+ # data as a hash:
969
+ #
970
+ # {
971
+ # max_results: 1,
972
+ # next_token: "PageToken",
973
+ # }
974
+ #
975
+ # @!attribute [rw] max_results
976
+ # The maximum number of results that will be returned per call.
977
+ # `nextToken` can be used to obtain further pages of results. The
978
+ # default is 100 and the maximum allowed page size is 1000.
979
+ #
980
+ # This is an upper limit only; the actual number of results returned
981
+ # per call may be fewer than the specified maximum.
982
+ # @return [Integer]
983
+ #
984
+ # @!attribute [rw] next_token
985
+ # If a `nextToken` was returned by a previous call, there are more
986
+ # results available. To retrieve the next page of results, make the
987
+ # call again using the returned token in `nextToken`. Keep all other
988
+ # arguments unchanged.
989
+ #
990
+ # The configured `maxResults` determines how many results can be
991
+ # returned in a single call.
992
+ # @return [String]
993
+ #
994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachinesInput AWS API Documentation
995
+ #
996
+ class ListStateMachinesInput < Struct.new(
997
+ :max_results,
998
+ :next_token)
999
+ include Aws::Structure
1000
+ end
1001
+
1002
+ # @!attribute [rw] state_machines
1003
+ # @return [Array<Types::StateMachineListItem>]
1004
+ #
1005
+ # @!attribute [rw] next_token
1006
+ # If a `nextToken` is returned, there are more results available. To
1007
+ # retrieve the next page of results, make the call again using the
1008
+ # returned token in `nextToken`. Keep all other arguments unchanged.
1009
+ #
1010
+ # The configured `maxResults` determines how many results can be
1011
+ # returned in a single call.
1012
+ # @return [String]
1013
+ #
1014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachinesOutput AWS API Documentation
1015
+ #
1016
+ class ListStateMachinesOutput < Struct.new(
1017
+ :state_machines,
1018
+ :next_token)
1019
+ include Aws::Structure
1020
+ end
1021
+
1022
+ # @note When making an API call, you may pass SendTaskFailureInput
1023
+ # data as a hash:
1024
+ #
1025
+ # {
1026
+ # task_token: "TaskToken", # required
1027
+ # error: "Error",
1028
+ # cause: "Cause",
1029
+ # }
1030
+ #
1031
+ # @!attribute [rw] task_token
1032
+ # The token that represents this task. Task tokens are generated by
1033
+ # the service when the tasks are assigned to a worker (see
1034
+ # GetActivityTask::taskToken).
1035
+ # @return [String]
1036
+ #
1037
+ # @!attribute [rw] error
1038
+ # An arbitrary error code that identifies the cause of the failure.
1039
+ # @return [String]
1040
+ #
1041
+ # @!attribute [rw] cause
1042
+ # A more detailed explanation of the cause of the failure.
1043
+ # @return [String]
1044
+ #
1045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailureInput AWS API Documentation
1046
+ #
1047
+ class SendTaskFailureInput < Struct.new(
1048
+ :task_token,
1049
+ :error,
1050
+ :cause)
1051
+ include Aws::Structure
1052
+ end
1053
+
1054
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailureOutput AWS API Documentation
1055
+ #
1056
+ class SendTaskFailureOutput < Aws::EmptyStructure; end
1057
+
1058
+ # @note When making an API call, you may pass SendTaskHeartbeatInput
1059
+ # data as a hash:
1060
+ #
1061
+ # {
1062
+ # task_token: "TaskToken", # required
1063
+ # }
1064
+ #
1065
+ # @!attribute [rw] task_token
1066
+ # The token that represents this task. Task tokens are generated by
1067
+ # the service when the tasks are assigned to a worker (see
1068
+ # GetActivityTask::taskToken).
1069
+ # @return [String]
1070
+ #
1071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeatInput AWS API Documentation
1072
+ #
1073
+ class SendTaskHeartbeatInput < Struct.new(
1074
+ :task_token)
1075
+ include Aws::Structure
1076
+ end
1077
+
1078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeatOutput AWS API Documentation
1079
+ #
1080
+ class SendTaskHeartbeatOutput < Aws::EmptyStructure; end
1081
+
1082
+ # @note When making an API call, you may pass SendTaskSuccessInput
1083
+ # data as a hash:
1084
+ #
1085
+ # {
1086
+ # task_token: "TaskToken", # required
1087
+ # output: "Data", # required
1088
+ # }
1089
+ #
1090
+ # @!attribute [rw] task_token
1091
+ # The token that represents this task. Task tokens are generated by
1092
+ # the service when the tasks are assigned to a worker (see
1093
+ # GetActivityTask::taskToken).
1094
+ # @return [String]
1095
+ #
1096
+ # @!attribute [rw] output
1097
+ # The JSON output of the task.
1098
+ # @return [String]
1099
+ #
1100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccessInput AWS API Documentation
1101
+ #
1102
+ class SendTaskSuccessInput < Struct.new(
1103
+ :task_token,
1104
+ :output)
1105
+ include Aws::Structure
1106
+ end
1107
+
1108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccessOutput AWS API Documentation
1109
+ #
1110
+ class SendTaskSuccessOutput < Aws::EmptyStructure; end
1111
+
1112
+ # @note When making an API call, you may pass StartExecutionInput
1113
+ # data as a hash:
1114
+ #
1115
+ # {
1116
+ # state_machine_arn: "Arn", # required
1117
+ # name: "Name",
1118
+ # input: "Data",
1119
+ # }
1120
+ #
1121
+ # @!attribute [rw] state_machine_arn
1122
+ # The Amazon Resource Name (ARN) of the state machine to execute.
1123
+ # @return [String]
1124
+ #
1125
+ # @!attribute [rw] name
1126
+ # The name of the execution. This name must be unique for your AWS
1127
+ # account and region.
1128
+ # @return [String]
1129
+ #
1130
+ # @!attribute [rw] input
1131
+ # The JSON input data for the execution.
1132
+ # @return [String]
1133
+ #
1134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionInput AWS API Documentation
1135
+ #
1136
+ class StartExecutionInput < Struct.new(
1137
+ :state_machine_arn,
1138
+ :name,
1139
+ :input)
1140
+ include Aws::Structure
1141
+ end
1142
+
1143
+ # @!attribute [rw] execution_arn
1144
+ # The Amazon Resource Name (ARN) that identifies the execution.
1145
+ # @return [String]
1146
+ #
1147
+ # @!attribute [rw] start_date
1148
+ # The date the execution was started.
1149
+ # @return [Time]
1150
+ #
1151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionOutput AWS API Documentation
1152
+ #
1153
+ class StartExecutionOutput < Struct.new(
1154
+ :execution_arn,
1155
+ :start_date)
1156
+ include Aws::Structure
1157
+ end
1158
+
1159
+ # @!attribute [rw] name
1160
+ # The name of the state.
1161
+ # @return [String]
1162
+ #
1163
+ # @!attribute [rw] input
1164
+ # The JSON input data to the state.
1165
+ # @return [String]
1166
+ #
1167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateEnteredEventDetails AWS API Documentation
1168
+ #
1169
+ class StateEnteredEventDetails < Struct.new(
1170
+ :name,
1171
+ :input)
1172
+ include Aws::Structure
1173
+ end
1174
+
1175
+ # @!attribute [rw] name
1176
+ # The name of the state.
1177
+ # @return [String]
1178
+ #
1179
+ # @!attribute [rw] output
1180
+ # The JSON output data of the state.
1181
+ # @return [String]
1182
+ #
1183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateExitedEventDetails AWS API Documentation
1184
+ #
1185
+ class StateExitedEventDetails < Struct.new(
1186
+ :name,
1187
+ :output)
1188
+ include Aws::Structure
1189
+ end
1190
+
1191
+ # @!attribute [rw] state_machine_arn
1192
+ # The Amazon Resource Name (ARN) that identifies the state machine.
1193
+ # @return [String]
1194
+ #
1195
+ # @!attribute [rw] name
1196
+ # The name of the state machine.
1197
+ # @return [String]
1198
+ #
1199
+ # @!attribute [rw] creation_date
1200
+ # The date the state machine was created.
1201
+ # @return [Time]
1202
+ #
1203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateMachineListItem AWS API Documentation
1204
+ #
1205
+ class StateMachineListItem < Struct.new(
1206
+ :state_machine_arn,
1207
+ :name,
1208
+ :creation_date)
1209
+ include Aws::Structure
1210
+ end
1211
+
1212
+ # @note When making an API call, you may pass StopExecutionInput
1213
+ # data as a hash:
1214
+ #
1215
+ # {
1216
+ # execution_arn: "Arn", # required
1217
+ # error: "Error",
1218
+ # cause: "Cause",
1219
+ # }
1220
+ #
1221
+ # @!attribute [rw] execution_arn
1222
+ # The Amazon Resource Name (ARN) of the execution to stop.
1223
+ # @return [String]
1224
+ #
1225
+ # @!attribute [rw] error
1226
+ # An arbitrary error code that identifies the cause of the
1227
+ # termination.
1228
+ # @return [String]
1229
+ #
1230
+ # @!attribute [rw] cause
1231
+ # A more detailed explanation of the cause of the termination.
1232
+ # @return [String]
1233
+ #
1234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecutionInput AWS API Documentation
1235
+ #
1236
+ class StopExecutionInput < Struct.new(
1237
+ :execution_arn,
1238
+ :error,
1239
+ :cause)
1240
+ include Aws::Structure
1241
+ end
1242
+
1243
+ # @!attribute [rw] stop_date
1244
+ # The date the execution was stopped.
1245
+ # @return [Time]
1246
+ #
1247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecutionOutput AWS API Documentation
1248
+ #
1249
+ class StopExecutionOutput < Struct.new(
1250
+ :stop_date)
1251
+ include Aws::Structure
1252
+ end
1253
+
1254
+ end
1255
+ end