aws-sdk-states 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 501aee639c8d04fe943418336ee17458b60566e1
4
- data.tar.gz: 7afd4a8280f07dd3d490e878e713bca911098b24
3
+ metadata.gz: ff461c7df3b7ef42cb055a5d1c10943503a1e557
4
+ data.tar.gz: 746d2ce2cbf1301e8776fc7b440ae24a620a9777
5
5
  SHA512:
6
- metadata.gz: 14853efa0f9a0da08ecd3f17fab6c134dc3b14984df5f2ac1dca625615518e4c2ecf23deabb3929085c76b755dc5260a2719412aad490f14986f3df1854802f2
7
- data.tar.gz: 1a9202cca1dc13009682fc71e2cf60c71d9fe100f276d9a5e67b6f7eb0cbe97ec83b98bbf8f38fd90e7664d8dd1f2ef57c25d00944ddb37937d5015163db7265
6
+ metadata.gz: fe63445ecd302642c9ff0cd5ee3e0a08acb6852d282afe1653c1ade9508dbdd2d5fd91e732a076033257f08edc4836115ffb132b76fcd1ff7a830896e3953381
7
+ data.tar.gz: 746a6b6e31e99dd2fad71c5a5cf3d4c7dd886c10e18d7f399e6f25e9afbc22cc88f72cc4a5a7d185fd76ca8ff5a17c8174086f222f924fd526d7e40932aff16a
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-states/customizations'
42
42
  # @service
43
43
  module Aws::States
44
44
 
45
- GEM_VERSION = '1.0.0'
45
+ GEM_VERSION = '1.1.0'
46
46
 
47
47
  end
@@ -155,11 +155,35 @@ module Aws::States
155
155
 
156
156
  # @!group API Operations
157
157
 
158
- # Creates an activity.
158
+ # Creates an activity. An Activity is a task which you write, in any
159
+ # language and hosted on any machine which has access to AWS Step
160
+ # Functions. Activities must poll Step Functions using the
161
+ # `GetActivityTask` and respond using `SendTask*` API calls. This
162
+ # function lets Step Functions know the existence of your activity and
163
+ # returns an identifier for use in a state machine and when polling from
164
+ # the activity.
159
165
  #
160
166
  # @option params [required, String] :name
161
167
  # The name of the activity to create. This name must be unique for your
162
- # AWS account and region.
168
+ # AWS account and region for 90 days. For more information, see [ Limits
169
+ # Related to State Machine Executions][1] in the *AWS Step Functions
170
+ # Developer Guide*.
171
+ #
172
+ # A name must *not* contain:
173
+ #
174
+ # * whitespace
175
+ #
176
+ # * brackets `< > \{ \} [ ]`
177
+ #
178
+ # * wildcard characters `? *`
179
+ #
180
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
181
+ #
182
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
183
+ #
184
+ #
185
+ #
186
+ # [1]: http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
163
187
  #
164
188
  # @return [Types::CreateActivityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
165
189
  #
@@ -186,11 +210,33 @@ module Aws::States
186
210
  req.send_request(options)
187
211
  end
188
212
 
189
- # Creates a state machine.
213
+ # Creates a state machine. A state machine consists of a collection of
214
+ # states that can do work (`Task` states), determine which states to
215
+ # transition to next (`Choice` states), stop an execution with an error
216
+ # (`Fail` states), and so on. State machines are specified using a
217
+ # JSON-based, structured language.
190
218
  #
191
219
  # @option params [required, String] :name
192
220
  # The name of the state machine. This name must be unique for your AWS
193
- # account and region.
221
+ # account and region for 90 days. For more information, see [ Limits
222
+ # Related to State Machine Executions][1] in the *AWS Step Functions
223
+ # Developer Guide*.
224
+ #
225
+ # A name must *not* contain:
226
+ #
227
+ # * whitespace
228
+ #
229
+ # * brackets `< > \{ \} [ ]`
230
+ #
231
+ # * wildcard characters `? *`
232
+ #
233
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
234
+ #
235
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
236
+ #
237
+ #
238
+ #
239
+ # [1]: http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
194
240
  #
195
241
  # @option params [required, String] :definition
196
242
  # The Amazon States Language definition of the state machine.
@@ -250,7 +296,9 @@ module Aws::States
250
296
 
251
297
  # Deletes a state machine. This is an asynchronous operation-- it sets
