forked from aws/aws-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAmazonSimpleWorkflowAsync.java
More file actions
4358 lines (4292 loc) · 188 KB
/
AmazonSimpleWorkflowAsync.java
File metadata and controls
4358 lines (4292 loc) · 188 KB
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
/*
* Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.simpleworkflow;
import java.util.concurrent.Future;
import com.amazonaws.AmazonClientException;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.handlers.AsyncHandler;
import com.amazonaws.services.simpleworkflow.model.*;
/**
* Interface for accessing AmazonSimpleWorkflow asynchronously.
* Each asynchronous method will return a Java Future object, and users are also allowed
* to provide a callback handler.
* Amazon Simple Workflow Service <p>
* The Amazon Simple Workflow Service API Reference is intended for programmers who need detailed information about the Amazon SWF actions and data
* types.
* </p>
* <p>
* For an broader overview of the Amazon SWF programming model, please go to the <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/">
* Amazon SWF Developer Guide </a> .
* </p>
* <p>
* This section provides an overview of Amazon SWF actions.
* </p>
* <p>
* <b>Action Categories</b>
* </p>
* <p>
* The Amazon SWF actions can be grouped into the following major categories.
* </p>
*
* <ul>
* <li> <p>
* Actions related to Activities
* </p>
* </li>
* <li> <p>
* Actions related to Deciders
* </p>
* </li>
* <li> <p>
* Actions related to Workflow Executions
* </p>
* </li>
* <li> <p>
* Actions related to Administration
* </p>
* </li>
* <li> <p>
* Actions related to Visibility
* </p>
* </li>
*
* </ul>
* <p>
* <b>Actions related to Activities</b>
* </p>
* <p>
* The following are actions that are performed by activity workers:
* </p>
*
* <ul>
* <li> <p>
* PollForActivityTask
* </p>
* </li>
* <li> <p>
* RespondActivityTaskCompleted
* </p>
* </li>
* <li> <p>
* RespondActivityTaskFailed
* </p>
* </li>
* <li> <p>
* RespondActivityTaskCanceled
* </p>
* </li>
* <li> <p>
* RecordActivityTaskHeartbeat
* </p>
* </li>
*
* </ul>
* <p>
* Activity workers use the PollForActivityTask to get new activity tasks. After a worker receives an activity task from Amazon SWF, it performs the task
* and responds using RespondActivityTaskCompleted if successful or RespondActivityTaskFailed if unsuccessful.
* </p>
* <p>
* <b>Actions related to Deciders</b>
* </p>
* <p>
* The following are actions that are performed by deciders:
* </p>
*
* <ul>
* <li> <p>
* PollForDecisionTask
* </p>
* </li>
* <li> <p>
* RespondDecisionTaskCompleted
* </p>
* </li>
*
* </ul>
* <p>
* Deciders use PollForDecisionTask to get decision tasks. After a decider receives a decision task from Amazon SWF, it examines its workflow execution
* history and decides what to do next. It calls RespondDecisionTaskCompletedto complete the decision task and provide zero or more next decisions.
* </p>
* <p>
* <b>Actions related to Workflow Executions</b>
* </p>
* <p>
* The following actions operate on a workflow execution:
* </p>
*
* <ul>
* <li> <p>
* RequestCancelWorkflowExecution
* </p>
* </li>
* <li> <p>
* StartWorkflowExecution
* </p>
* </li>
* <li> <p>
* SignalWorkflowExecution
* </p>
* </li>
* <li> <p>
* TerminateWorkflowExecution
* </p>
* </li>
*
* </ul>
* <p>
* <b>Actions related to Administration</b>
* </p>
* <p>
* Although you can perform administrative tasks from the Amazon SWF console, you can use the actions in this section to automate functions or build your
* own administrative tools.
* </p>
* <p>
* <b>Activity Management</b>
* </p>
*
* <ul>
* <li> <p>
* RegisterActivityType
* </p>
* </li>
* <li> <p>
* DeprecateActivityType
* </p>
* </li>
*
* </ul>
* <p>
* <b>Workflow Management</b>
* </p>
*
* <ul>
* <li> <p>
* RegisterWorkflowType
* </p>
* </li>
* <li> <p>
* DeprecateWorkflowType
* </p>
* </li>
*
* </ul>
* <p>
* <b>Domain Management</b>
* </p>
*
* <ul>
* <li> <p>
* RegisterDomain
* </p>
* </li>
* <li> <p>
* DeprecateDomain
* </p>
* </li>
*
* </ul>
* <p>
* <b>Workflow Execution Management</b>
* </p>
*
* <ul>
* <li> <p>
* RequestCancelWorkflowExecution
* </p>
* </li>
* <li> <p>
* TerminateWorkflowExecution
* </p>
* </li>
*
* </ul>
* <p>
* <b>Visibility Actions</b>
* </p>
* <p>
* Although you can perform visibility actions from the Amazon SWF console, you can use the actions in this section to build your own console or
* administrative tools.
* </p>
*
* <ul>
*
* </ul>
* <p>
* <b>Activity Visibility</b>
* </p>
*
* <ul>
* <li> <p>
* ListActivityTypes
* </p>
* </li>
* <li> <p>
* DescribeActivity
* </p>
* </li>
*
* </ul>
* <p>
* <b>Workflow Visibility</b>
* </p>
*
* <ul>
* <li> <p>
* ListWorkflowTypes
* </p>
* </li>
* <li> <p>
* DescribeWorkflowType
* </p>
* </li>
*
* </ul>
* <p>
* <b>Workflow Execution Visibility</b>
* </p>
*
* <ul>
* <li> <p>
* DescribeWorkflowExecution
* </p>
* </li>
* <li> <p>
* ListOpenWorkflowExecutions
* </p>
* </li>
* <li> <p>
* ListClosedWorkflowExecutions
* </p>
* </li>
* <li> <p>
* CountOpenWorkflowExecutions
* </p>
* </li>
* <li> <p>
* CountClosedWorkflowExecutions
* </p>
* </li>
* <li> <p>
* GetWorkflowExecutionHistory
* </p>
* </li>
*
* </ul>
* <p>
* <b>Domain Visibility</b>
* </p>
*
* <ul>
* <li> <p>
* ListDomains
* </p>
* </li>
* <li> <p>
* DescribeDomain
* </p>
* </li>
*
* </ul>
* <p>
* <b>Task List Visibility</b>
* </p>
*
* <ul>
* <li> <p>
* CountPendingActivityTasks
* </p>
* </li>
* <li> <p>
* CountPendingDecisionTasks
* </p>
* </li>
*
* </ul>
*/
public interface AmazonSimpleWorkflowAsync extends AmazonSimpleWorkflow {
/**
* <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>
* <p>
* <b>NOTE:</b> This operation is eventually consistent. The results are
* best effort and may not exactly reflect recent updates and changes.
* </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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param deprecateWorkflowTypeRequest Container for the necessary
* parameters to execute the DeprecateWorkflowType operation on
* AmazonSimpleWorkflow.
*
* @return A Java Future object containing the response from the
* DeprecateWorkflowType service method, as returned by
* AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<Void> deprecateWorkflowTypeAsync(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <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>
* <p>
* <b>NOTE:</b> This operation is eventually consistent. The results are
* best effort and may not exactly reflect recent updates and changes.
* </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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param deprecateWorkflowTypeRequest Container for the necessary
* parameters to execute the DeprecateWorkflowType operation on
* AmazonSimpleWorkflow.
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the implementation of
* the four callback methods in this interface to process the operation
* result or handle the exception.
*
* @return A Java Future object containing the response from the
* DeprecateWorkflowType service method, as returned by
* AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<Void> deprecateWorkflowTypeAsync(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest,
AsyncHandler<DeprecateWorkflowTypeRequest, Void> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <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>
* <p>
* <b>NOTE:</b> This operation is eventually consistent. The results are
* best effort and may not exactly reflect recent updates and changes.
* </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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param deprecateDomainRequest Container for the necessary parameters
* to execute the DeprecateDomain operation on AmazonSimpleWorkflow.
*
* @return A Java Future object containing the response from the
* DeprecateDomain service method, as returned by AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<Void> deprecateDomainAsync(DeprecateDomainRequest deprecateDomainRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <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>
* <p>
* <b>NOTE:</b> This operation is eventually consistent. The results are
* best effort and may not exactly reflect recent updates and changes.
* </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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param deprecateDomainRequest Container for the necessary parameters
* to execute the DeprecateDomain operation on AmazonSimpleWorkflow.
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the implementation of
* the four callback methods in this interface to process the operation
* result or handle the exception.
*
* @return A Java Future object containing the response from the
* DeprecateDomain service method, as returned by AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<Void> deprecateDomainAsync(DeprecateDomainRequest deprecateDomainRequest,
AsyncHandler<DeprecateDomainRequest, Void> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <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
* RegisterDomain action.
* </p>
* <p>
* <b>IMPORTANT:</b> If the type already exists, then a TypeAlreadyExists
* 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.
* </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>defaultTaskList</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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param registerWorkflowTypeRequest Container for the necessary
* parameters to execute the RegisterWorkflowType operation on
* AmazonSimpleWorkflow.
*
* @return A Java Future object containing the response from the
* RegisterWorkflowType service method, as returned by
* AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<Void> registerWorkflowTypeAsync(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <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
* RegisterDomain action.
* </p>
* <p>
* <b>IMPORTANT:</b> If the type already exists, then a TypeAlreadyExists
* 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.
* </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>defaultTaskList</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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param registerWorkflowTypeRequest Container for the necessary
* parameters to execute the RegisterWorkflowType operation on
* AmazonSimpleWorkflow.
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the implementation of
* the four callback methods in this interface to process the operation
* result or handle the exception.
*
* @return A Java Future object containing the response from the
* RegisterWorkflowType service method, as returned by
* AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<Void> registerWorkflowTypeAsync(RegisterWorkflowTypeRequest registerWorkflowTypeRequest,
AsyncHandler<RegisterWorkflowTypeRequest, Void> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param listWorkflowTypesRequest Container for the necessary parameters
* to execute the ListWorkflowTypes operation on AmazonSimpleWorkflow.
*
* @return A Java Future object containing the response from the
* ListWorkflowTypes service method, as returned by AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<WorkflowTypeInfos> listWorkflowTypesAsync(ListWorkflowTypesRequest listWorkflowTypesRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param listWorkflowTypesRequest Container for the necessary parameters
* to execute the ListWorkflowTypes operation on AmazonSimpleWorkflow.
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the implementation of
* the four callback methods in this interface to process the operation
* result or handle the exception.
*
* @return A Java Future object containing the response from the
* ListWorkflowTypes service method, as returned by AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<WorkflowTypeInfos> listWorkflowTypesAsync(ListWorkflowTypesRequest listWorkflowTypesRequest,
AsyncHandler<ListWorkflowTypesRequest, WorkflowTypeInfos> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <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>name</code> : String constraint. The key is
* <code>swf:workflowType.name</code> .</li>
* <li> <code>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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param startWorkflowExecutionRequest Container for the necessary
* parameters to execute the StartWorkflowExecution operation on
* AmazonSimpleWorkflow.
*
* @return A Java Future object containing the response from the
* StartWorkflowExecution service method, as returned by
* AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<Run> startWorkflowExecutionAsync(StartWorkflowExecutionRequest startWorkflowExecutionRequest)
throws AmazonServiceException, AmazonClientException;
/**
* <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>name</code> : String constraint. The key is
* <code>swf:workflowType.name</code> .</li>
* <li> <code>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 by throwing
* <code>OperationNotPermitted</code> . For details and example IAM
* policies, see <a
* docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">
* Using IAM to Manage Access to Amazon SWF Workflows </a> .
* </p>
*
* @param startWorkflowExecutionRequest Container for the necessary
* parameters to execute the StartWorkflowExecution operation on
* AmazonSimpleWorkflow.
* @param asyncHandler Asynchronous callback handler for events in the
* life-cycle of the request. Users could provide the implementation of
* the four callback methods in this interface to process the operation
* result or handle the exception.
*
* @return A Java Future object containing the response from the
* StartWorkflowExecution service method, as returned by
* AmazonSimpleWorkflow.
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonSimpleWorkflow indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future<Run> startWorkflowExecutionAsync(StartWorkflowExecutionRequest startWorkflowExecutionRequest,
AsyncHandler<StartWorkflowExecutionRequest, Run> asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
* <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>
* <p>
* <b>NOTE:</b> If a runId is not specified, then the
* WorkflowExecutionSignaled event is recorded in the history of the
* current open workflow with the matching workflowId in the domain.
* </p>
* <p>
* <b>NOTE:</b> If the specified workflow execution is not open, this
* method fails with UnknownResource.
* </p>
* <p>