forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswf-2012-01-25.normal.json
4803 lines (4803 loc) · 326 KB
/
swf-2012-01-25.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"uid":"swf-2012-01-25",
"apiVersion":"2012-01-25",
"endpointPrefix":"swf",
"jsonVersion":"1.0",
"serviceAbbreviation":"Amazon SWF",
"serviceFullName":"Amazon Simple Workflow Service",
"signatureVersion":"v4",
"targetPrefix":"SimpleWorkflowService",
"timestampFormat":"unixTimestamp",
"protocol":"json"
},
"documentation":"<fullname>Amazon Simple Workflow Service</fullname> <p>The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a <i>task</i> represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.</p> <p>Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.</p> <p>This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/\">Amazon SWF Developer Guide</a>.</p>",
"operations":{
"CountClosedWorkflowExecutions":{
"name":"CountClosedWorkflowExecutions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CountClosedWorkflowExecutionsInput"},
"output":{
"shape":"WorkflowExecutionCount",
"documentation":"<p>Contains the count of workflow executions returned from <a>CountOpenWorkflowExecutions</a> or <a>CountClosedWorkflowExecutions</a></p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.</p> <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"CountOpenWorkflowExecutions":{
"name":"CountOpenWorkflowExecutions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CountOpenWorkflowExecutionsInput"},
"output":{
"shape":"WorkflowExecutionCount",
"documentation":"<p>Contains the count of workflow executions returned from <a>CountOpenWorkflowExecutions</a> or <a>CountClosedWorkflowExecutions</a></p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.</p> <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"CountPendingActivityTasks":{
"name":"CountPendingActivityTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CountPendingActivityTasksInput"},
"output":{
"shape":"PendingTaskCount",
"documentation":"<p>Contains the count of tasks in a task list.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"CountPendingDecisionTasks":{
"name":"CountPendingDecisionTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CountPendingDecisionTasksInput"},
"output":{
"shape":"PendingTaskCount",
"documentation":"<p>Contains the count of tasks in a task list.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"DeprecateActivityType":{
"name":"DeprecateActivityType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeprecateActivityTypeInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"TypeDeprecatedFault",
"exception":true,
"documentation":"<p>Returned when the specified activity or workflow type was already deprecated.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Deprecates the specified <i>activity type</i>. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.</p> <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>activityType.name</code>: String constraint. The key is <code>swf:activityType.name</code>.</li> <li><code>activityType.version</code>: String constraint. The key is <code>swf:activityType.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"DeprecateDomain":{
"name":"DeprecateDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeprecateDomainInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"DomainDeprecatedFault",
"exception":true,
"documentation":"<p>Returned when the specified domain has been deprecated.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.</p> <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"DeprecateWorkflowType":{
"name":"DeprecateWorkflowType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeprecateWorkflowTypeInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"TypeDeprecatedFault",
"exception":true,
"documentation":"<p>Returned when the specified activity or workflow type was already deprecated.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Deprecates the specified <i>workflow type</i>. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.</p> <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"DescribeActivityType":{
"name":"DescribeActivityType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeActivityTypeInput"},
"output":{
"shape":"ActivityTypeDetail",
"documentation":"<p>Detailed information about an activity type.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>activityType.name</code>: String constraint. The key is <code>swf:activityType.name</code>.</li> <li><code>activityType.version</code>: String constraint. The key is <code>swf:activityType.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"DescribeDomain":{
"name":"DescribeDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDomainInput"},
"output":{
"shape":"DomainDetail",
"documentation":"<p>Contains details of a domain.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns information about the specified domain, including description and status.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"DescribeWorkflowExecution":{
"name":"DescribeWorkflowExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkflowExecutionInput"},
"output":{
"shape":"WorkflowExecutionDetail",
"documentation":"<p>Contains details about a workflow execution.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns information about the specified workflow execution including its type and some statistics.</p> <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"DescribeWorkflowType":{
"name":"DescribeWorkflowType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkflowTypeInput"},
"output":{
"shape":"WorkflowTypeDetail",
"documentation":"<p>Contains details about a workflow type.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns information about the specified <i>workflow type</i>. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"GetWorkflowExecutionHistory":{
"name":"GetWorkflowExecutionHistory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetWorkflowExecutionHistoryInput"},
"output":{
"shape":"History",
"documentation":"<p>Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned by the initial call.</p> <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"ListActivityTypes":{
"name":"ListActivityTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListActivityTypesInput"},
"output":{
"shape":"ActivityTypeInfos",
"documentation":"<p>Contains a paginated list of activity type information structures.</p>"
},
"errors":[
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
},
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
}
],
"documentation":"<p>Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned by the initial call.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"ListClosedWorkflowExecutions":{
"name":"ListClosedWorkflowExecutions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListClosedWorkflowExecutionsInput"},
"output":{
"shape":"WorkflowExecutionInfos",
"documentation":"<p>Contains a paginated list of information about workflow executions.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.</p> <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"ListDomains":{
"name":"ListDomains",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDomainsInput"},
"output":{
"shape":"DomainInfos",
"documentation":"<p>Contains a paginated collection of DomainInfo structures.</p>"
},
"errors":[
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.</p> <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains. The element must be set to <code>arn:aws:swf::AccountID:domain/*</code>, where <i>AccountID</i> is the account ID, with no dashes.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"ListOpenWorkflowExecutions":{
"name":"ListOpenWorkflowExecutions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListOpenWorkflowExecutionsInput"},
"output":{
"shape":"WorkflowExecutionInfos",
"documentation":"<p>Contains a paginated list of information about workflow executions.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.</p> <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"ListWorkflowTypes":{
"name":"ListWorkflowTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListWorkflowTypesInput"},
"output":{
"shape":"WorkflowTypeInfos",
"documentation":"<p>Contains a paginated list of information structures about workflow types.</p>"
},
"errors":[
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
},
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
}
],
"documentation":"<p>Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"PollForActivityTask":{
"name":"PollForActivityTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PollForActivityTaskInput"},
"output":{
"shape":"ActivityTask",
"documentation":"<p>Unit of work sent to an activity worker.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
},
{
"shape":"LimitExceededFault",
"exception":true,
"documentation":"<p>Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.</p>"
}
],
"documentation":"<p>Used by workers to get an <a>ActivityTask</a> from the specified activity <code>taskList</code>. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.</p> <important>Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).</important> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"PollForDecisionTask":{
"name":"PollForDecisionTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PollForDecisionTaskInput"},
"output":{
"shape":"DecisionTask",
"documentation":"<p>A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
},
{
"shape":"LimitExceededFault",
"exception":true,
"documentation":"<p>Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.</p>"
}
],
"documentation":"<p>Used by deciders to get a <a>DecisionTask</a> from the specified decision <code>taskList</code>. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.</p> <p>This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of <code>taskToken</code> is an empty string.</p> <important>Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout).</important> <important>Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to <code>PollForDecisionTask</code> using the <code>nextPageToken</code> returned by the initial call. Note that you do <b>not</b> call <code>GetWorkflowExecutionHistory</code> with this <code>nextPageToken</code>. Instead, call <code>PollForDecisionTask</code> again.</important> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RecordActivityTaskHeartbeat":{
"name":"RecordActivityTaskHeartbeat",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RecordActivityTaskHeartbeatInput"},
"output":{
"shape":"ActivityTaskStatus",
"documentation":"<p>Status information about an activity task.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Used by activity workers to report to the service that the <a>ActivityTask</a> represented by the specified <code>taskToken</code> is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the <code>details</code> parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean <code>cancelRequested</code> flag returned by the service is set to <code>true</code>.</p> <p>This action resets the <code>taskHeartbeatTimeout</code> clock. The <code>taskHeartbeatTimeout</code> is specified in <a>RegisterActivityType</a>.</p> <p>This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a <code>ActivityTaskTimedOut</code> event that contains the information from the last heartbeat generated by the activity worker.</p> <note>The <code>taskStartToCloseTimeout</code> of an activity type is the maximum duration of an activity task, regardless of the number of <a>RecordActivityTaskHeartbeat</a> requests received. The <code>taskStartToCloseTimeout</code> is also specified in <a>RegisterActivityType</a>.</note> <note>This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. </note> <important>If the <code>cancelRequested</code> flag returns <code>true</code>, a cancellation is being attempted. If the worker can cancel the activity, it should respond with <a>RespondActivityTaskCanceled</a>. Otherwise, it should ignore the cancellation request.</important> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RegisterActivityType":{
"name":"RegisterActivityType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterActivityTypeInput"},
"errors":[
{
"shape":"TypeAlreadyExistsFault",
"exception":true,
"documentation":"<p>Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.</p>"
},
{
"shape":"LimitExceededFault",
"exception":true,
"documentation":"<p>Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.</p>"
},
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Registers a new <i>activity type</i> along with its configuration settings in the specified domain.</p> <important>A <code>TypeAlreadyExists</code> fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.</important> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>defaultTaskList.name</code>: String constraint. The key is <code>swf:defaultTaskList.name</code>.</li> <li> <code>name</code>: String constraint. The key is <code>swf:name</code>.</li> <li> <code>version</code>: String constraint. The key is <code>swf:version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RegisterDomain":{
"name":"RegisterDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterDomainInput"},
"errors":[
{
"shape":"DomainAlreadyExistsFault",
"exception":true,
"documentation":"<p>Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.</p>"
},
{
"shape":"LimitExceededFault",
"exception":true,
"documentation":"<p>Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Registers a new domain.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RegisterWorkflowType":{
"name":"RegisterWorkflowType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterWorkflowTypeInput"},
"errors":[
{
"shape":"TypeAlreadyExistsFault",
"exception":true,
"documentation":"<p>Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.</p>"
},
{
"shape":"LimitExceededFault",
"exception":true,
"documentation":"<p>Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.</p>"
},
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Registers a new <i>workflow type</i> and its configuration settings in the specified domain.</p> <p>The retention period for the workflow history is set by the <a>RegisterDomain</a> action.</p> <important>If the type already exists, then a <code>TypeAlreadyExists</code> fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.</important> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>defaultTaskList.name</code>: String constraint. The key is <code>swf:defaultTaskList.name</code>.</li> <li> <code>name</code>: String constraint. The key is <code>swf:name</code>.</li> <li> <code>version</code>: String constraint. The key is <code>swf:version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RequestCancelWorkflowExecution":{
"name":"RequestCancelWorkflowExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RequestCancelWorkflowExecutionInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Records a <code>WorkflowExecutionCancelRequested</code> event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.</p> <note>If the runId is not specified, the <code>WorkflowExecutionCancelRequested</code> event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.</note> <note>Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of <a>TerminateWorkflowExecution</a> when possible.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RespondActivityTaskCanceled":{
"name":"RespondActivityTaskCanceled",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RespondActivityTaskCanceledInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> was successfully canceled. Additional <code>details</code> can be optionally provided using the <code>details</code> argument.</p> <p>These <code>details</code> (if provided) appear in the <code>ActivityTaskCanceled</code> event added to the workflow history.</p> <important>Only use this operation if the <code>canceled</code> flag of a <a>RecordActivityTaskHeartbeat</a> request returns <code>true</code> and if the activity can be safely undone or abandoned.</important> <p>A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to <a>RespondActivityTaskCompleted</a>, RespondActivityTaskCanceled, <a>RespondActivityTaskFailed</a>, or the task has <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types\">timed out</a>.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RespondActivityTaskCompleted":{
"name":"RespondActivityTaskCompleted",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RespondActivityTaskCompletedInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> completed successfully with a <code>result</code> (if provided). The <code>result</code> appears in the <code>ActivityTaskCompleted</code> event in the workflow history.</p> <important> If the requested task does not complete successfully, use <a>RespondActivityTaskFailed</a> instead. If the worker finds that the task is canceled through the <code>canceled</code> flag returned by <a>RecordActivityTaskHeartbeat</a>, it should cancel the task, clean up and then call <a>RespondActivityTaskCanceled</a>.</important> <p>A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, <a>RespondActivityTaskCanceled</a>, <a>RespondActivityTaskFailed</a>, or the task has <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types\">timed out</a>.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RespondActivityTaskFailed":{
"name":"RespondActivityTaskFailed",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RespondActivityTaskFailedInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> has failed with <code>reason</code> (if specified). The <code>reason</code> and <code>details</code> appear in the <code>ActivityTaskFailed</code> event added to the workflow history.</p> <p>A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to <a>RespondActivityTaskCompleted</a>, <a>RespondActivityTaskCanceled</a>, RespondActivityTaskFailed, or the task has <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types\">timed out</a>.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"RespondDecisionTaskCompleted":{
"name":"RespondDecisionTaskCompleted",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RespondDecisionTaskCompletedInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Used by deciders to tell the service that the <a>DecisionTask</a> identified by the <code>taskToken</code> has successfully completed. The <code>decisions</code> argument specifies the list of decisions made while processing the task.</p> <p>A <code>DecisionTaskCompleted</code> event is added to the workflow history. The <code>executionContext</code> specified is attached to the event in the workflow execution history.</p> <p><b>Access Control</b></p> <p>If an IAM policy grants permission to use <code>RespondDecisionTaskCompleted</code>, it can express permissions for the list of decisions in the <code>decisions</code> parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"SignalWorkflowExecution":{
"name":"SignalWorkflowExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SignalWorkflowExecutionInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Records a <code>WorkflowExecutionSignaled</code> event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).</p> <note> If a runId is not specified, then the <code>WorkflowExecutionSignaled</code> event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note> <note> If the specified workflow execution is not open, this method fails with <code>UnknownResource</code>.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"StartWorkflowExecution":{
"name":"StartWorkflowExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartWorkflowExecutionInput"},
"output":{
"shape":"Run",
"documentation":"<p>Specifies the <code>runId</code> of a workflow execution.</p>"
},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"TypeDeprecatedFault",
"exception":true,
"documentation":"<p>Returned when the specified activity or workflow type was already deprecated.</p>"
},
{
"shape":"WorkflowExecutionAlreadyStartedFault",
"exception":true,
"documentation":"<p>Returned by <a>StartWorkflowExecution</a> when an open execution with the same workflowId is already running in the specified domain.</p>"
},
{
"shape":"LimitExceededFault",
"exception":true,
"documentation":"<p>Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
},
{
"shape":"DefaultUndefinedFault",
"exception":true
}
],
"documentation":"<p>Starts an execution of the workflow type in the specified domain using the provided <code>workflowId</code> and input data.</p> <p>This action returns the newly started workflow execution.</p> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>tagList.member.0</code>: The key is <code>swf:tagList.member.0</code>.</li> <li> <code>tagList.member.1</code>: The key is <code>swf:tagList.member.1</code>.</li> <li> <code>tagList.member.2</code>: The key is <code>swf:tagList.member.2</code>.</li> <li> <code>tagList.member.3</code>: The key is <code>swf:tagList.member.3</code>.</li> <li> <code>tagList.member.4</code>: The key is <code>swf:tagList.member.4</code>.</li> <li><code>taskList</code>: String constraint. The key is <code>swf:taskList.name</code>.</li> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
},
"TerminateWorkflowExecution":{
"name":"TerminateWorkflowExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TerminateWorkflowExecutionInput"},
"errors":[
{
"shape":"UnknownResourceFault",
"exception":true,
"documentation":"<p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>"
},
{
"shape":"OperationNotPermittedFault",
"exception":true,
"documentation":"<p>Returned when the caller does not have sufficient permissions to invoke the action.</p>"
}
],
"documentation":"<p>Records a <code>WorkflowExecutionTerminated</code> event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.</p> <important> If the identified workflow execution was in progress, it is terminated immediately.</important> <note> If a runId is not specified, then the <code>WorkflowExecutionTerminated</code> event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note> <note> You should consider using <a>RequestCancelWorkflowExecution</a> action instead because it allows the workflow to gracefully close while <a>TerminateWorkflowExecution</a> does not.</note> <p><b>Access Control</b></p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>"
}
},
"shapes":{
"ActivityId":{
"type":"string",
"min":1,
"max":256
},
"ActivityTask":{
"type":"structure",
"required":[
"taskToken",
"activityId",
"startedEventId",
"workflowExecution",
"activityType"
],
"members":{
"taskToken":{
"shape":"TaskToken",
"documentation":"<p>The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.</p>"
},
"activityId":{
"shape":"ActivityId",
"documentation":"<p>The unique ID of the task.</p>"
},
"startedEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>ActivityTaskStarted</code> event recorded in the history.</p>"
},
"workflowExecution":{
"shape":"WorkflowExecution",
"documentation":"<p>The workflow execution that started this activity task.</p>"
},
"activityType":{
"shape":"ActivityType",
"documentation":"<p>The type of this activity task.</p>"
},
"input":{
"shape":"Data",
"documentation":"<p>The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.</p>"
}
},
"documentation":"<p>Unit of work sent to an activity worker.</p>"
},
"ActivityTaskCancelRequestedEventAttributes":{
"type":"structure",
"required":[
"decisionTaskCompletedEventId",
"activityId"
],
"members":{
"decisionTaskCompletedEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in the <code>RequestCancelActivityTask</code> decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
},
"activityId":{
"shape":"ActivityId",
"documentation":"<p>The unique ID of the task.</p>"
}
},
"documentation":"<p>Provides details of the <code>ActivityTaskCancelRequested</code> event.</p>"
},
"ActivityTaskCanceledEventAttributes":{
"type":"structure",
"required":[
"scheduledEventId",
"startedEventId"
],
"members":{
"details":{
"shape":"Data",
"documentation":"<p>Details of the cancellation (if any).</p>"
},
"scheduledEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
},
"startedEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>ActivityTaskStarted</code> event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
},
"latestCancelRequestedEventId":{
"shape":"EventId",
"documentation":"<p>If set, contains the ID of the last <code>ActivityTaskCancelRequested</code> event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
}
},
"documentation":"<p>Provides details of the <code>ActivityTaskCanceled</code> event.</p>"
},
"ActivityTaskCompletedEventAttributes":{
"type":"structure",
"required":[
"scheduledEventId",
"startedEventId"
],
"members":{
"result":{
"shape":"Data",
"documentation":"<p>The results of the activity task (if any).</p>"
},
"scheduledEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
},
"startedEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>ActivityTaskStarted</code> event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
}
},
"documentation":"<p>Provides details of the <code>ActivityTaskCompleted</code> event.</p>"
},
"ActivityTaskFailedEventAttributes":{
"type":"structure",
"required":[
"scheduledEventId",
"startedEventId"
],
"members":{
"reason":{
"shape":"FailureReason",
"documentation":"<p>The reason provided for the failure (if any).</p>"
},
"details":{
"shape":"Data",
"documentation":"<p>The details of the failure (if any).</p>"
},
"scheduledEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
},
"startedEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>ActivityTaskStarted</code> event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
}
},
"documentation":"<p>Provides details of the <code>ActivityTaskFailed</code> event.</p>"
},
"ActivityTaskScheduledEventAttributes":{
"type":"structure",
"required":[
"activityType",
"activityId",
"taskList",
"decisionTaskCompletedEventId"
],
"members":{
"activityType":{
"shape":"ActivityType",
"documentation":"<p>The type of the activity task.</p>"
},
"activityId":{
"shape":"ActivityId",
"documentation":"<p>The unique ID of the activity task.</p>"
},
"input":{
"shape":"Data",
"documentation":"<p>The input provided to the activity task.</p>"
},
"control":{
"shape":"Data",
"documentation":"<p><i>Optional.</i> Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.</p>"
},
"scheduleToStartTimeout":{
"shape":"DurationInSecondsOptional",
"documentation":"<p>The maximum amount of time the activity task can wait to be assigned to a worker.</p>"
},
"scheduleToCloseTimeout":{
"shape":"DurationInSecondsOptional",
"documentation":"<p>The maximum amount of time for this activity task.</p>"
},
"startToCloseTimeout":{
"shape":"DurationInSecondsOptional",
"documentation":"<p>The maximum amount of time a worker may take to process the activity task.</p>"
},
"taskList":{
"shape":"TaskList",
"documentation":"<p>The task list in which the activity task has been scheduled.</p>"
},
"taskPriority":{
"shape":"TaskPriority",
"documentation":"<p><i>Optional.</i> The priority to assign to the scheduled activity task. If set, this will override any default priority value that was assigned when the activity type was registered.</p> <p>Valid values are integers that range from Java's <code>Integer.MIN_VALUE</code> (-2147483648) to <code>Integer.MAX_VALUE</code> (2147483647). Higher numbers indicate higher priority.</p> <p>For more information about setting task priority, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html\">Setting Task Priority</a> in the <i>Amazon Simple Workflow Developer Guide</i>.</p>"
},
"decisionTaskCompletedEventId":{
"shape":"EventId",
"documentation":"<p>The ID of the <code>DecisionTaskCompleted</code> event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.</p>"
},
"heartbeatTimeout":{
"shape":"DurationInSecondsOptional",
"documentation":"<p>The maximum time before which the worker processing this task must report progress by calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.</p>"
}
},
"documentation":"<p>Provides details of the <code>ActivityTaskScheduled</code> event.</p>"
},
"ActivityTaskStartedEventAttributes":{
"type":"structure",
"required":["scheduledEventId"],
"members":{
"identity":{