252
298
  # the state machine's status to "DELETING" and begins the delete
253
- # process.
299
+ # process. Each state machine execution will be deleted the next time it
300
+ # makes a state transition. After all executions have completed or been
301
+ # deleted, the state machine itself will be deleted.
254
302
  #
255
303
  # @option params [required, String] :state_machine_arn
256
304
  # The Amazon Resource Name (ARN) of the state machine to delete.
@@ -385,23 +433,24 @@ module Aws::States
385
433
  end
386
434
 
387
435
  # Used by workers to retrieve a task (with the specified activity ARN)
388
- # scheduled for execution by a running state machine. This initiates a
389
- # long poll, where the service holds the HTTP connection open and
390
- # responds as soon as a task becomes available (i.e. an execution of a
391
- # task of this type is needed.) The maximum time the service holds on to
392
- # the request before responding is 60 seconds. If no task is available
393
- # within 60 seconds, the poll will return an empty result, that is, the
394
- # `taskToken` returned is an empty string.
436
+ # which has been scheduled for execution by a running state machine.
437
+ # This initiates a long poll, where the service holds the HTTP
438
+ # connection open and responds as soon as a task becomes available (i.e.
439
+ # an execution of a task of this type is needed.) The maximum time the
440
+ # service holds on to the request before responding is 60 seconds. If no
441
+ # task is available within 60 seconds, the poll will return a
442
+ # `taskToken` with a null string.
395
443
  #
396
444
  # Workers should set their client side socket timeout to at least 65
397
445
  # seconds (5 seconds higher than the maximum time the service may hold
398
446
  # the poll request).
399
447
  #
400
448
  # @option params [required, String] :activity_arn
401
- # The Amazon Resource Name (ARN) of the activity to retrieve tasks from.
449
+ # The Amazon Resource Name (ARN) of the activity to retrieve tasks from
450
+ # (assigned when you create the task using CreateActivity.)
402
451
  #
403
452
  # @option params [String] :worker_name
404
- # An arbitrary name may be provided in order to identify the worker that
453
+ # You can provide an arbitrary name in order to identify the worker that
405
454
  # the task is assigned to. This name will be used when it is logged in
406
455
  # the execution history.
407
456
  #
@@ -444,7 +493,8 @@ module Aws::States
444
493
  # @option params [Integer] :max_results
445
494
  # The maximum number of results that will be returned per call.
446
495
  # `nextToken` can be used to obtain further pages of results. The
447
- # default is 100 and the maximum allowed page size is 1000.
496
+ # default is 100 and the maximum allowed page size is 100. A value of 0
497
+ # means to use the default.
448
498
  #
449
499
  # This is an upper limit only; the actual number of results returned per
450
500
  # call may be fewer than the specified maximum.
@@ -479,7 +529,7 @@ module Aws::States
479
529
  #
480
530
  # resp.events #=> Array
481
531
  # resp.events[0].timestamp #=> Time
482
- # 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"
532
+ # 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", "TaskStateAborted", "TaskStateEntered", "TaskStateExited", "PassStateEntered", "PassStateExited", "ParallelStateAborted", "ParallelStateEntered", "ParallelStateExited", "ParallelStateFailed", "ParallelStateStarted", "ParallelStateSucceeded", "WaitStateAborted", "WaitStateEntered", "WaitStateExited"
483
533
  # resp.events[0].id #=> Integer
484
534
  # resp.events[0].previous_event_id #=> Integer
485
535
  # resp.events[0].activity_failed_event_details.error #=> String
@@ -537,7 +587,8 @@ module Aws::States
537
587
  # @option params [Integer] :max_results
538
588
  # The maximum number of results that will be returned per call.
539
589
  # `nextToken` can be used to obtain further pages of results. The
540
- # default is 100 and the maximum allowed page size is 1000.
590
+ # default is 100 and the maximum allowed page size is 100. A value of 0
591
+ # means to use the default.
541
592
  #
542
593
  # This is an upper limit only; the actual number of results returned per
543
594
  # call may be fewer than the specified maximum.
@@ -596,7 +647,8 @@ module Aws::States
596
647
  # @option params [Integer] :max_results
597
648
  # The maximum number of results that will be returned per call.
598
649
  # `nextToken` can be used to obtain further pages of results. The
599
- # default is 100 and the maximum allowed page size is 1000.
650
+ # default is 100 and the maximum allowed page size is 100. A value of 0
651
+ # means to use the default.
600
652
  #
601
653
  # This is an upper limit only; the actual number of results returned per
602
654
  # call may be fewer than the specified maximum.
@@ -651,7 +703,8 @@ module Aws::States
651
703
  # @option params [Integer] :max_results
652
704
  # The maximum number of results that will be returned per call.
653
705
  # `nextToken` can be used to obtain further pages of results. The
654
- # default is 100 and the maximum allowed page size is 1000.
706
+ # default is 100 and the maximum allowed page size is 100. A value of 0
707
+ # means to use the default.
655
708
  #
656
709
  # This is an upper limit only; the actual number of results returned per
657
710
  # call may be fewer than the specified maximum.
@@ -804,10 +857,36 @@ module Aws::States
804
857
  #
805
858
  # @option params [String] :name
806
859
  # The name of the execution. This name must be unique for your AWS
807
- # account and region.
860
+ # account and region for 90 days. For more information, see [ Limits
861
+ # Related to State Machine Executions][1] in the *AWS Step Functions
862
+ # Developer Guide*.
863
+ #
864
+ # A name must *not* contain:
865
+ #
866
+ # * whitespace
867
+ #
868
+ # * brackets `< > \{ \} [ ]`
869
+ #
870
+ # * wildcard characters `? *`
871
+ #
872
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
873
+ #
874
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
875
+ #
876
+ #
877
+ #
878
+ # [1]: http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
808
879
  #
809
880
  # @option params [String] :input
810
- # The JSON input data for the execution.
881
+ # The string that contains the JSON input data for the execution, for
882
+ # example:
883
+ #
884
+ # `"input": "\{"first_name" : "test"\}"`
885
+ #
886
+ # <note markdown="1"> If you don't include any JSON input data, you still must include the
887
+ # two braces, for example: `"input": "\{\}"`
888
+ #
889
+ # </note>
811
890
  #
812
891
  # @return [Types::StartExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
813
892
  #
@@ -885,7 +964,7 @@ module Aws::States
885
964
  params: params,
886
965
  config: config)
887
966
  context[:gem_name] = 'aws-sdk-states'
888
- context[:gem_version] = '1.0.0'
967
+ context[:gem_version] = '1.1.0'
889
968
  Seahorse::Client::Request.new(handlers, context)
890
969
  end
891
970
 
@@ -8,6 +8,8 @@
8
8
  module Aws::States
9
9
  module Types
10
10
 
11
+ # Contains details about an activity which failed during an execution.
12
+ #
11
13
  # @!attribute [rw] error
12
14
  # The error code of the failure.
13
15
  # @return [String]
@@ -24,12 +26,26 @@ module Aws::States
24
26
  include Aws::Structure
25
27
  end
26
28
 
29
+ # Contains details about an activity.
30
+ #
27
31
  # @!attribute [rw] activity_arn
28
32
  # The Amazon Resource Name (ARN) that identifies the activity.
29
33
  # @return [String]
30
34
  #
31
35
  # @!attribute [rw] name
32
36
  # The name of the activity.
37
+ #
38
+ # A name must *not* contain:
39
+ #
40
+ # * whitespace
41
+ #
42
+ # * brackets `< > \{ \} [ ]`
43
+ #
44
+ # * wildcard characters `? *`
45
+ #
46
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
47
+ #
48
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
33
49
  # @return [String]
34
50
  #
35
51
  # @!attribute [rw] creation_date
@@ -45,6 +61,9 @@ module Aws::States
45
61
  include Aws::Structure
46
62
  end
47
63
 
64
+ # Contains details about an activity schedule failure which occurred
65
+ # during an execution.
66
+ #
48
67
  # @!attribute [rw] error
49
68
  # The error code of the failure.
50
69
  # @return [String]
@@ -61,6 +80,8 @@ module Aws::States
61
80
  include Aws::Structure
62
81
  end
63
82
 
83
+ # Contains details about an activity scheduled during an execution.
84
+ #
64
85
  # @!attribute [rw] resource
65
86
  # The Amazon Resource Name (ARN) of the scheduled activity.
66
87
  # @return [String]
@@ -88,6 +109,8 @@ module Aws::States
88
109
  include Aws::Structure
89
110
  end
90
111
 
112
+ # Contains details about the start of an activity during an execution.
113
+ #
91
114
  # @!attribute [rw] worker_name
92
115
  # The name of the worker that the task was assigned to. These names
93
116
  # are provided by the workers when calling GetActivityTask.
@@ -100,6 +123,9 @@ module Aws::States
100
123
  include Aws::Structure
101
124
  end
102
125
 
126
+ # Contains details about an activity which successfully terminated
127
+ # during an execution.
128
+ #
103
129
  # @!attribute [rw] output
104
130
  # The JSON data output by the activity task.
105
131
  # @return [String]
@@ -111,6 +137,9 @@ module Aws::States
111
137
  include Aws::Structure
112
138
  end
113
139
 
140
+ # Contains details about an activity timeout which occurred during an
141
+ # execution.
142
+ #
114
143
  # @!attribute [rw] error
115
144
  # The error code of the failure.
116
145
  # @return [String]
@@ -136,7 +165,25 @@ module Aws::States
136
165
  #
137
166
  # @!attribute [rw] name
138
167
  # The name of the activity to create. This name must be unique for
139
- # your AWS account and region.
168
+ # your AWS account and region for 90 days. For more information, see [
169
+ # Limits Related to State Machine Executions][1] in the *AWS Step
170
+ # Functions Developer Guide*.
171
+ #
172
+ # A name must *not* contain:
173
+ #
174
+ # * whitespace
175
+ #
176
+ # * brackets `< > \{ \} [ ]`
177
+ #
178
+ # * wildcard characters `? *`
179
+ #
180
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
181
+ #
182
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
183
+ #
184
+ #
185
+ #
186
+ # [1]: http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
140
187
  # @return [String]
141
188
  #
142
189
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivityInput AWS API Documentation
@@ -173,7 +220,25 @@ module Aws::States
173
220
  #
174
221
  # @!attribute [rw] name
175
222
  # The name of the state machine. This name must be unique for your AWS
176
- # account and region.
223
+ # account and region for 90 days. For more information, see [ Limits
224
+ # Related to State Machine Executions][1] in the *AWS Step Functions
225
+ # Developer Guide*.
226
+ #
227
+ # A name must *not* contain:
228
+ #
229
+ # * whitespace
230
+ #
231
+ # * brackets `< > \{ \} [ ]`
232
+ #
233
+ # * wildcard characters `? *`
234
+ #
235
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
236
+ #
237
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
238
+ #
239
+ #
240
+ #
241
+ # [1]: http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
177
242
  # @return [String]
178
243
  #
179
244
  # @!attribute [rw] definition
@@ -279,6 +344,18 @@ module Aws::States
279
344
  #
280
345
  # @!attribute [rw] name
281
346
  # The name of the activity.
347
+ #
348
+ # A name must *not* contain:
349
+ #
350
+ # * whitespace
351
+ #
352
+ # * brackets `< > \{ \} [ ]`
353
+ #
354
+ # * wildcard characters `? *`
355
+ #
356
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
357
+ #
358
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
282
359
  # @return [String]
283
360
  #
284
361
  # @!attribute [rw] creation_date
@@ -322,6 +399,18 @@ module Aws::States
322
399
  #
323
400
  # @!attribute [rw] name
324
401
  # The name of the execution.
402
+ #
403
+ # A name must *not* contain:
404
+ #
405
+ # * whitespace
406
+ #
407
+ # * brackets `< > \{ \} [ ]`
408
+ #
409
+ # * wildcard characters `? *`
410
+ #
411
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
412
+ #
413
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
325
414
  # @return [String]
326
415
  #
327
416
  # @!attribute [rw] status
@@ -337,7 +426,7 @@ module Aws::States
337
426
  # @return [Time]
338
427
  #
339
428
  # @!attribute [rw] input
340
- # The JSON input data of the execution.
429
+ # The string that contains the JSON input data of the execution.
341
430
  # @return [String]
342
431
  #
343
432
  # @!attribute [rw] output
@@ -382,6 +471,18 @@ module Aws::States
382
471
  #
383
472
  # @!attribute [rw] name
384
473
  # The name of the state machine.
474
+ #
475
+ # A name must *not* contain:
476
+ #
477
+ # * whitespace
478
+ #
479
+ # * brackets `< > \{ \} [ ]`
480
+ #
481
+ # * wildcard characters `? *`
482
+ #
483
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
484
+ #
485
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
385
486
  # @return [String]
386
487
  #
387
488
  # @!attribute [rw] status
@@ -393,8 +494,9 @@ module Aws::States
393
494
  # @return [String]
394
495
  #
395
496
  # @!attribute [rw] role_arn
396
- # The Amazon Resource Name (ARN) of the IAM role used for executing
397
- # this state machine.
497
+ # The Amazon Resource Name (ARN) of the IAM role used when creating
498
+ # this state machine. (The IAM role maintains security by granting
499
+ # Step Functions access to AWS resources.)
398
500
  # @return [String]
399
501
  #
400
502
  # @!attribute [rw] creation_date
@@ -413,6 +515,8 @@ module Aws::States
413
515
  include Aws::Structure
414
516
  end
415
517
 
518
+ # Contains details about an abort of an execution.
519
+ #
416
520
  # @!attribute [rw] error
417
521
  # The error code of the failure.
418
522
  # @return [String]
@@ -429,6 +533,8 @@ module Aws::States
429
533
  include Aws::Structure
430
534
  end
431
535
 
536
+ # Contains details about an execution failure event.
537
+ #
432
538
  # @!attribute [rw] error
433
539
  # The error code of the failure.
434
540
  # @return [String]
@@ -445,6 +551,8 @@ module Aws::States
445
551
  include Aws::Structure
446
552
  end
447
553
 
554
+ # Contains details about an execution.
555
+ #
448
556
  # @!attribute [rw] execution_arn
449
557
  # The Amazon Resource Name (ARN) that identifies the execution.
450
558
  # @return [String]
@@ -455,6 +563,18 @@ module Aws::States
455
563
  #
456
564
  # @!attribute [rw] name
457
565
  # The name of the execution.
566
+ #
567
+ # A name must *not* contain:
568
+ #
569
+ # * whitespace
570
+ #
571
+ # * brackets `< > \{ \} [ ]`
572
+ #
573
+ # * wildcard characters `? *`
574
+ #
575
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
576
+ #
577
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
458
578
  # @return [String]
459
579
  #
460
580
  # @!attribute [rw] status
@@ -481,6 +601,8 @@ module Aws::States
481
601
  include Aws::Structure
482
602
  end
483
603
 
604
+ # Contains details about the start of the execution.
605
+ #
484
606
  # @!attribute [rw] input
485
607
  # The JSON data input to the execution.
486
608
  # @return [String]
@@ -498,6 +620,8 @@ module Aws::States
498
620
  include Aws::Structure
499
621
  end
500
622
 
623
+ # Contains details about the successful termination of the execution.
624
+ #
501
625
  # @!attribute [rw] output
502
626
  # The JSON data output by the execution.
503
627
  # @return [String]
@@ -509,6 +633,9 @@ module Aws::States
509
633
  include Aws::Structure
510
634
  end
511
635
 
636
+ # Contains details about the execution timeout which occurred during the
637
+ # execution.
638
+ #
512
639
  # @!attribute [rw] error
513
640
  # The error code of the failure.
514
641
  # @return [String]
@@ -535,11 +662,11 @@ module Aws::States
535
662
  #
536
663
  # @!attribute [rw] activity_arn
537
664
  # The Amazon Resource Name (ARN) of the activity to retrieve tasks
538
- # from.
665
+ # from (assigned when you create the task using CreateActivity.)
539
666
  # @return [String]
540
667
  #
541
668
  # @!attribute [rw] worker_name
542
- # An arbitrary name may be provided in order to identify the worker
669
+ # You can provide an arbitrary name in order to identify the worker
543
670
  # that the task is assigned to. This name will be used when it is
544
671
  # logged in the execution history.
545
672
  # @return [String]
@@ -560,7 +687,7 @@ module Aws::States
560
687
  # @return [String]
561
688
  #
562
689
  # @!attribute [rw] input
563
- # The JSON input data for the task.
690
+ # The string that contains the JSON input data for the task.
564
691
  # @return [String]
565
692
  #
566
693
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTaskOutput AWS API Documentation
@@ -588,7 +715,8 @@ module Aws::States
588
715
  # @!attribute [rw] max_results
589
716
  # The maximum number of results that will be returned per call.
590
717
  # `nextToken` can be used to obtain further pages of results. The
591
- # default is 100 and the maximum allowed page size is 1000.
718
+ # default is 100 and the maximum allowed page size is 100. A value of
719
+ # 0 means to use the default.
592
720
  #
593
721
  # This is an upper limit only; the actual number of results returned
594
722
  # per call may be fewer than the specified maximum.
@@ -639,8 +767,10 @@ module Aws::States
639
767
  include Aws::Structure
640
768
  end
641
769
 
770
+ # Contains details about the events of an execution.
771
+ #
642
772
  # @!attribute [rw] timestamp
643
- # The date the event occured.
773
+ # The date the event occurred.
644
774
  # @return [Time]
645
775
  #
646
776
  # @!attribute [rw] type
@@ -657,60 +787,89 @@ module Aws::States
657
787
  # @return [Integer]
658
788
  #
659
789
  # @!attribute [rw] activity_failed_event_details
790
+ # Contains details about an activity which failed during an execution.
660
791
  # @return [Types::ActivityFailedEventDetails]
661
792
  #
662
793
  # @!attribute [rw] activity_schedule_failed_event_details
794
+ # Contains details about an activity schedule event which failed
795
+ # during an execution.
663
796
  # @return [Types::ActivityScheduleFailedEventDetails]
664
797
  #
665
798
  # @!attribute [rw] activity_scheduled_event_details
799
+ # Contains details about an activity scheduled during an execution.
666
800
  # @return [Types::ActivityScheduledEventDetails]
667
801
  #
668
802
  # @!attribute [rw] activity_started_event_details
803
+ # Contains details about the start of an activity during an execution.
669
804
  # @return [Types::ActivityStartedEventDetails]
670
805
  #
671
806
  # @!attribute [rw] activity_succeeded_event_details
807
+ # Contains details about an activity which successfully terminated
808
+ # during an execution.
672
809
  # @return [Types::ActivitySucceededEventDetails]
673
810
  #
674
811
  # @!attribute [rw] activity_timed_out_event_details
812
+ # Contains details about an activity timeout which occurred during an
813
+ # execution.
675
814
  # @return [Types::ActivityTimedOutEventDetails]
676
815
  #
677
816
  # @!attribute [rw] execution_failed_event_details
817
+ # Contains details about an execution failure event.
678
818
  # @return [Types::ExecutionFailedEventDetails]
679
819
  #
680
820
  # @!attribute [rw] execution_started_event_details
821
+ # Contains details about the start of the execution.
681
822
  # @return [Types::ExecutionStartedEventDetails]
682
823
  #
683
824
  # @!attribute [rw] execution_succeeded_event_details
825
+ # Contains details about the successful termination of the execution.
684
826
  # @return [Types::ExecutionSucceededEventDetails]
685
827
  #
686
828
  # @!attribute [rw] execution_aborted_event_details
829
+ # Contains details about an abort of an execution.
687
830
  # @return [Types::ExecutionAbortedEventDetails]
688
831
  #
689
832
  # @!attribute [rw] execution_timed_out_event_details
833
+ # Contains details about the execution timeout which occurred during
834
+ # the execution.
690
835
  # @return [Types::ExecutionTimedOutEventDetails]
691
836
  #
692
837
  # @!attribute [rw] lambda_function_failed_event_details
838
+ # Contains details about a lambda function which failed during an
839
+ # execution.
693
840
  # @return [Types::LambdaFunctionFailedEventDetails]
694
841
  #
695
842
  # @!attribute [rw] lambda_function_schedule_failed_event_details
843
+ # Contains details about a failed lambda function schedule event which
844
+ # occurred during an execution.
696
845
  # @return [Types::LambdaFunctionScheduleFailedEventDetails]
697
846
  #
698
847
  # @!attribute [rw] lambda_function_scheduled_event_details
848
+ # Contains details about a lambda function scheduled during an
849
+ # execution.
699
850
  # @return [Types::LambdaFunctionScheduledEventDetails]
700
851
  #
701
852
  # @!attribute [rw] lambda_function_start_failed_event_details
853
+ # Contains details about a lambda function which failed to start
854
+ # during an execution.
702
855
  # @return [Types::LambdaFunctionStartFailedEventDetails]
703
856
  #
704
857
  # @!attribute [rw] lambda_function_succeeded_event_details
858
+ # Contains details about a lambda function which terminated
859
+ # successfully during an execution.
705
860
  # @return [Types::LambdaFunctionSucceededEventDetails]
706
861
  #
707
862
  # @!attribute [rw] lambda_function_timed_out_event_details
863
+ # Contains details about a lambda function timeout which occurred
864
+ # during an execution.
708
865
  # @return [Types::LambdaFunctionTimedOutEventDetails]
709
866
  #
710
867
  # @!attribute [rw] state_entered_event_details
868
+ # Contains details about a state entered during an execution.
711
869
  # @return [Types::StateEnteredEventDetails]
712
870
  #
713
871
  # @!attribute [rw] state_exited_event_details
872
+ # Contains details about an exit from a state during an execution.
714
873
  # @return [Types::StateExitedEventDetails]
715
874
  #
716
875
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/HistoryEvent AWS API Documentation
@@ -742,6 +901,9 @@ module Aws::States
742
901
  include Aws::Structure
743
902
  end
744
903
 
904
+ # Contains details about a lambda function which failed during an
905
+ # execution.
906
+ #
745
907
  # @!attribute [rw] error
746
908
  # The error code of the failure.
747
909
  # @return [String]
@@ -758,6 +920,9 @@ module Aws::States
758
920
  include Aws::Structure
759
921
  end
760
922
 
923
+ # Contains details about a failed lambda function schedule event which
924
+ # occurred during an execution.
925
+ #
761
926
  # @!attribute [rw] error
762
927
  # The error code of the failure.
763
928
  # @return [String]
@@ -774,6 +939,9 @@ module Aws::States
774
939
  include Aws::Structure
775
940
  end
776
941
 
942
+ # Contains details about a lambda function scheduled during an
943
+ # execution.
944
+ #
777
945
  # @!attribute [rw] resource
778
946
  # The Amazon Resource Name (ARN) of the scheduled lambda function.
779
947
  # @return [String]
@@ -795,6 +963,9 @@ module Aws::States
795
963
  include Aws::Structure
796
964
  end
797
965
 
966
+ # Contains details about a lambda function which failed to start during
967
+ # an execution.
968
+ #
798
969
  # @!attribute [rw] error
799
970
  # The error code of the failure.
800
971
  # @return [String]
@@ -811,6 +982,9 @@ module Aws::States
811
982
  include Aws::Structure
812
983
  end
813
984
 
985
+ # Contains details about a lambda function which successfully terminated
986
+ # during an execution.
987
+ #
814
988
  # @!attribute [rw] output
815
989
  # The JSON data output by the lambda function.
816
990
  # @return [String]
@@ -822,6 +996,9 @@ module Aws::States
822
996
  include Aws::Structure
823
997
  end
824
998
 
999
+ # Contains details about a lambda function timeout which occurred during
1000
+ # an execution.
1001
+ #
825
1002
  # @!attribute [rw] error
826
1003
  # The error code of the failure.
827
1004
  # @return [String]
@@ -849,7 +1026,8 @@ module Aws::States
849
1026
  # @!attribute [rw] max_results
850
1027
  # The maximum number of results that will be returned per call.
851
1028
  # `nextToken` can be used to obtain further pages of results. The
852
- # default is 100 and the maximum allowed page size is 1000.
1029
+ # default is 100 and the maximum allowed page size is 100. A value of
1030
+ # 0 means to use the default.
853
1031
  #
854
1032
  # This is an upper limit only; the actual number of results returned
855
1033
  # per call may be fewer than the specified maximum.
@@ -917,7 +1095,8 @@ module Aws::States
917
1095
  # @!attribute [rw] max_results
918
1096
  # The maximum number of results that will be returned per call.
919
1097
  # `nextToken` can be used to obtain further pages of results. The
920
- # default is 100 and the maximum allowed page size is 1000.
1098
+ # default is 100 and the maximum allowed page size is 100. A value of
1099
+ # 0 means to use the default.
921
1100
  #
922
1101
  # This is an upper limit only; the actual number of results returned
923
1102
  # per call may be fewer than the specified maximum.
@@ -975,7 +1154,8 @@ module Aws::States
975
1154
  # @!attribute [rw] max_results
976
1155
  # The maximum number of results that will be returned per call.
977
1156
  # `nextToken` can be used to obtain further pages of results. The
978
- # default is 100 and the maximum allowed page size is 1000.
1157
+ # default is 100 and the maximum allowed page size is 100. A value of
1158
+ # 0 means to use the default.
979
1159
  #
980
1160
  # This is an upper limit only; the actual number of results returned
981
1161
  # per call may be fewer than the specified maximum.
@@ -1124,11 +1304,37 @@ module Aws::States
1124
1304
  #
1125
1305
  # @!attribute [rw] name
1126
1306
  # The name of the execution. This name must be unique for your AWS
1127
- # account and region.
1307
+ # account and region for 90 days. For more information, see [ Limits
1308
+ # Related to State Machine Executions][1] in the *AWS Step Functions
1309
+ # Developer Guide*.
1310
+ #
1311
+ # A name must *not* contain:
1312
+ #
1313
+ # * whitespace
1314
+ #
1315
+ # * brackets `< > \{ \} [ ]`
1316
+ #
1317
+ # * wildcard characters `? *`
1318
+ #
1319
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
1320
+ #
1321
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
1322
+ #
1323
+ #
1324
+ #
1325
+ # [1]: http://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
1128
1326
  # @return [String]
1129
1327
  #
1130
1328
  # @!attribute [rw] input
1131
- # The JSON input data for the execution.
1329
+ # The string that contains the JSON input data for the execution, for
1330
+ # example:
1331
+ #
1332
+ # `"input": "\{"first_name" : "test"\}"`
1333
+ #
1334
+ # <note markdown="1"> If you don't include any JSON input data, you still must include
1335
+ # the two braces, for example: `"input": "\{\}"`
1336
+ #
1337
+ # </note>
1132
1338
  # @return [String]
1133
1339
  #
1134
1340
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionInput AWS API Documentation
@@ -1156,12 +1362,14 @@ module Aws::States
1156
1362
  include Aws::Structure
1157
1363
  end
1158
1364
 
1365
+ # Contains details about a state entered during an execution.
1366
+ #
1159
1367
  # @!attribute [rw] name
1160
1368
  # The name of the state.
1161
1369
  # @return [String]
1162
1370
  #
1163
1371
  # @!attribute [rw] input
1164
- # The JSON input data to the state.
1372
+ # The string that contains the JSON input data for the state.
1165
1373
  # @return [String]
1166
1374
  #
1167
1375
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateEnteredEventDetails AWS API Documentation
@@ -1172,8 +1380,22 @@ module Aws::States
1172
1380
  include Aws::Structure
1173
1381
  end
1174
1382
 
1383
+ # Contains details about an exit from a state during an execution.
1384
+ #
1175
1385
  # @!attribute [rw] name
1176
1386
  # The name of the state.
1387
+ #
1388
+ # A name must *not* contain:
1389
+ #
1390
+ # * whitespace
1391
+ #
1392
+ # * brackets `< > \{ \} [ ]`
1393
+ #
1394
+ # * wildcard characters `? *`
1395
+ #
1396
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
1397
+ #
1398
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
1177
1399
  # @return [String]
1178
1400
  #
1179
1401
  # @!attribute [rw] output
@@ -1188,12 +1410,26 @@ module Aws::States
1188
1410
  include Aws::Structure
1189
1411
  end
1190
1412
 
1413
+ # Contains details about the state machine.
1414
+ #
1191
1415
  # @!attribute [rw] state_machine_arn
1192
1416
  # The Amazon Resource Name (ARN) that identifies the state machine.
1193
1417
  # @return [String]
1194
1418
  #
1195
1419
  # @!attribute [rw] name
1196
1420
  # The name of the state machine.
1421
+ #
1422
+ # A name must *not* contain:
1423
+ #
1424
+ # * whitespace
1425
+ #
1426
+ # * brackets `< > \{ \} [ ]`
1427
+ #
1428
+ # * wildcard characters `? *`
1429
+ #
1430
+ # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
1431
+ #
1432
+ # * control characters (`U+0000-001F`, `U+007F-009F`)
1197
1433
  # @return [String]
1198
1434
  #
1199
1435
  # @!attribute [rw] creation_date
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-states
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-08-29 00:00:00.000000000 Z
11
+ date: 2017-11-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -56,7 +56,9 @@ files:
56
56
  homepage: http://github.com/aws/aws-sdk-ruby
57
57
  licenses:
58
58
  - Apache-2.0
59
- metadata: {}
59
+ metadata:
60
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-states
61
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-states/CHANGELOG.md
60
62
  post_install_message:
61
63
  rdoc_options: []
62
64
  require_paths: