aws-sdk-swf 1.0.0.rc7 → 1.0.0.rc8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e40faa23f081f8b37ca795a877d8db6a4ed521bf
4
- data.tar.gz: e0f475c93c9a105ae0a39e47d6bde7b53d3b9751
3
+ metadata.gz: 1262a3133414a19df1ecd67766e0cd0517977a6b
4
+ data.tar.gz: b02bb70f6980910e39ecc89c73664ea8c1313d05
5
5
  SHA512:
6
- metadata.gz: eedc7e1b92d8d6567e991a88f5925710fbc3b6260355e9478325302b9e5c19ebf921309db6ac48dfad71384c7dfae779171ef366685d81c9cd5c353a416c3142
7
- data.tar.gz: 59849c693539f9e7e116e709b1eae04b26f20a72bc4c8afd9f38becaa167d13baced82d782a5ed235f75023cfbf2bcc26c2dd41759ac702f79e8101532633dad
6
+ metadata.gz: 4436f3dd6e7d2211daab5379985211ca65c5f80f193c0db157e4f5fb8b28b660e18040b86f2b22856e79daeb391c55f29b15bfba4aa5fe63981bab34195188f5
7
+ data.tar.gz: 2c014f759cf25d7b7f11622a9efb319e4e86f09233caee927b00b18650b8ecd4d7b0bb7449643682d2e7fe9251f0af6744831a80879c7000f96bd2f3632b6ee7
data/lib/aws-sdk-swf.rb CHANGED
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-swf/customizations'
42
42
  # @service
43
43
  module Aws::SWF
44
44
 
45
- GEM_VERSION = '1.0.0.rc7'
45
+ GEM_VERSION = '1.0.0.rc8'
46
46
 
47
47
  end
@@ -160,7 +160,10 @@ module Aws::SWF
160
160
  # Returns the number of closed workflow executions within the given
161
161
  # domain that meet the specified filtering criteria.
162
162
  #
163
- # <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
163
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
164
+ # and may not exactly reflect recent updates and changes.
165
+ #
166
+ # </note>
164
167
  #
165
168
  # **Access Control**
166
169
  #
@@ -169,23 +172,28 @@ module Aws::SWF
169
172
  #
170
173
  # * Use a `Resource` element with the domain name to limit the action to
171
174
  # only specified domains.
175
+ #
172
176
  # * Use an `Action` element to allow or deny permission to call this
173
177
  # action.
178
+ #
174
179
  # * Constrain the following parameters by using a `Condition` element
175
180
  # with the appropriate keys.
181
+ #
176
182
  # * `tagFilter.tag`\: String constraint. The key is
177
183
  # `swf:tagFilter.tag`.
184
+ #
178
185
  # * `typeFilter.name`\: String constraint. The key is
179
186
  # `swf:typeFilter.name`.
187
+ #
180
188
  # * `typeFilter.version`\: String constraint. The key is
181
189
  # `swf:typeFilter.version`.
182
190
  #
183
- # If the caller does not have sufficient permissions to invoke the
191
+ # If the caller doesn't have sufficient permissions to invoke the
184
192
  # action, or the parameter values fall outside the specified
185
193
  # constraints, the action fails. The associated event attribute's
186
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
187
- # details and example IAM policies, see [Using IAM to Manage Access to
188
- # Amazon SWF Workflows][1].
194
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
195
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
196
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
189
197
  #
190
198
  #
191
199
  #
@@ -198,38 +206,60 @@ module Aws::SWF
198
206
  # If specified, only workflow executions that meet the start time
199
207
  # criteria of the filter are counted.
200
208
  #
201
- # <note>`startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.</note>
209
+ # <note markdown="1"> `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You
210
+ # must specify one of these in a request but not both.
211
+ #
212
+ # </note>
202
213
  #
203
214
  # @option params [Types::ExecutionTimeFilter] :close_time_filter
204
215
  # If specified, only workflow executions that meet the close time
205
216
  # criteria of the filter are counted.
206
217
  #
207
- # <note>`startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.</note>
218
+ # <note markdown="1"> `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You
219
+ # must specify one of these in a request but not both.
220
+ #
221
+ # </note>
208
222
  #
209
223
  # @option params [Types::WorkflowExecutionFilter] :execution_filter
210
224
  # If specified, only workflow executions matching the `WorkflowId` in
211
225
  # the filter are counted.
212
226
  #
213
- # <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
227
+ # <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter`
228
+ # are mutually exclusive. You can specify at most one of these in a
229
+ # request.
230
+ #
231
+ # </note>
214
232
  #
215
233
  # @option params [Types::WorkflowTypeFilter] :type_filter
216
234
  # If specified, indicates the type of the workflow executions to be
217
235
  # counted.
218
236
  #
219
- # <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
237
+ # <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter`
238
+ # are mutually exclusive. You can specify at most one of these in a
239
+ # request.
240
+ #
241
+ # </note>
220
242
  #
221
243
  # @option params [Types::TagFilter] :tag_filter
222
244
  # If specified, only executions that have a tag that matches the filter
223
245
  # are counted.
224
246
  #
225
- # <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
247
+ # <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter`
248
+ # are mutually exclusive. You can specify at most one of these in a
249
+ # request.
250
+ #
251
+ # </note>
226
252
  #
227
253
  # @option params [Types::CloseStatusFilter] :close_status_filter
228
254
  # If specified, only workflow executions that match this close status
229
255
  # are counted. This filter has an affect only if `executionStatus` is
230
256
  # specified as `CLOSED`.
231
257
  #
232
- # <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
258
+ # <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter`
259
+ # are mutually exclusive. You can specify at most one of these in a
260
+ # request.
261
+ #
262
+ # </note>
233
263
  #
234
264
  # @return [Types::WorkflowExecutionCount] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
235
265
  #
@@ -278,7 +308,10 @@ module Aws::SWF
278
308
  # Returns the number of open workflow executions within the given domain
279
309
  # that meet the specified filtering criteria.
280
310
  #
281
- # <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
311
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
312
+ # and may not exactly reflect recent updates and changes.
313
+ #
314
+ # </note>
282
315
  #
283
316
  # **Access Control**
284
317
  #
@@ -287,23 +320,28 @@ module Aws::SWF
287
320
  #
288
321
  # * Use a `Resource` element with the domain name to limit the action to
289
322
  # only specified domains.
323
+ #
290
324
  # * Use an `Action` element to allow or deny permission to call this
291
325
  # action.
326
+ #
292
327
  # * Constrain the following parameters by using a `Condition` element
293
328
  # with the appropriate keys.
329
+ #
294
330
  # * `tagFilter.tag`\: String constraint. The key is
295
331
  # `swf:tagFilter.tag`.
332
+ #
296
333
  # * `typeFilter.name`\: String constraint. The key is
297
334
  # `swf:typeFilter.name`.
335
+ #
298
336
  # * `typeFilter.version`\: String constraint. The key is
299
337
  # `swf:typeFilter.version`.
300
338
  #
301
- # If the caller does not have sufficient permissions to invoke the
339
+ # If the caller doesn't have sufficient permissions to invoke the
302
340
  # action, or the parameter values fall outside the specified
303
341
  # constraints, the action fails. The associated event attribute's
304
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
305
- # details and example IAM policies, see [Using IAM to Manage Access to
306
- # Amazon SWF Workflows][1].
342
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
343
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
344
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
307
345
  #
308
346
  #
309
347
  #
@@ -319,19 +357,28 @@ module Aws::SWF
319
357
  # @option params [Types::WorkflowTypeFilter] :type_filter
320
358
  # Specifies the type of the workflow executions to be counted.
321
359
  #
322
- # <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
360
+ # <note markdown="1"> `executionFilter`, `typeFilter` and `tagFilter` are mutually
361
+ # exclusive. You can specify at most one of these in a request.
362
+ #
363
+ # </note>
323
364
  #
324
365
  # @option params [Types::TagFilter] :tag_filter
325
366
  # If specified, only executions that have a tag that matches the filter
326
367
  # are counted.
327
368
  #
328
- # <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
369
+ # <note markdown="1"> `executionFilter`, `typeFilter` and `tagFilter` are mutually
370
+ # exclusive. You can specify at most one of these in a request.
371
+ #
372
+ # </note>
329
373
  #
330
374
  # @option params [Types::WorkflowExecutionFilter] :execution_filter
331
375
  # If specified, only workflow executions matching the `WorkflowId` in
332
376
  # the filter are counted.
333
377
  #
334
- # <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
378
+ # <note markdown="1"> `executionFilter`, `typeFilter` and `tagFilter` are mutually
379
+ # exclusive. You can specify at most one of these in a request.
380
+ #
381
+ # </note>
335
382
  #
336
383
  # @return [Types::WorkflowExecutionCount] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
337
384
  #
@@ -371,9 +418,9 @@ module Aws::SWF
371
418
  end
372
419
 
373
420
  # Returns the estimated number of activity tasks in the specified task
374
- # list. The count returned is an approximation and is not guaranteed to
421
+ # list. The count returned is an approximation and isn't guaranteed to
375
422
  # be exact. If you specify a task list that no activity task was ever
376
- # scheduled in then 0 will be returned.
423
+ # scheduled in then `0` is returned.
377
424
  #
378
425
  # **Access Control**
379
426
  #
@@ -382,18 +429,20 @@ module Aws::SWF
382
429
  #
383
430
  # * Use a `Resource` element with the domain name to limit the action to
384
431
  # only specified domains.
432
+ #
385
433
  # * Use an `Action` element to allow or deny permission to call this
386
434
  # action.
387
- # * Constrain the `taskList.name` parameter by using a **Condition**
435
+ #
436
+ # * Constrain the `taskList.name` parameter by using a `Condition`
388
437
  # element with the `swf:taskList.name` key to allow the action to
389
438
  # access only certain task lists.
390
439
  #
391
- # If the caller does not have sufficient permissions to invoke the
440
+ # If the caller doesn't have sufficient permissions to invoke the
392
441
  # action, or the parameter values fall outside the specified
393
442
  # constraints, the action fails. The associated event attribute's
394
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
395
- # details and example IAM policies, see [Using IAM to Manage Access to
396
- # Amazon SWF Workflows][1].
443
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
444
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
445
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
397
446
  #
398
447
  #
399
448
  #
@@ -432,9 +481,9 @@ module Aws::SWF
432
481
  end
433
482
 
434
483
  # Returns the estimated number of decision tasks in the specified task
435
- # list. The count returned is an approximation and is not guaranteed to
484
+ # list. The count returned is an approximation and isn't guaranteed to
436
485
  # be exact. If you specify a task list that no decision task was ever
437
- # scheduled in then 0 will be returned.
486
+ # scheduled in then `0` is returned.
438
487
  #
439
488
  # **Access Control**
440
489
  #
@@ -443,18 +492,20 @@ module Aws::SWF
443
492
  #
444
493
  # * Use a `Resource` element with the domain name to limit the action to
445
494
  # only specified domains.
495
+ #
446
496
  # * Use an `Action` element to allow or deny permission to call this
447
497
  # action.
448
- # * Constrain the `taskList.name` parameter by using a **Condition**
498
+ #
499
+ # * Constrain the `taskList.name` parameter by using a `Condition`
449
500
  # element with the `swf:taskList.name` key to allow the action to
450
501
  # access only certain task lists.
451
502
  #
452
- # If the caller does not have sufficient permissions to invoke the
503
+ # If the caller doesn't have sufficient permissions to invoke the
453
504
  # action, or the parameter values fall outside the specified
454
505
  # constraints, the action fails. The associated event attribute's
455
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
456
- # details and example IAM policies, see [Using IAM to Manage Access to
457
- # Amazon SWF Workflows][1].
506
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
507
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
508
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
458
509
  #
459
510
  #
460
511
  #
@@ -495,9 +546,12 @@ module Aws::SWF
495
546
  # Deprecates the specified *activity type*. After an activity type has
496
547
  # been deprecated, you cannot create new tasks of that activity type.
497
548
  # Tasks of this type that were scheduled before the type was deprecated
498
- # will continue to run.
549
+ # continue to run.
550
+ #
551
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
552
+ # and may not exactly reflect recent updates and changes.
499
553
  #
500
- # <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
554
+ # </note>
501
555
  #
502
556
  # **Access Control**
503
557
  #
@@ -506,21 +560,25 @@ module Aws::SWF
506
560
  #
507
561
  # * Use a `Resource` element with the domain name to limit the action to
508
562
  # only specified domains.
563
+ #
509
564
  # * Use an `Action` element to allow or deny permission to call this
510
565
  # action.
566
+ #
511
567
  # * Constrain the following parameters by using a `Condition` element
512
568
  # with the appropriate keys.
569
+ #
513
570
  # * `activityType.name`\: String constraint. The key is
514
571
  # `swf:activityType.name`.
572
+ #
515
573
  # * `activityType.version`\: String constraint. The key is
516
574
  # `swf:activityType.version`.
517
575
  #
518
- # If the caller does not have sufficient permissions to invoke the
576
+ # If the caller doesn't have sufficient permissions to invoke the
519
577
  # action, or the parameter values fall outside the specified
520
578
  # constraints, the action fails. The associated event attribute's
521
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
522
- # details and example IAM policies, see [Using IAM to Manage Access to
523
- # Amazon SWF Workflows][1].
579
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
580
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
581
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
524
582
  #
525
583
  #
526
584
  #
@@ -556,9 +614,12 @@ module Aws::SWF
556
614
  # types. However, you can still use visibility actions on this domain.
557
615
  # Deprecating a domain also deprecates all activity and workflow types
558
616
  # registered in the domain. Executions that were started before the
559
- # domain was deprecated will continue to run.
617
+ # domain was deprecated continues to run.
560
618
  #
561
- # <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
619
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
620
+ # and may not exactly reflect recent updates and changes.
621
+ #
622
+ # </note>
562
623
  #
563
624
  # **Access Control**
564
625
  #
@@ -567,16 +628,18 @@ module Aws::SWF
567
628
  #
568
629
  # * Use a `Resource` element with the domain name to limit the action to
569
630
  # only specified domains.
631
+ #
570
632
  # * Use an `Action` element to allow or deny permission to call this
571
633
  # action.
634
+ #
572
635
  # * You cannot use an IAM policy to constrain this action's parameters.
573
636
  #
574
- # If the caller does not have sufficient permissions to invoke the
637
+ # If the caller doesn't have sufficient permissions to invoke the
575
638
  # action, or the parameter values fall outside the specified
576
639
  # constraints, the action fails. The associated event attribute's
577
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
578
- # details and example IAM policies, see [Using IAM to Manage Access to
579
- # Amazon SWF Workflows][1].
640
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
641
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
642
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
580
643
  #
581
644
  #
582
645
  #
@@ -602,11 +665,14 @@ module Aws::SWF
602
665
 
603
666
  # Deprecates the specified *workflow type*. After a workflow type has
604
667
  # been deprecated, you cannot create new executions of that type.
605
- # Executions that were started before the type was deprecated will
606
- # continue to run. A deprecated workflow type may still be used when
607
- # calling visibility actions.
668
+ # Executions that were started before the type was deprecated continues
669
+ # to run. A deprecated workflow type may still be used when calling
670
+ # visibility actions.
671
+ #
672
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
673
+ # and may not exactly reflect recent updates and changes.
608
674
  #
609
- # <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
675
+ # </note>
610
676
  #
611
677
  # **Access Control**
612
678
  #
@@ -615,21 +681,25 @@ module Aws::SWF
615
681
  #
616
682
  # * Use a `Resource` element with the domain name to limit the action to
617
683
  # only specified domains.
684
+ #
618
685
  # * Use an `Action` element to allow or deny permission to call this
619
686
  # action.
687
+ #
620
688
  # * Constrain the following parameters by using a `Condition` element
621
689
  # with the appropriate keys.
690
+ #
622
691
  # * `workflowType.name`\: String constraint. The key is
623
692
  # `swf:workflowType.name`.
693
+ #
624
694
  # * `workflowType.version`\: String constraint. The key is
625
695
  # `swf:workflowType.version`.
626
696
  #
627
- # If the caller does not have sufficient permissions to invoke the
697
+ # If the caller doesn't have sufficient permissions to invoke the
628
698
  # action, or the parameter values fall outside the specified
629
699
  # constraints, the action fails. The associated event attribute's
630
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
631
- # details and example IAM policies, see [Using IAM to Manage Access to
632
- # Amazon SWF Workflows][1].
700
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
701
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
702
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
633
703
  #
634
704
  #
635
705
  #
@@ -671,21 +741,25 @@ module Aws::SWF
671
741
  #
672
742
  # * Use a `Resource` element with the domain name to limit the action to
673
743
  # only specified domains.
744
+ #
674
745
  # * Use an `Action` element to allow or deny permission to call this
675
746
  # action.
747
+ #
676
748
  # * Constrain the following parameters by using a `Condition` element
677
749
  # with the appropriate keys.
750
+ #
678
751
  # * `activityType.name`\: String constraint. The key is
679
752
  # `swf:activityType.name`.
753
+ #
680
754
  # * `activityType.version`\: String constraint. The key is
681
755
  # `swf:activityType.version`.
682
756
  #
683
- # If the caller does not have sufficient permissions to invoke the
757
+ # If the caller doesn't have sufficient permissions to invoke the
684
758
  # action, or the parameter values fall outside the specified
685
759
  # constraints, the action fails. The associated event attribute's
686
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
687
- # details and example IAM policies, see [Using IAM to Manage Access to
688
- # Amazon SWF Workflows][1].
760
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
761
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
762
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
689
763
  #
690
764
  #
691
765
  #
@@ -746,16 +820,18 @@ module Aws::SWF
746
820
  #
747
821
  # * Use a `Resource` element with the domain name to limit the action to
748
822
  # only specified domains.
823
+ #
749
824
  # * Use an `Action` element to allow or deny permission to call this
750
825
  # action.
826
+ #
751
827
  # * You cannot use an IAM policy to constrain this action's parameters.
752
828
  #
753
- # If the caller does not have sufficient permissions to invoke the
829
+ # If the caller doesn't have sufficient permissions to invoke the
754
830
  # action, or the parameter values fall outside the specified
755
831
  # constraints, the action fails. The associated event attribute's
756
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
757
- # details and example IAM policies, see [Using IAM to Manage Access to
758
- # Amazon SWF Workflows][1].
832
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
833
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
834
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
759
835
  #
760
836
  #
761
837
  #
@@ -792,7 +868,10 @@ module Aws::SWF
792
868
  # Returns information about the specified workflow execution including
793
869
  # its type and some statistics.
794
870
  #
795
- # <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
871
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
872
+ # and may not exactly reflect recent updates and changes.
873
+ #
874
+ # </note>
796
875
  #
797
876
  # **Access Control**
798
877
  #
@@ -801,16 +880,18 @@ module Aws::SWF
801
880
  #
802
881
  # * Use a `Resource` element with the domain name to limit the action to
803
882
  # only specified domains.
883
+ #
804
884
  # * Use an `Action` element to allow or deny permission to call this
805
885
  # action.
886
+ #
806
887
  # * You cannot use an IAM policy to constrain this action's parameters.
807
888
  #
808
- # If the caller does not have sufficient permissions to invoke the
889
+ # If the caller doesn't have sufficient permissions to invoke the
809
890
  # action, or the parameter values fall outside the specified
810
891
  # constraints, the action fails. The associated event attribute's
811
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
812
- # details and example IAM policies, see [Using IAM to Manage Access to
813
- # Amazon SWF Workflows][1].
892
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
893
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
894
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
814
895
  #
815
896
  #
816
897
  #
@@ -836,7 +917,7 @@ module Aws::SWF
836
917
  # domain: "DomainName", # required
837
918
  # execution: { # required
838
919
  # workflow_id: "WorkflowId", # required
839
- # run_id: "RunId", # required
920
+ # run_id: "WorkflowRunId", # required
840
921
  # },
841
922
  # })
842
923
  #
@@ -878,7 +959,7 @@ module Aws::SWF
878
959
 
879
960
  # Returns information about the specified *workflow type*. This includes
880
961
  # configuration settings specified when the type was registered and
881
- # other information such as creation date, current status, and so on.
962
+ # other information such as creation date, current status, etc.
882
963
  #
883
964
  # **Access Control**
884
965
  #
@@ -887,21 +968,25 @@ module Aws::SWF
887
968
  #
888
969
  # * Use a `Resource` element with the domain name to limit the action to
889
970
  # only specified domains.
971
+ #
890
972
  # * Use an `Action` element to allow or deny permission to call this
891
973
  # action.
974
+ #
892
975
  # * Constrain the following parameters by using a `Condition` element
893
976
  # with the appropriate keys.
977
+ #
894
978
  # * `workflowType.name`\: String constraint. The key is
895
979
  # `swf:workflowType.name`.
980
+ #
896
981
  # * `workflowType.version`\: String constraint. The key is
897
982
  # `swf:workflowType.version`.
898
983
  #
899
- # If the caller does not have sufficient permissions to invoke the
984
+ # If the caller doesn't have sufficient permissions to invoke the
900
985
  # action, or the parameter values fall outside the specified
901
986
  # constraints, the action fails. The associated event attribute's
902
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
903
- # details and example IAM policies, see [Using IAM to Manage Access to
904
- # Amazon SWF Workflows][1].
987
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
988
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
989
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
905
990
  #
906
991
  #
907
992
  #
@@ -954,7 +1039,10 @@ module Aws::SWF
954
1039
  # may be split into multiple pages. To retrieve subsequent pages, make
955
1040
  # the call again using the `nextPageToken` returned by the initial call.
956
1041
  #
957
- # <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
1042
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
1043
+ # and may not exactly reflect recent updates and changes.
1044
+ #
1045
+ # </note>
958
1046
  #
959
1047
  # **Access Control**
960
1048
  #
@@ -963,16 +1051,18 @@ module Aws::SWF
963
1051
  #
964
1052
  # * Use a `Resource` element with the domain name to limit the action to
965
1053
  # only specified domains.
1054
+ #
966
1055
  # * Use an `Action` element to allow or deny permission to call this
967
1056
  # action.
1057
+ #
968
1058
  # * You cannot use an IAM policy to constrain this action's parameters.
969
1059
  #
970
- # If the caller does not have sufficient permissions to invoke the
1060
+ # If the caller doesn't have sufficient permissions to invoke the
971
1061
  # action, or the parameter values fall outside the specified
972
1062
  # constraints, the action fails. The associated event attribute's
973
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
974
- # details and example IAM policies, see [Using IAM to Manage Access to
975
- # Amazon SWF Workflows][1].
1063
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
1064
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
1065
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
976
1066
  #
977
1067
  #
978
1068
  #
@@ -994,7 +1084,7 @@ module Aws::SWF
994
1084
  # returned in a single call.
995
1085
  #
996
1086
  # @option params [Integer] :maximum_page_size
997
- # The maximum number of results that will be returned per call.
1087
+ # The maximum number of results that are returned per call.
998
1088
  # `nextPageToken` can be used to obtain futher pages of results. The
999
1089
  # default is 1000, which is the maximum allowed page size. You can,
1000
1090
  # however, specify a page size *smaller* than the maximum.
@@ -1018,7 +1108,7 @@ module Aws::SWF
1018
1108
  # domain: "DomainName", # required
1019
1109
  # execution: { # required
1020
1110
  # workflow_id: "WorkflowId", # required
1021
- # run_id: "RunId", # required
1111
+ # run_id: "WorkflowRunId", # required
1022
1112
  # },
1023
1113
  # next_page_token: "PageToken",
1024
1114
  # maximum_page_size: 1,
@@ -1036,11 +1126,11 @@ module Aws::SWF
1036
1126
  # resp.events[0].workflow_execution_started_event_attributes.task_start_to_close_timeout #=> String
1037
1127
  # resp.events[0].workflow_execution_started_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
1038
1128
  # resp.events[0].workflow_execution_started_event_attributes.task_list.name #=> String
1129
+ # resp.events[0].workflow_execution_started_event_attributes.task_priority #=> String
1039
1130
  # resp.events[0].workflow_execution_started_event_attributes.workflow_type.name #=> String
1040
1131
  # resp.events[0].workflow_execution_started_event_attributes.workflow_type.version #=> String
1041
1132
  # resp.events[0].workflow_execution_started_event_attributes.tag_list #=> Array
1042
1133
  # resp.events[0].workflow_execution_started_event_attributes.tag_list[0] #=> String
1043
- # resp.events[0].workflow_execution_started_event_attributes.task_priority #=> String
1044
1134
  # resp.events[0].workflow_execution_started_event_attributes.continued_execution_run_id #=> String
1045
1135
  # resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.workflow_id #=> String
1046
1136
  # resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.run_id #=> String
@@ -1251,6 +1341,7 @@ module Aws::SWF
1251
1341
  # resp.events[0].start_child_workflow_execution_failed_event_attributes.control #=> String
1252
1342
  # resp.events[0].lambda_function_scheduled_event_attributes.id #=> String
1253
1343
  # resp.events[0].lambda_function_scheduled_event_attributes.name #=> String
1344
+ # resp.events[0].lambda_function_scheduled_event_attributes.control #=> String
1254
1345
  # resp.events[0].lambda_function_scheduled_event_attributes.input #=> String
1255
1346
  # resp.events[0].lambda_function_scheduled_event_attributes.start_to_close_timeout #=> String
1256
1347
  # resp.events[0].lambda_function_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
@@ -1295,16 +1386,18 @@ module Aws::SWF
1295
1386
  #
1296
1387
  # * Use a `Resource` element with the domain name to limit the action to
1297
1388
  # only specified domains.
1389
+ #
1298
1390
  # * Use an `Action` element to allow or deny permission to call this
1299
1391
  # action.
1392
+ #
1300
1393
  # * You cannot use an IAM policy to constrain this action's parameters.
1301
1394
  #
1302
- # If the caller does not have sufficient permissions to invoke the
1395
+ # If the caller doesn't have sufficient permissions to invoke the
1303
1396
  # action, or the parameter values fall outside the specified
1304
1397
  # constraints, the action fails. The associated event attribute's
1305
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
1306
- # details and example IAM policies, see [Using IAM to Manage Access to
1307
- # Amazon SWF Workflows][1].
1398
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
1399
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
1400
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
1308
1401
  #
1309
1402
  #
1310
1403
  #
@@ -1330,7 +1423,7 @@ module Aws::SWF
1330
1423
  # returned in a single call.
1331
1424
  #
1332
1425
  # @option params [Integer] :maximum_page_size
1333
- # The maximum number of results that will be returned per call.
1426
+ # The maximum number of results that are returned per call.
1334
1427
  # `nextPageToken` can be used to obtain futher pages of results. The
1335
1428
  # default is 1000, which is the maximum allowed page size. You can,
1336
1429
  # however, specify a page size *smaller* than the maximum.
@@ -1382,7 +1475,10 @@ module Aws::SWF
1382
1475
  # multiple pages. To retrieve subsequent pages, make the call again
1383
1476
  # using the nextPageToken returned by the initial call.
1384
1477
  #
1385
- # <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
1478
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
1479
+ # and may not exactly reflect recent updates and changes.
1480
+ #
1481
+ # </note>
1386
1482
  #
1387
1483
  # **Access Control**
1388
1484
  #
@@ -1391,23 +1487,28 @@ module Aws::SWF
1391
1487
  #
1392
1488
  # * Use a `Resource` element with the domain name to limit the action to
1393
1489
  # only specified domains.
1490
+ #
1394
1491
  # * Use an `Action` element to allow or deny permission to call this
1395
1492
  # action.
1493
+ #
1396
1494
  # * Constrain the following parameters by using a `Condition` element
1397
1495
  # with the appropriate keys.
1496
+ #
1398
1497
  # * `tagFilter.tag`\: String constraint. The key is
1399
1498
  # `swf:tagFilter.tag`.
1499
+ #
1400
1500
  # * `typeFilter.name`\: String constraint. The key is
1401
1501
  # `swf:typeFilter.name`.
1502
+ #
1402
1503
  # * `typeFilter.version`\: String constraint. The key is
1403
1504
  # `swf:typeFilter.version`.
1404
1505
  #
1405
- # If the caller does not have sufficient permissions to invoke the
1506
+ # If the caller doesn't have sufficient permissions to invoke the
1406
1507
  # action, or the parameter values fall outside the specified
1407
1508
  # constraints, the action fails. The associated event attribute's
1408
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
1409
- # details and example IAM policies, see [Using IAM to Manage Access to
1410
- # Amazon SWF Workflows][1].
1509
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
1510
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
1511
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
1411
1512
  #
1412
1513
  #
1413
1514
  #
@@ -1422,7 +1523,10 @@ module Aws::SWF
1422
1523
  # specified by this filter. Also, if this parameter is specified, the
1423
1524
  # returned results are ordered by their start times.
1424
1525
  #
1425
- # <note>`startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.</note>
1526
+ # <note markdown="1"> `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You
1527
+ # must specify one of these in a request but not both.
1528
+ #
1529
+ # </note>
1426
1530
  #
1427
1531
  # @option params [Types::ExecutionTimeFilter] :close_time_filter
1428
1532
  # If specified, the workflow executions are included in the returned
@@ -1430,31 +1534,50 @@ module Aws::SWF
1430
1534
  # specified by this filter. Also, if this parameter is specified, the
1431
1535
  # returned results are ordered by their close times.
1432
1536
  #
1433
- # <note>`startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.</note>
1537
+ # <note markdown="1"> `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You
1538
+ # must specify one of these in a request but not both.
1539
+ #
1540
+ # </note>
1434
1541
  #
1435
1542
  # @option params [Types::WorkflowExecutionFilter] :execution_filter
1436
1543
  # If specified, only workflow executions matching the workflow ID
1437
1544
  # specified in the filter are returned.
1438
1545
  #
1439
- # <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
1546
+ # <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter`
1547
+ # are mutually exclusive. You can specify at most one of these in a
1548
+ # request.
1549
+ #
1550
+ # </note>
1440
1551
  #
1441
1552
  # @option params [Types::CloseStatusFilter] :close_status_filter
1442
1553
  # If specified, only workflow executions that match this *close status*
1443
1554
  # are listed. For example, if TERMINATED is specified, then only
1444
1555
  # TERMINATED workflow executions are listed.
1445
1556
  #
1446
- # <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
1557
+ # <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter`
1558
+ # are mutually exclusive. You can specify at most one of these in a
1559
+ # request.
1560
+ #
1561
+ # </note>
1447
1562
  #
1448
1563
  # @option params [Types::WorkflowTypeFilter] :type_filter
1449
1564
  # If specified, only executions of the type specified in the filter are
1450
1565
  # returned.
1451
1566
  #
1452
- # <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
1567
+ # <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter`
1568
+ # are mutually exclusive. You can specify at most one of these in a
1569
+ # request.
1570
+ #
1571
+ # </note>
1453
1572
  #
1454
1573
  # @option params [Types::TagFilter] :tag_filter
1455
1574
  # If specified, only executions that have the matching tag are listed.
1456
1575
  #
1457
- # <note>`closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
1576
+ # <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter`
1577
+ # are mutually exclusive. You can specify at most one of these in a
1578
+ # request.
1579
+ #
1580
+ # </note>
1458
1581
  #
1459
1582
  # @option params [String] :next_page_token
1460
1583
  # If a `NextPageToken` was returned by a previous call, there are more
@@ -1466,7 +1589,7 @@ module Aws::SWF
1466
1589
  # returned in a single call.
1467
1590
  #
1468
1591
  # @option params [Integer] :maximum_page_size
1469
- # The maximum number of results that will be returned per call.
1592
+ # The maximum number of results that are returned per call.
1470
1593
  # `nextPageToken` can be used to obtain futher pages of results. The
1471
1594
  # default is 1000, which is the maximum allowed page size. You can,
1472
1595
  # however, specify a page size *smaller* than the maximum.
@@ -1543,7 +1666,10 @@ module Aws::SWF
1543
1666
  # be split into multiple pages. To retrieve subsequent pages, make the
1544
1667
  # call again using the nextPageToken returned by the initial call.
1545
1668
  #
1546
- # <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
1669
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
1670
+ # and may not exactly reflect recent updates and changes.
1671
+ #
1672
+ # </note>
1547
1673
  #
1548
1674
  # **Access Control**
1549
1675
  #
@@ -1554,16 +1680,18 @@ module Aws::SWF
1554
1680
  # only specified domains. The element must be set to
1555
1681
  # `arn:aws:swf::AccountID:domain/*`, where *AccountID* is the account
1556
1682
  # ID, with no dashes.
1683
+ #
1557
1684
  # * Use an `Action` element to allow or deny permission to call this
1558
1685
  # action.
1686
+ #
1559
1687
  # * You cannot use an IAM policy to constrain this action's parameters.
1560
1688
  #
1561
- # If the caller does not have sufficient permissions to invoke the
1689
+ # If the caller doesn't have sufficient permissions to invoke the
1562
1690
  # action, or the parameter values fall outside the specified
1563
1691
  # constraints, the action fails. The associated event attribute's
1564
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
1565
- # details and example IAM policies, see [Using IAM to Manage Access to
1566
- # Amazon SWF Workflows][1].
1692
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
1693
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
1694
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
1567
1695
  #
1568
1696
  #
1569
1697
  #
@@ -1582,7 +1710,7 @@ module Aws::SWF
1582
1710
  # Specifies the registration status of the domains to list.
1583
1711
  #
1584
1712
  # @option params [Integer] :maximum_page_size
1585
- # The maximum number of results that will be returned per call.
1713
+ # The maximum number of results that are returned per call.
1586
1714
  # `nextPageToken` can be used to obtain futher pages of results. The
1587
1715
  # default is 1000, which is the maximum allowed page size. You can,
1588
1716
  # however, specify a page size *smaller* than the maximum.
@@ -1629,7 +1757,10 @@ module Aws::SWF
1629
1757
  # multiple pages. To retrieve subsequent pages, make the call again
1630
1758
  # using the nextPageToken returned by the initial call.
1631
1759
  #
1632
- # <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note>
1760
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
1761
+ # and may not exactly reflect recent updates and changes.
1762
+ #
1763
+ # </note>
1633
1764
  #
1634
1765
  # **Access Control**
1635
1766
  #
@@ -1638,23 +1769,28 @@ module Aws::SWF
1638
1769
  #
1639
1770
  # * Use a `Resource` element with the domain name to limit the action to
1640
1771
  # only specified domains.
1772
+ #
1641
1773
  # * Use an `Action` element to allow or deny permission to call this
1642
1774
  # action.
1775
+ #
1643
1776
  # * Constrain the following parameters by using a `Condition` element
1644
1777
  # with the appropriate keys.
1778
+ #
1645
1779
  # * `tagFilter.tag`\: String constraint. The key is
1646
1780
  # `swf:tagFilter.tag`.
1781
+ #
1647
1782
  # * `typeFilter.name`\: String constraint. The key is
1648
1783
  # `swf:typeFilter.name`.
1784
+ #
1649
1785
  # * `typeFilter.version`\: String constraint. The key is
1650
1786
  # `swf:typeFilter.version`.
1651
1787
  #
1652
- # If the caller does not have sufficient permissions to invoke the
1788
+ # If the caller doesn't have sufficient permissions to invoke the
1653
1789
  # action, or the parameter values fall outside the specified
1654
1790
  # constraints, the action fails. The associated event attribute's
1655
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
1656
- # details and example IAM policies, see [Using IAM to Manage Access to
1657
- # Amazon SWF Workflows][1].
1791
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
1792
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
1793
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
1658
1794
  #
1659
1795
  #
1660
1796
  #
@@ -1672,12 +1808,18 @@ module Aws::SWF
1672
1808
  # If specified, only executions of the type specified in the filter are
1673
1809
  # returned.
1674
1810
  #
1675
- # <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
1811
+ # <note markdown="1"> `executionFilter`, `typeFilter` and `tagFilter` are mutually
1812
+ # exclusive. You can specify at most one of these in a request.
1813
+ #
1814
+ # </note>
1676
1815
  #
1677
1816
  # @option params [Types::TagFilter] :tag_filter
1678
1817
  # If specified, only executions that have the matching tag are listed.
1679
1818
  #
1680
- # <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
1819
+ # <note markdown="1"> `executionFilter`, `typeFilter` and `tagFilter` are mutually
1820
+ # exclusive. You can specify at most one of these in a request.
1821
+ #
1822
+ # </note>
1681
1823
  #
1682
1824
  # @option params [String] :next_page_token
1683
1825
  # If a `NextPageToken` was returned by a previous call, there are more
@@ -1689,7 +1831,7 @@ module Aws::SWF
1689
1831
  # returned in a single call.
1690
1832
  #
1691
1833
  # @option params [Integer] :maximum_page_size
1692
- # The maximum number of results that will be returned per call.
1834
+ # The maximum number of results that are returned per call.
1693
1835
  # `nextPageToken` can be used to obtain futher pages of results. The
1694
1836
  # default is 1000, which is the maximum allowed page size. You can,
1695
1837
  # however, specify a page size *smaller* than the maximum.
@@ -1706,7 +1848,10 @@ module Aws::SWF
1706
1848
  # If specified, only workflow executions matching the workflow ID
1707
1849
  # specified in the filter are returned.
1708
1850
  #
1709
- # <note>`executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.</note>
1851
+ # <note markdown="1"> `executionFilter`, `typeFilter` and `tagFilter` are mutually
1852
+ # exclusive. You can specify at most one of these in a request.
1853
+ #
1854
+ # </note>
1710
1855
  #
1711
1856
  # @return [Types::WorkflowExecutionInfos] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1712
1857
  #
@@ -1772,16 +1917,18 @@ module Aws::SWF
1772
1917
  #
1773
1918
  # * Use a `Resource` element with the domain name to limit the action to
1774
1919
  # only specified domains.
1920
+ #
1775
1921
  # * Use an `Action` element to allow or deny permission to call this
1776
1922
  # action.
1923
+ #
1777
1924
  # * You cannot use an IAM policy to constrain this action's parameters.
1778
1925
  #
1779
- # If the caller does not have sufficient permissions to invoke the
1926
+ # If the caller doesn't have sufficient permissions to invoke the
1780
1927
  # action, or the parameter values fall outside the specified
1781
1928
  # constraints, the action fails. The associated event attribute's
1782
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
1783
- # details and example IAM policies, see [Using IAM to Manage Access to
1784
- # Amazon SWF Workflows][1].
1929
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
1930
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
1931
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
1785
1932
  #
1786
1933
  #
1787
1934
  #
@@ -1807,7 +1954,7 @@ module Aws::SWF
1807
1954
  # returned in a single call.
1808
1955
  #
1809
1956
  # @option params [Integer] :maximum_page_size
1810
- # The maximum number of results that will be returned per call.
1957
+ # The maximum number of results that are returned per call.
1811
1958
  # `nextPageToken` can be used to obtain futher pages of results. The
1812
1959
  # default is 1000, which is the maximum allowed page size. You can,
1813
1960
  # however, specify a page size *smaller* than the maximum.
@@ -1859,10 +2006,10 @@ module Aws::SWF
1859
2006
  # HTTP connection open and responds as soon as a task becomes available.
1860
2007
  # The maximum time the service holds on to the request before responding
1861
2008
  # is 60 seconds. If no task is available within 60 seconds, the poll
1862
- # will return an empty result. An empty result, in this context, means
1863
- # that an ActivityTask is returned, but that the value of taskToken is
1864
- # an empty string. If a task is returned, the worker should use its type
1865
- # to identify and process it correctly.
2009
+ # returns an empty result. An empty result, in this context, means that
2010
+ # an ActivityTask is returned, but that the value of taskToken is an
2011
+ # empty string. If a task is returned, the worker should use its type to
2012
+ # identify and process it correctly.
1866
2013
  #
1867
2014
  # Workers should set their client side socket timeout to at least 70
1868
2015
  # seconds (10 seconds higher than the maximum time service may hold the
@@ -1875,18 +2022,20 @@ module Aws::SWF
1875
2022
  #
1876
2023
  # * Use a `Resource` element with the domain name to limit the action to
1877
2024
  # only specified domains.
2025
+ #
1878
2026
  # * Use an `Action` element to allow or deny permission to call this
1879
2027
  # action.
1880
- # * Constrain the `taskList.name` parameter by using a **Condition**
2028
+ #
2029
+ # * Constrain the `taskList.name` parameter by using a `Condition`
1881
2030
  # element with the `swf:taskList.name` key to allow the action to
1882
2031
  # access only certain task lists.
1883
2032
  #
1884
- # If the caller does not have sufficient permissions to invoke the
2033
+ # If the caller doesn't have sufficient permissions to invoke the
1885
2034
  # action, or the parameter values fall outside the specified
1886
2035
  # constraints, the action fails. The associated event attribute's
1887
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
1888
- # details and example IAM policies, see [Using IAM to Manage Access to
1889
- # Amazon SWF Workflows][1].
2036
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
2037
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
2038
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
1890
2039
  #
1891
2040
  #
1892
2041
  #
@@ -1900,8 +2049,8 @@ module Aws::SWF
1900
2049
  #
1901
2050
  # The specified string must not start or end with whitespace. It must
1902
2051
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
1903
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
1904
- # must not contain the literal string quotarnquot.
2052
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
2053
+ # not contain the literal string `arn`.
1905
2054
  #
1906
2055
  # @option params [String] :identity
1907
2056
  # Identity of the worker making the request, recorded in the
@@ -1958,16 +2107,16 @@ module Aws::SWF
1958
2107
  # decision task is available in the specified task list before the
1959
2108
  # timeout of 60 seconds expires, an empty result is returned. An empty
1960
2109
  # result, in this context, means that a DecisionTask is returned, but
1961
- # that the value of `taskToken` is an empty string.
2110
+ # that the value of taskToken is an empty string.
1962
2111
  #
1963
- # Deciders should set their client-side socket timeout to at least 70
2112
+ # Deciders should set their client side socket timeout to at least 70
1964
2113
  # seconds (10 seconds higher than the timeout).
1965
2114
  #
1966
2115
  # Because the number of workflow history events for a single workflow
1967
2116
  # execution might be very large, the result returned might be split up
1968
2117
  # across a number of pages. To retrieve subsequent pages, make
1969
2118
  # additional calls to `PollForDecisionTask` using the `nextPageToken`
1970
- # returned by the initial call. Note that you do **not** call
2119
+ # returned by the initial call. Note that you do *not* call
1971
2120
  # `GetWorkflowExecutionHistory` with this `nextPageToken`. Instead, call
1972
2121
  # `PollForDecisionTask` again.
1973
2122
  #
@@ -1978,18 +2127,20 @@ module Aws::SWF
1978
2127
  #
1979
2128
  # * Use a `Resource` element with the domain name to limit the action to
1980
2129
  # only specified domains.
2130
+ #
1981
2131
  # * Use an `Action` element to allow or deny permission to call this
1982
2132
  # action.
1983
- # * Constrain the `taskList.name` parameter by using a **Condition**
2133
+ #
2134
+ # * Constrain the `taskList.name` parameter by using a `Condition`
1984
2135
  # element with the `swf:taskList.name` key to allow the action to
1985
2136
  # access only certain task lists.
1986
2137
  #
1987
- # If the caller does not have sufficient permissions to invoke the
2138
+ # If the caller doesn't have sufficient permissions to invoke the
1988
2139
  # action, or the parameter values fall outside the specified
1989
2140
  # constraints, the action fails. The associated event attribute's
1990
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
1991
- # details and example IAM policies, see [Using IAM to Manage Access to
1992
- # Amazon SWF Workflows][1].
2141
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
2142
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
2143
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
1993
2144
  #
1994
2145
  #
1995
2146
  #
@@ -2003,8 +2154,8 @@ module Aws::SWF
2003
2154
  #
2004
2155
  # The specified string must not start or end with whitespace. It must
2005
2156
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
2006
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
2007
- # must not contain the literal string quotarnquot.
2157
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
2158
+ # not contain the literal string `arn`.
2008
2159
  #
2009
2160
  # @option params [String] :identity
2010
2161
  # Identity of the decider making the request, which is recorded in the
@@ -2021,12 +2172,16 @@ module Aws::SWF
2021
2172
  # The configured `maximumPageSize` determines how many results can be
2022
2173
  # returned in a single call.
2023
2174
  #
2024
- # <note>The `nextPageToken` returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the `nextPageToken`) to retrieve the next page of history records. Calling PollForDecisionTask with a `nextPageToken` will not return a new decision task.</note>
2175
+ # <note markdown="1"> The `nextPageToken` returned by this action cannot be used with
2176
+ # GetWorkflowExecutionHistory to get the next page. You must call
2177
+ # PollForDecisionTask again (with the `nextPageToken`) to retrieve the
2178
+ # next page of history records. Calling PollForDecisionTask with a
2179
+ # `nextPageToken` doesn't return a new decision task.
2025
2180
  #
2026
- # .
2181
+ # </note>
2027
2182
  #
2028
2183
  # @option params [Integer] :maximum_page_size
2029
- # The maximum number of results that will be returned per call.
2184
+ # The maximum number of results that are returned per call.
2030
2185
  # `nextPageToken` can be used to obtain futher pages of results. The
2031
2186
  # default is 1000, which is the maximum allowed page size. You can,
2032
2187
  # however, specify a page size *smaller* than the maximum.
@@ -2079,11 +2234,11 @@ module Aws::SWF
2079
2234
  # resp.events[0].workflow_execution_started_event_attributes.task_start_to_close_timeout #=> String
2080
2235
  # resp.events[0].workflow_execution_started_event_attributes.child_policy #=> String, one of "TERMINATE", "REQUEST_CANCEL", "ABANDON"
2081
2236
  # resp.events[0].workflow_execution_started_event_attributes.task_list.name #=> String
2237
+ # resp.events[0].workflow_execution_started_event_attributes.task_priority #=> String
2082
2238
  # resp.events[0].workflow_execution_started_event_attributes.workflow_type.name #=> String
2083
2239
  # resp.events[0].workflow_execution_started_event_attributes.workflow_type.version #=> String
2084
2240
  # resp.events[0].workflow_execution_started_event_attributes.tag_list #=> Array
2085
2241
  # resp.events[0].workflow_execution_started_event_attributes.tag_list[0] #=> String
2086
- # resp.events[0].workflow_execution_started_event_attributes.task_priority #=> String
2087
2242
  # resp.events[0].workflow_execution_started_event_attributes.continued_execution_run_id #=> String
2088
2243
  # resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.workflow_id #=> String
2089
2244
  # resp.events[0].workflow_execution_started_event_attributes.parent_workflow_execution.run_id #=> String
@@ -2294,6 +2449,7 @@ module Aws::SWF
2294
2449
  # resp.events[0].start_child_workflow_execution_failed_event_attributes.control #=> String
2295
2450
  # resp.events[0].lambda_function_scheduled_event_attributes.id #=> String
2296
2451
  # resp.events[0].lambda_function_scheduled_event_attributes.name #=> String
2452
+ # resp.events[0].lambda_function_scheduled_event_attributes.control #=> String
2297
2453
  # resp.events[0].lambda_function_scheduled_event_attributes.input #=> String
2298
2454
  # resp.events[0].lambda_function_scheduled_event_attributes.start_to_close_timeout #=> String
2299
2455
  # resp.events[0].lambda_function_scheduled_event_attributes.decision_task_completed_event_id #=> Integer
@@ -2327,26 +2483,34 @@ module Aws::SWF
2327
2483
 
2328
2484
  # Used by activity workers to report to the service that the
2329
2485
  # ActivityTask represented by the specified `taskToken` is still making
2330
- # progress. The worker can also (optionally) specify details of the
2331
- # progress, for example percent complete, using the `details` parameter.
2332
- # This action can also be used by the worker as a mechanism to check if
2333
- # cancellation is being requested for the activity task. If a
2334
- # cancellation is being attempted for the specified task, then the
2335
- # boolean `cancelRequested` flag returned by the service is set to
2336
- # `true`.
2486
+ # progress. The worker can also specify details of the progress, for
2487
+ # example percent complete, using the `details` parameter. This action
2488
+ # can also be used by the worker as a mechanism to check if cancellation
2489
+ # is being requested for the activity task. If a cancellation is being
2490
+ # attempted for the specified task, then the boolean `cancelRequested`
2491
+ # flag returned by the service is set to `true`.
2337
2492
  #
2338
2493
  # This action resets the `taskHeartbeatTimeout` clock. The
2339
2494
  # `taskHeartbeatTimeout` is specified in RegisterActivityType.
2340
2495
  #
2341
- # This action does not in itself create an event in the workflow
2496
+ # This action doesn't in itself create an event in the workflow
2342
2497
  # execution history. However, if the task times out, the workflow
2343
- # execution history will contain a `ActivityTaskTimedOut` event that
2498
+ # execution history contains a `ActivityTaskTimedOut` event that
2344
2499
  # contains the information from the last heartbeat generated by the
2345
2500
  # activity worker.
2346
2501
  #
2347
- # <note>The `taskStartToCloseTimeout` of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The `taskStartToCloseTimeout` is also specified in RegisterActivityType.</note>
2502
+ # <note markdown="1"> The `taskStartToCloseTimeout` of an activity type is the maximum
2503
+ # duration of an activity task, regardless of the number of
2504
+ # RecordActivityTaskHeartbeat requests received. The
2505
+ # `taskStartToCloseTimeout` is also specified in RegisterActivityType.
2506
+ #
2507
+ # </note>
2508
+ #
2509
+ # <note markdown="1"> This operation is only useful for long-lived activities to report
2510
+ # liveliness of the task and to determine if a cancellation is being
2511
+ # attempted.
2348
2512
  #
2349
- # <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>
2513
+ # </note>
2350
2514
  #
2351
2515
  # If the `cancelRequested` flag returns `true`, a cancellation is being
2352
2516
  # attempted. If the worker can cancel the activity, it should respond
@@ -2360,16 +2524,18 @@ module Aws::SWF
2360
2524
  #
2361
2525
  # * Use a `Resource` element with the domain name to limit the action to
2362
2526
  # only specified domains.
2527
+ #
2363
2528
  # * Use an `Action` element to allow or deny permission to call this
2364
2529
  # action.
2530
+ #
2365
2531
  # * You cannot use an IAM policy to constrain this action's parameters.
2366
2532
  #
2367
- # If the caller does not have sufficient permissions to invoke the
2533
+ # If the caller doesn't have sufficient permissions to invoke the
2368
2534
  # action, or the parameter values fall outside the specified
2369
2535
  # constraints, the action fails. The associated event attribute's
2370
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
2371
- # details and example IAM policies, see [Using IAM to Manage Access to
2372
- # Amazon SWF Workflows][1].
2536
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
2537
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
2538
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
2373
2539
  #
2374
2540
  #
2375
2541
  #
@@ -2422,21 +2588,26 @@ module Aws::SWF
2422
2588
  #
2423
2589
  # * Use a `Resource` element with the domain name to limit the action to
2424
2590
  # only specified domains.
2591
+ #
2425
2592
  # * Use an `Action` element to allow or deny permission to call this
2426
2593
  # action.
2594
+ #
2427
2595
  # * Constrain the following parameters by using a `Condition` element
2428
2596
  # with the appropriate keys.
2597
+ #
2429
2598
  # * `defaultTaskList.name`\: String constraint. The key is
2430
2599
  # `swf:defaultTaskList.name`.
2600
+ #
2431
2601
  # * `name`\: String constraint. The key is `swf:name`.
2602
+ #
2432
2603
  # * `version`\: String constraint. The key is `swf:version`.
2433
2604
  #
2434
- # If the caller does not have sufficient permissions to invoke the
2605
+ # If the caller doesn't have sufficient permissions to invoke the
2435
2606
  # action, or the parameter values fall outside the specified
2436
2607
  # constraints, the action fails. The associated event attribute's
2437
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
2438
- # details and example IAM policies, see [Using IAM to Manage Access to
2439
- # Amazon SWF Workflows][1].
2608
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
2609
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
2610
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
2440
2611
  #
2441
2612
  #
2442
2613
  #
@@ -2450,18 +2621,21 @@ module Aws::SWF
2450
2621
  #
2451
2622
  # The specified string must not start or end with whitespace. It must
2452
2623
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
2453
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
2454
- # must not contain the literal string quotarnquot.
2624
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
2625
+ # not contain the literal string `arn`.
2455
2626
  #
2456
2627
  # @option params [required, String] :version
2457
2628
  # The version of the activity type.
2458
2629
  #
2459
- # <note>The activity type consists of the name and version, the combination of which must be unique within the domain.</note>
2630
+ # <note markdown="1"> The activity type consists of the name and version, the combination of
2631
+ # which must be unique within the domain.
2632
+ #
2633
+ # </note>
2460
2634
  #
2461
2635
  # The specified string must not start or end with whitespace. It must
2462
2636
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
2463
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
2464
- # must not contain the literal string quotarnquot.
2637
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
2638
+ # not contain the literal string `arn`.
2465
2639
  #
2466
2640
  # @option params [String] :description
2467
2641
  # A textual description of the activity type.
@@ -2470,40 +2644,39 @@ module Aws::SWF
2470
2644
  # If set, specifies the default maximum duration that a worker can take
2471
2645
  # to process tasks of this activity type. This default can be overridden
2472
2646
  # when scheduling an activity task using the `ScheduleActivityTask`
2473
- # decision.
2647
+ # Decision.
2474
2648
  #
2475
- # The duration is specified in seconds; an integer greater than or equal
2476
- # to 0. The value "NONE" can be used to specify unlimited duration.
2649
+ # The duration is specified in seconds, an integer greater than or equal
2650
+ # to `0`. You can use `NONE` to specify unlimited duration.
2477
2651
  #
2478
2652
  # @option params [String] :default_task_heartbeat_timeout
2479
2653
  # If set, specifies the default maximum time before which a worker
2480
2654
  # processing a task of this type must report progress by calling
2481
2655
  # RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity
2482
2656
  # task is automatically timed out. This default can be overridden when
2483
- # scheduling an activity task using the `ScheduleActivityTask` decision.
2657
+ # scheduling an activity task using the `ScheduleActivityTask` Decision.
2484
2658
  # If the activity worker subsequently attempts to record a heartbeat or
2485
2659
  # returns a result, the activity worker receives an `UnknownResource`
2486
2660
  # fault. In this case, Amazon SWF no longer considers the activity task
2487
2661
  # to be valid; the activity worker should clean up the activity task.
2488
2662
  #
2489
- # The duration is specified in seconds; an integer greater than or equal
2490
- # to 0. The value "NONE" can be used to specify unlimited duration.
2663
+ # The duration is specified in seconds, an integer greater than or equal
2664
+ # to `0`. You can use `NONE` to specify unlimited duration.
2491
2665
  #
2492
2666
  # @option params [Types::TaskList] :default_task_list
2493
2667
  # If set, specifies the default task list to use for scheduling tasks of
2494
- # this activity type. This default task list is used if a task list is
2495
- # not provided when a task is scheduled through the
2496
- # `ScheduleActivityTask` decision.
2668
+ # this activity type. This default task list is used if a task list
2669
+ # isn't provided when a task is scheduled through the
2670
+ # `ScheduleActivityTask` Decision.
2497
2671
  #
2498
2672
  # @option params [String] :default_task_priority
2499
2673
  # The default task priority to assign to the activity type. If not
2500
- # assigned, then "0" will be used. Valid values are integers that
2501
- # range from Java's `Integer.MIN_VALUE` (-2147483648) to
2502
- # `Integer.MAX_VALUE` (2147483647). Higher numbers indicate higher
2503
- # priority.
2674
+ # assigned, then `0` is used. Valid values are integers that range from
2675
+ # Java's `Integer.MIN_VALUE` (-2147483648) to `Integer.MAX_VALUE`
2676
+ # (2147483647). Higher numbers indicate higher priority.
2504
2677
  #
2505
2678
  # For more information about setting task priority, see [Setting Task
2506
- # Priority][1] in the *Amazon Simple Workflow Developer Guide*.
2679
+ # Priority][1] in the *in the *Amazon SWF Developer Guide*.*.
2507
2680
  #
2508
2681
  #
2509
2682
  #
@@ -2513,18 +2686,18 @@ module Aws::SWF
2513
2686
  # If set, specifies the default maximum duration that a task of this
2514
2687
  # activity type can wait before being assigned to a worker. This default
2515
2688
  # can be overridden when scheduling an activity task using the
2516
- # `ScheduleActivityTask` decision.
2689
+ # `ScheduleActivityTask` Decision.
2517
2690
  #
2518
- # The duration is specified in seconds; an integer greater than or equal
2519
- # to 0. The value "NONE" can be used to specify unlimited duration.
2691
+ # The duration is specified in seconds, an integer greater than or equal
2692
+ # to `0`. You can use `NONE` to specify unlimited duration.
2520
2693
  #
2521
2694
  # @option params [String] :default_task_schedule_to_close_timeout
2522
2695
  # If set, specifies the default maximum duration for a task of this
2523
2696
  # activity type. This default can be overridden when scheduling an
2524
- # activity task using the `ScheduleActivityTask` decision.
2697
+ # activity task using the `ScheduleActivityTask` Decision.
2525
2698
  #
2526
- # The duration is specified in seconds; an integer greater than or equal
2527
- # to 0. The value "NONE" can be used to specify unlimited duration.
2699
+ # The duration is specified in seconds, an integer greater than or equal
2700
+ # to `0`. You can use `NONE` to specify unlimited duration.
2528
2701
  #
2529
2702
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2530
2703
  #
@@ -2562,16 +2735,18 @@ module Aws::SWF
2562
2735
  # * You cannot use an IAM policy to control domain access for this
2563
2736
  # action. The name of the domain being registered is available as the
2564
2737
  # resource of this action.
2738
+ #
2565
2739
  # * Use an `Action` element to allow or deny permission to call this
2566
2740
  # action.
2741
+ #
2567
2742
  # * You cannot use an IAM policy to constrain this action's parameters.
2568
2743
  #
2569
- # If the caller does not have sufficient permissions to invoke the
2744
+ # If the caller doesn't have sufficient permissions to invoke the
2570
2745
  # action, or the parameter values fall outside the specified
2571
2746
  # constraints, the action fails. The associated event attribute's
2572
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
2573
- # details and example IAM policies, see [Using IAM to Manage Access to
2574
- # Amazon SWF Workflows][1].
2747
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
2748
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
2749
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
2575
2750
  #
2576
2751
  #
2577
2752
  #
@@ -2583,8 +2758,8 @@ module Aws::SWF
2583
2758
  #
2584
2759
  # The specified string must not start or end with whitespace. It must
2585
2760
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
2586
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
2587
- # must not contain the literal string quotarnquot.
2761
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
2762
+ # not contain the literal string `arn`.
2588
2763
  #
2589
2764
  # @option params [String] :description
2590
2765
  # A text description of the domain.
@@ -2592,12 +2767,12 @@ module Aws::SWF
2592
2767
  # @option params [required, String] :workflow_execution_retention_period_in_days
2593
2768
  # The duration (in days) that records and histories of workflow
2594
2769
  # executions on the domain should be kept by the service. After the
2595
- # retention period, the workflow execution is not available in the
2770
+ # retention period, the workflow execution isn't available in the
2596
2771
  # results of visibility calls.
2597
2772
  #
2598
2773
  # If you pass the value `NONE` or `0` (zero), then the workflow
2599
- # execution history will not be retained. As soon as the workflow
2600
- # execution completes, the execution record and its history are deleted.
2774
+ # execution history isn't retained. As soon as the workflow execution
2775
+ # completes, the execution record and its history are deleted.
2601
2776
  #
2602
2777
  # The maximum workflow execution retention period is 90 days. For more
2603
2778
  # information about Amazon SWF service limits, see: [Amazon SWF Service
@@ -2641,21 +2816,26 @@ module Aws::SWF
2641
2816
  #
2642
2817
  # * Use a `Resource` element with the domain name to limit the action to
2643
2818
  # only specified domains.
2819
+ #
2644
2820
  # * Use an `Action` element to allow or deny permission to call this
2645
2821
  # action.
2822
+ #
2646
2823
  # * Constrain the following parameters by using a `Condition` element
2647
2824
  # with the appropriate keys.
2825
+ #
2648
2826
  # * `defaultTaskList.name`\: String constraint. The key is
2649
2827
  # `swf:defaultTaskList.name`.
2828
+ #
2650
2829
  # * `name`\: String constraint. The key is `swf:name`.
2830
+ #
2651
2831
  # * `version`\: String constraint. The key is `swf:version`.
2652
2832
  #
2653
- # If the caller does not have sufficient permissions to invoke the
2833
+ # If the caller doesn't have sufficient permissions to invoke the
2654
2834
  # action, or the parameter values fall outside the specified
2655
2835
  # constraints, the action fails. The associated event attribute's
2656
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
2657
- # details and example IAM policies, see [Using IAM to Manage Access to
2658
- # Amazon SWF Workflows][1].
2836
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
2837
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
2838
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
2659
2839
  #
2660
2840
  #
2661
2841
  #
@@ -2669,18 +2849,22 @@ module Aws::SWF
2669
2849
  #
2670
2850
  # The specified string must not start or end with whitespace. It must
2671
2851
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
2672
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
2673
- # must not contain the literal string quotarnquot.
2852
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
2853
+ # not contain the literal string `arn`.
2674
2854
  #
2675
2855
  # @option params [required, String] :version
2676
2856
  # The version of the workflow type.
2677
2857
  #
2678
- # <note>The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.</note>
2858
+ # <note markdown="1"> The workflow type consists of the name and version, the combination of
2859
+ # which must be unique within the domain. To get a list of all currently
2860
+ # registered workflow types, use the ListWorkflowTypes action.
2861
+ #
2862
+ # </note>
2679
2863
  #
2680
2864
  # The specified string must not start or end with whitespace. It must
2681
2865
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
2682
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
2683
- # must not contain the literal string quotarnquot.
2866
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
2867
+ # not contain the literal string `arn`.
2684
2868
  #
2685
2869
  # @option params [String] :description
2686
2870
  # Textual description of the workflow type.
@@ -2689,40 +2873,39 @@ module Aws::SWF
2689
2873
  # If set, specifies the default maximum duration of decision tasks for
2690
2874
  # this workflow type. This default can be overridden when starting a
2691
2875
  # workflow execution using the StartWorkflowExecution action or the
2692
- # `StartChildWorkflowExecution` decision.
2876
+ # `StartChildWorkflowExecution` Decision.
2693
2877
  #
2694
- # The duration is specified in seconds; an integer greater than or equal
2695
- # to 0. The value "NONE" can be used to specify unlimited duration.
2878
+ # The duration is specified in seconds, an integer greater than or equal
2879
+ # to `0`. You can use `NONE` to specify unlimited duration.
2696
2880
  #
2697
2881
  # @option params [String] :default_execution_start_to_close_timeout
2698
2882
  # If set, specifies the default maximum duration for executions of this
2699
2883
  # workflow type. You can override this default when starting an
2700
- # execution through the StartWorkflowExecution action or
2701
- # `StartChildWorkflowExecution` decision.
2884
+ # execution through the StartWorkflowExecution Action or
2885
+ # `StartChildWorkflowExecution` Decision.
2702
2886
  #
2703
2887
  # The duration is specified in seconds; an integer greater than or equal
2704
2888
  # to 0. Unlike some of the other timeout parameters in Amazon SWF, you
2705
2889
  # cannot specify a value of "NONE" for
2706
2890
  # `defaultExecutionStartToCloseTimeout`; there is a one-year max limit
2707
2891
  # on the time that a workflow execution can run. Exceeding this limit
2708
- # will always cause the workflow execution to time out.
2892
+ # always causes the workflow execution to time out.
2709
2893
  #
2710
2894
  # @option params [Types::TaskList] :default_task_list
2711
2895
  # If set, specifies the default task list to use for scheduling decision
2712
2896
  # tasks for executions of this workflow type. This default is used only
2713
- # if a task list is not provided when starting the execution through the
2714
- # StartWorkflowExecution action or `StartChildWorkflowExecution`
2715
- # decision.
2897
+ # if a task list isn't provided when starting the execution through the
2898
+ # StartWorkflowExecution Action or `StartChildWorkflowExecution`
2899
+ # Decision.
2716
2900
  #
2717
2901
  # @option params [String] :default_task_priority
2718
2902
  # The default task priority to assign to the workflow type. If not
2719
- # assigned, then "0" will be used. Valid values are integers that
2720
- # range from Java's `Integer.MIN_VALUE` (-2147483648) to
2721
- # `Integer.MAX_VALUE` (2147483647). Higher numbers indicate higher
2722
- # priority.
2903
+ # assigned, then `0` is used. Valid values are integers that range from
2904
+ # Java's `Integer.MIN_VALUE` (-2147483648) to `Integer.MAX_VALUE`
2905
+ # (2147483647). Higher numbers indicate higher priority.
2723
2906
  #
2724
2907
  # For more information about setting task priority, see [Setting Task
2725
- # Priority][1] in the *Amazon Simple Workflow Developer Guide*.
2908
+ # Priority][1] in the *Amazon SWF Developer Guide*.
2726
2909
  #
2727
2910
  #
2728
2911
  #
@@ -2734,26 +2917,35 @@ module Aws::SWF
2734
2917
  # calling the TerminateWorkflowExecution action explicitly or due to an
2735
2918
  # expired timeout. This default can be overridden when starting a
2736
2919
  # workflow execution using the StartWorkflowExecution action or the
2737
- # `StartChildWorkflowExecution` decision.
2920
+ # `StartChildWorkflowExecution` Decision.
2738
2921
  #
2739
2922
  # The supported child policies are:
2740
2923
  #
2741
- # * **TERMINATE:** the child executions will be terminated.
2742
- # * **REQUEST\_CANCEL:** a request to cancel will be attempted for each
2743
- # child execution by recording a `WorkflowExecutionCancelRequested`
2744
- # event in its history. It is up to the decider to take appropriate
2745
- # actions when it receives an execution history with this event.
2746
- # * **ABANDON:** no action will be taken. The child executions will
2747
- # continue to run.
2924
+ # * `TERMINATE` The child executions are terminated.
2925
+ #
2926
+ # * `REQUEST_CANCEL` A request to cancel is attempted for each child
2927
+ # execution by recording a `WorkflowExecutionCancelRequested` event in
2928
+ # its history. It is up to the decider to take appropriate actions
2929
+ # when it receives an execution history with this event.
2930
+ #
2931
+ # * `ABANDON` – No action is taken. The child executions continue to
2932
+ # run.
2748
2933
  #
2749
2934
  # @option params [String] :default_lambda_role
2750
- # The ARN of the default IAM role to use when a workflow execution of
2751
- # this type invokes AWS Lambda functions.
2935
+ # The default IAM role attached to this workflow type.
2936
+ #
2937
+ # <note markdown="1"> Executions of this workflow type need IAM roles to invoke Lambda
2938
+ # functions. If you don't specify an IAM role when you start this
2939
+ # workflow type, the default Lambda role is attached to the execution.
2940
+ # For more information, see
2941
+ # [http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html][1]
2942
+ # in the *Amazon SWF Developer Guide*.
2752
2943
  #
2753
- # This default can be overridden when starting a workflow execution
2754
- # using the StartWorkflowExecution action or the
2755
- # `StartChildWorkflowExecution` and `ContinueAsNewWorkflowExecution`
2756
- # decision.
2944
+ # </note>
2945
+ #
2946
+ #
2947
+ #
2948
+ # [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
2757
2949
  #
2758
2950
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2759
2951
  #
@@ -2787,9 +2979,17 @@ module Aws::SWF
2787
2979
  # execution as a whole. It is up to the decider to take appropriate
2788
2980
  # actions when it receives an execution history with this event.
2789
2981
  #
2790
- # <note>If the runId is not specified, the `WorkflowExecutionCancelRequested` event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.</note>
2982
+ # <note markdown="1"> If the runId isn't specified, the `WorkflowExecutionCancelRequested`
2983
+ # event is recorded in the history of the current open workflow
2984
+ # execution with the specified workflowId in the domain.
2985
+ #
2986
+ # </note>
2987
+ #
2988
+ # <note markdown="1"> Because this action allows the workflow to properly clean up and
2989
+ # gracefully close, it should be used instead of
2990
+ # TerminateWorkflowExecution when possible.
2791
2991
  #
2792
- # <note>Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.</note>
2992
+ # </note>
2793
2993
  #
2794
2994
  # **Access Control**
2795
2995
  #
@@ -2798,16 +2998,18 @@ module Aws::SWF
2798
2998
  #
2799
2999
  # * Use a `Resource` element with the domain name to limit the action to
2800
3000
  # only specified domains.
3001
+ #
2801
3002
  # * Use an `Action` element to allow or deny permission to call this
2802
3003
  # action.
3004
+ #
2803
3005
  # * You cannot use an IAM policy to constrain this action's parameters.
2804
3006
  #
2805
- # If the caller does not have sufficient permissions to invoke the
3007
+ # If the caller doesn't have sufficient permissions to invoke the
2806
3008
  # action, or the parameter values fall outside the specified
2807
3009
  # constraints, the action fails. The associated event attribute's
2808
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
2809
- # details and example IAM policies, see [Using IAM to Manage Access to
2810
- # Amazon SWF Workflows][1].
3010
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
3011
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
3012
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
2811
3013
  #
2812
3014
  #
2813
3015
  #
@@ -2829,7 +3031,7 @@ module Aws::SWF
2829
3031
  # resp = client.request_cancel_workflow_execution({
2830
3032
  # domain: "DomainName", # required
2831
3033
  # workflow_id: "WorkflowId", # required
2832
- # run_id: "RunIdOptional",
3034
+ # run_id: "WorkflowRunIdOptional",
2833
3035
  # })
2834
3036
  #
2835
3037
  # @overload request_cancel_workflow_execution(params = {})
@@ -2841,7 +3043,7 @@ module Aws::SWF
2841
3043
 
2842
3044
  # Used by workers to tell the service that the ActivityTask identified
2843
3045
  # by the `taskToken` was successfully canceled. Additional `details` can
2844
- # be optionally provided using the `details` argument.
3046
+ # be provided using the `details` argument.
2845
3047
  #
2846
3048
  # These `details` (if provided) appear in the `ActivityTaskCanceled`
2847
3049
  # event added to the workflow history.
@@ -2863,16 +3065,18 @@ module Aws::SWF
2863
3065
  #
2864
3066
  # * Use a `Resource` element with the domain name to limit the action to
2865
3067
  # only specified domains.
3068
+ #
2866
3069
  # * Use an `Action` element to allow or deny permission to call this
2867
3070
  # action.
3071
+ #
2868
3072
  # * You cannot use an IAM policy to constrain this action's parameters.
2869
3073
  #
2870
- # If the caller does not have sufficient permissions to invoke the
3074
+ # If the caller doesn't have sufficient permissions to invoke the
2871
3075
  # action, or the parameter values fall outside the specified
2872
3076
  # constraints, the action fails. The associated event attribute's
2873
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
2874
- # details and example IAM policies, see [Using IAM to Manage Access to
2875
- # Amazon SWF Workflows][2].
3077
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
3078
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
3079
+ # Workflows][2] in the *Amazon SWF Developer Guide*.
2876
3080
  #
2877
3081
  #
2878
3082
  #
@@ -2888,7 +3092,7 @@ module Aws::SWF
2888
3092
  # progress and respond with results.
2889
3093
  #
2890
3094
  # @option params [String] :details
2891
- # *Optional.* Information about the cancellation.
3095
+ # Information about the cancellation.
2892
3096
  #
2893
3097
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2894
3098
  #
@@ -2911,7 +3115,7 @@ module Aws::SWF
2911
3115
  # provided). The `result` appears in the `ActivityTaskCompleted` event
2912
3116
  # in the workflow history.
2913
3117
  #
2914
- # If the requested task does not complete successfully, use
3118
+ # If the requested task doesn't complete successfully, use
2915
3119
  # RespondActivityTaskFailed instead. If the worker finds that the task
2916
3120
  # is canceled through the `canceled` flag returned by
2917
3121
  # RecordActivityTaskHeartbeat, it should cancel the task, clean up and
@@ -2930,16 +3134,18 @@ module Aws::SWF
2930
3134
  #
2931
3135
  # * Use a `Resource` element with the domain name to limit the action to
2932
3136
  # only specified domains.
3137
+ #
2933
3138
  # * Use an `Action` element to allow or deny permission to call this
2934
3139
  # action.
3140
+ #
2935
3141
  # * You cannot use an IAM policy to constrain this action's parameters.
2936
3142
  #
2937
- # If the caller does not have sufficient permissions to invoke the
3143
+ # If the caller doesn't have sufficient permissions to invoke the
2938
3144
  # action, or the parameter values fall outside the specified
2939
3145
  # constraints, the action fails. The associated event attribute's
2940
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
2941
- # details and example IAM policies, see [Using IAM to Manage Access to
2942
- # Amazon SWF Workflows][2].
3146
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
3147
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
3148
+ # Workflows][2] in the *Amazon SWF Developer Guide*.
2943
3149
  #
2944
3150
  #
2945
3151
  #
@@ -2992,16 +3198,18 @@ module Aws::SWF
2992
3198
  #
2993
3199
  # * Use a `Resource` element with the domain name to limit the action to
2994
3200
  # only specified domains.
3201
+ #
2995
3202
  # * Use an `Action` element to allow or deny permission to call this
2996
3203
  # action.
3204
+ #
2997
3205
  # * You cannot use an IAM policy to constrain this action's parameters.
2998
3206
  #
2999
- # If the caller does not have sufficient permissions to invoke the
3207
+ # If the caller doesn't have sufficient permissions to invoke the
3000
3208
  # action, or the parameter values fall outside the specified
3001
3209
  # constraints, the action fails. The associated event attribute's
3002
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
3003
- # details and example IAM policies, see [Using IAM to Manage Access to
3004
- # Amazon SWF Workflows][2].
3210
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
3211
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
3212
+ # Workflows][2] in the *Amazon SWF Developer Guide*.
3005
3213
  #
3006
3214
  #
3007
3215
  #
@@ -3020,7 +3228,7 @@ module Aws::SWF
3020
3228
  # Description of the error that may assist in diagnostics.
3021
3229
  #
3022
3230
  # @option params [String] :details
3023
- # *Optional.* Detailed information about the failure.
3231
+ # Detailed information about the failure.
3024
3232
  #
3025
3233
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3026
3234
  #
@@ -3057,7 +3265,8 @@ module Aws::SWF
3057
3265
  # policies to be as readable as possible, you can express permissions on
3058
3266
  # decisions as if they were actual API calls, including applying
3059
3267
  # conditions to some parameters. For more information, see [Using IAM to
3060
- # Manage Access to Amazon SWF Workflows][1].
3268
+ # Manage Access to Amazon SWF Workflows][1] in the *Amazon SWF Developer
3269
+ # Guide*.
3061
3270
  #
3062
3271
  #
3063
3272
  #
@@ -3073,7 +3282,7 @@ module Aws::SWF
3073
3282
  #
3074
3283
  # @option params [Array<Types::Decision>] :decisions
3075
3284
  # The list of decisions (possibly empty) made by the decider while
3076
- # processing this decision task. See the docs for the decision structure
3285
+ # processing this decision task. See the docs for the Decision structure
3077
3286
  # for details.
3078
3287
  #
3079
3288
  # @option params [String] :execution_context
@@ -3145,14 +3354,14 @@ module Aws::SWF
3145
3354
  # },
3146
3355
  # signal_external_workflow_execution_decision_attributes: {
3147
3356
  # workflow_id: "WorkflowId", # required
3148
- # run_id: "RunIdOptional",
3357
+ # run_id: "WorkflowRunIdOptional",
3149
3358
  # signal_name: "SignalName", # required
3150
3359
  # input: "Data",
3151
3360
  # control: "Data",
3152
3361
  # },
3153
3362
  # request_cancel_external_workflow_execution_decision_attributes: {
3154
3363
  # workflow_id: "WorkflowId", # required
3155
- # run_id: "RunIdOptional",
3364
+ # run_id: "WorkflowRunIdOptional",
3156
3365
  # control: "Data",
3157
3366
  # },
3158
3367
  # start_child_workflow_execution_decision_attributes: {
@@ -3176,6 +3385,7 @@ module Aws::SWF
3176
3385
  # schedule_lambda_function_decision_attributes: {
3177
3386
  # id: "FunctionId", # required
3178
3387
  # name: "FunctionName", # required
3388
+ # control: "Data",
3179
3389
  # input: "FunctionInput",
3180
3390
  # start_to_close_timeout: "DurationInSecondsOptional",
3181
3391
  # },
@@ -3197,9 +3407,16 @@ module Aws::SWF
3197
3407
  # recorded with the specified user defined signalName and input (if
3198
3408
  # provided).
3199
3409
  #
3200
- # <note> 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.</note>
3410
+ # <note markdown="1"> If a runId isn't specified, then the `WorkflowExecutionSignaled`
3411
+ # event is recorded in the history of the current open workflow with the
3412
+ # matching workflowId in the domain.
3413
+ #
3414
+ # </note>
3415
+ #
3416
+ # <note markdown="1"> If the specified workflow execution isn't open, this method fails
3417
+ # with `UnknownResource`.
3201
3418
  #
3202
- # <note> If the specified workflow execution is not open, this method fails with `UnknownResource`.</note>
3419
+ # </note>
3203
3420
  #
3204
3421
  # **Access Control**
3205
3422
  #
@@ -3208,16 +3425,18 @@ module Aws::SWF
3208
3425
  #
3209
3426
  # * Use a `Resource` element with the domain name to limit the action to
3210
3427
  # only specified domains.
3428
+ #
3211
3429
  # * Use an `Action` element to allow or deny permission to call this
3212
3430
  # action.
3431
+ #
3213
3432
  # * You cannot use an IAM policy to constrain this action's parameters.
3214
3433
  #
3215
- # If the caller does not have sufficient permissions to invoke the
3434
+ # If the caller doesn't have sufficient permissions to invoke the
3216
3435
  # action, or the parameter values fall outside the specified
3217
3436
  # constraints, the action fails. The associated event attribute's
3218
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
3219
- # details and example IAM policies, see [Using IAM to Manage Access to
3220
- # Amazon SWF Workflows][1].
3437
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
3438
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
3439
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
3221
3440
  #
3222
3441
  #
3223
3442
  #
@@ -3247,7 +3466,7 @@ module Aws::SWF
3247
3466
  # resp = client.signal_workflow_execution({
3248
3467
  # domain: "DomainName", # required
3249
3468
  # workflow_id: "WorkflowId", # required
3250
- # run_id: "RunIdOptional",
3469
+ # run_id: "WorkflowRunIdOptional",
3251
3470
  # signal_name: "SignalName", # required
3252
3471
  # input: "Data",
3253
3472
  # })
@@ -3271,27 +3490,37 @@ module Aws::SWF
3271
3490
  #
3272
3491
  # * Use a `Resource` element with the domain name to limit the action to
3273
3492
  # only specified domains.
3493
+ #
3274
3494
  # * Use an `Action` element to allow or deny permission to call this
3275
3495
  # action.
3496
+ #
3276
3497
  # * Constrain the following parameters by using a `Condition` element
3277
3498
  # with the appropriate keys.
3499
+ #
3278
3500
  # * `tagList.member.0`\: The key is `swf:tagList.member.0`.
3501
+ #
3279
3502
  # * `tagList.member.1`\: The key is `swf:tagList.member.1`.
3503
+ #
3280
3504
  # * `tagList.member.2`\: The key is `swf:tagList.member.2`.
3505
+ #
3281
3506
  # * `tagList.member.3`\: The key is `swf:tagList.member.3`.
3507
+ #
3282
3508
  # * `tagList.member.4`\: The key is `swf:tagList.member.4`.
3509
+ #
3283
3510
  # * `taskList`\: String constraint. The key is `swf:taskList.name`.
3511
+ #
3284
3512
  # * `workflowType.name`\: String constraint. The key is
3285
3513
  # `swf:workflowType.name`.
3514
+ #
3286
3515
  # * `workflowType.version`\: String constraint. The key is
3287
3516
  # `swf:workflowType.version`.
3288
3517
  #
3289
- # If the caller does not have sufficient permissions to invoke the
3518
+ # If the caller doesn't have sufficient permissions to invoke the
3290
3519
  # action, or the parameter values fall outside the specified
3291
3520
  # constraints, the action fails. The associated event attribute's
3292
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
3293
- # details and example IAM policies, see [Using IAM to Manage Access to
3294
- # Amazon SWF Workflows][1].
3521
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
3522
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
3523
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
3295
3524
  #
3296
3525
  #
3297
3526
  #
@@ -3309,8 +3538,8 @@ module Aws::SWF
3309
3538
  #
3310
3539
  # The specified string must not start or end with whitespace. It must
3311
3540
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
3312
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
3313
- # must not contain the literal string quotarnquot.
3541
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
3542
+ # not contain the literal string `arn`.
3314
3543
  #
3315
3544
  # @option params [required, Types::WorkflowType] :workflow_type
3316
3545
  # The type of the workflow to start.
@@ -3320,23 +3549,28 @@ module Aws::SWF
3320
3549
  # workflow execution. This overrides the `defaultTaskList` specified
3321
3550
  # when registering the workflow type.
3322
3551
  #
3323
- # <note>A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.</note>
3552
+ # <note markdown="1"> A task list for this workflow execution must be specified either as a
3553
+ # default for the workflow type or through this parameter. If neither
3554
+ # this parameter is set nor a default task list was specified at
3555
+ # registration time then a fault is returned.
3556
+ #
3557
+ # </note>
3324
3558
  #
3325
3559
  # The specified string must not start or end with whitespace. It must
3326
3560
  # not contain a `:` (colon), `/` (slash), `|` (vertical bar), or any
3327
- # control characters (\\u0000-\\u001f \| \\u007f - \\u009f). Also, it
3328
- # must not contain the literal string quotarnquot.
3561
+ # control characters (`\u0000-\u001f` \| `\u007f-\u009f`). Also, it must
3562
+ # not contain the literal string `arn`.
3329
3563
  #
3330
3564
  # @option params [String] :task_priority
3331
- # The task priority to use for this workflow execution. This will
3332
- # override any default priority that was assigned when the workflow type
3333
- # was registered. If not set, then the default task priority for the
3334
- # workflow type will be used. Valid values are integers that range from
3565
+ # The task priority to use for this workflow execution. This overrides
3566
+ # any default priority that was assigned when the workflow type was
3567
+ # registered. If not set, then the default task priority for the
3568
+ # workflow type is used. Valid values are integers that range from
3335
3569
  # Java's `Integer.MIN_VALUE` (-2147483648) to `Integer.MAX_VALUE`
3336
3570
  # (2147483647). Higher numbers indicate higher priority.
3337
3571
  #
3338
3572
  # For more information about setting task priority, see [Setting Task
3339
- # Priority][1] in the *Amazon Simple Workflow Developer Guide*.
3573
+ # Priority][1] in the *Amazon SWF Developer Guide*.
3340
3574
  #
3341
3575
  #
3342
3576
  #
@@ -3354,12 +3588,17 @@ module Aws::SWF
3354
3588
  # workflow type.
3355
3589
  #
3356
3590
  # The duration is specified in seconds; an integer greater than or equal
3357
- # to 0. Exceeding this limit will cause the workflow execution to time
3591
+ # to `0`. Exceeding this limit causes the workflow execution to time
3358
3592
  # out. Unlike some of the other timeout parameters in Amazon SWF, you
3359
3593
  # cannot specify a value of "NONE" for this timeout; there is a
3360
3594
  # one-year max limit on the time that a workflow execution can run.
3361
3595
  #
3362
- # <note> An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.</note>
3596
+ # <note markdown="1"> An execution start-to-close timeout must be specified either through
3597
+ # this parameter or as a default when the workflow type is registered.
3598
+ # If neither this parameter nor a default execution start-to-close
3599
+ # timeout is specified, a fault is returned.
3600
+ #
3601
+ # </note>
3363
3602
  #
3364
3603
  # @option params [Array<String>] :tag_list
3365
3604
  # The list of tags to associate with the workflow execution. You can
@@ -3373,10 +3612,16 @@ module Aws::SWF
3373
3612
  # `defaultTaskStartToCloseTimout` specified when registering the
3374
3613
  # workflow type using RegisterWorkflowType.
3375
3614
  #
3376
- # The duration is specified in seconds; an integer greater than or equal
3377
- # to 0. The value "NONE" can be used to specify unlimited duration.
3615
+ # The duration is specified in seconds, an integer greater than or equal
3616
+ # to `0`. You can use `NONE` to specify unlimited duration.
3378
3617
  #
3379
- # <note>A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.</note>
3618
+ # <note markdown="1"> A task start-to-close timeout for this workflow execution must be
3619
+ # specified either as a default for the workflow type or through this
3620
+ # parameter. If neither this parameter is set nor a default task
3621
+ # start-to-close timeout was specified at registration time then a fault
3622
+ # is returned.
3623
+ #
3624
+ # </note>
3380
3625
  #
3381
3626
  # @option params [String] :child_policy
3382
3627
  # If set, specifies the policy to use for the child workflow executions
@@ -3387,21 +3632,38 @@ module Aws::SWF
3387
3632
  #
3388
3633
  # The supported child policies are:
3389
3634
  #
3390
- # * **TERMINATE:** the child executions will be terminated.
3391
- # * **REQUEST\_CANCEL:** a request to cancel will be attempted for each
3392
- # child execution by recording a `WorkflowExecutionCancelRequested`
3393
- # event in its history. It is up to the decider to take appropriate
3394
- # actions when it receives an execution history with this event.
3395
- # * **ABANDON:** no action will be taken. The child executions will
3396
- # continue to run.
3635
+ # * `TERMINATE` The child executions are terminated.
3636
+ #
3637
+ # * `REQUEST_CANCEL` A request to cancel is attempted for each child
3638
+ # execution by recording a `WorkflowExecutionCancelRequested` event in
3639
+ # its history. It is up to the decider to take appropriate actions
3640
+ # when it receives an execution history with this event.
3641
+ #
3642
+ # * `ABANDON` – No action is taken. The child executions continue to
3643
+ # run.
3397
3644
  #
3398
- # <note>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.</note>
3645
+ # <note markdown="1"> A child policy for this workflow execution must be specified either as
3646
+ # a default for the workflow type or through this parameter. If neither
3647
+ # this parameter is set nor a default child policy was specified at
3648
+ # registration time then a fault is returned.
3649
+ #
3650
+ # </note>
3399
3651
  #
3400
3652
  # @option params [String] :lambda_role
3401
- # The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda
3402
- # functions.
3653
+ # The IAM role to attach to this workflow execution.
3654
+ #
3655
+ # <note markdown="1"> Executions of this workflow type need IAM roles to invoke Lambda
3656
+ # functions. If you don't attach an IAM role, any attempt to schedule a
3657
+ # Lambda task fails. This results in a `ScheduleLambdaFunctionFailed`
3658
+ # history event. For more information, see
3659
+ # [http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html][1]
3660
+ # in the *Amazon SWF Developer Guide*.
3403
3661
  #
3404
- # <note>In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.</note>
3662
+ # </note>
3663
+ #
3664
+ #
3665
+ #
3666
+ # [1]: http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
3405
3667
  #
3406
3668
  # @return [Types::Run] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3407
3669
  #
@@ -3448,9 +3710,17 @@ module Aws::SWF
3448
3710
  # If the identified workflow execution was in progress, it is terminated
3449
3711
  # immediately.
3450
3712
  #
3451
- # <note> If a runId is not specified, then the `WorkflowExecutionTerminated` event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note>
3713
+ # <note markdown="1"> If a runId isn't specified, then the `WorkflowExecutionTerminated`
3714
+ # event is recorded in the history of the current open workflow with the
3715
+ # matching workflowId in the domain.
3716
+ #
3717
+ # </note>
3718
+ #
3719
+ # <note markdown="1"> You should consider using RequestCancelWorkflowExecution action
3720
+ # instead because it allows the workflow to gracefully close while
3721
+ # TerminateWorkflowExecution doesn't.
3452
3722
  #
3453
- # <note> You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.</note>
3723
+ # </note>
3454
3724
  #
3455
3725
  # **Access Control**
3456
3726
  #
@@ -3459,16 +3729,18 @@ module Aws::SWF
3459
3729
  #
3460
3730
  # * Use a `Resource` element with the domain name to limit the action to
3461
3731
  # only specified domains.
3732
+ #
3462
3733
  # * Use an `Action` element to allow or deny permission to call this
3463
3734
  # action.
3735
+ #
3464
3736
  # * You cannot use an IAM policy to constrain this action's parameters.
3465
3737
  #
3466
- # If the caller does not have sufficient permissions to invoke the
3738
+ # If the caller doesn't have sufficient permissions to invoke the
3467
3739
  # action, or the parameter values fall outside the specified
3468
3740
  # constraints, the action fails. The associated event attribute's
3469
- # **cause** parameter will be set to OPERATION\_NOT\_PERMITTED. For
3470
- # details and example IAM policies, see [Using IAM to Manage Access to
3471
- # Amazon SWF Workflows][1].
3741
+ # `cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and
3742
+ # example IAM policies, see [Using IAM to Manage Access to Amazon SWF
3743
+ # Workflows][1] in the *Amazon SWF Developer Guide*.
3472
3744
  #
3473
3745
  #
3474
3746
  #
@@ -3484,11 +3756,10 @@ module Aws::SWF
3484
3756
  # The runId of the workflow execution to terminate.
3485
3757
  #
3486
3758
  # @option params [String] :reason
3487
- # *Optional.* A descriptive reason for terminating the workflow
3488
- # execution.
3759
+ # A descriptive reason for terminating the workflow execution.
3489
3760
  #
3490
3761
  # @option params [String] :details
3491
- # *Optional.* Details for terminating the workflow execution.
3762
+ # Details for terminating the workflow execution.
3492
3763
  #
3493
3764
  # @option params [String] :child_policy
3494
3765
  # If set, specifies the policy to use for the child workflow executions
@@ -3498,15 +3769,22 @@ module Aws::SWF
3498
3769
  #
3499
3770
  # The supported child policies are:
3500
3771
  #
3501
- # * **TERMINATE:** the child executions will be terminated.
3502
- # * **REQUEST\_CANCEL:** a request to cancel will be attempted for each
3503
- # child execution by recording a `WorkflowExecutionCancelRequested`
3504
- # event in its history. It is up to the decider to take appropriate
3505
- # actions when it receives an execution history with this event.
3506
- # * **ABANDON:** no action will be taken. The child executions will
3507
- # continue to run.
3772
+ # * `TERMINATE` The child executions are terminated.
3773
+ #
3774
+ # * `REQUEST_CANCEL` A request to cancel is attempted for each child
3775
+ # execution by recording a `WorkflowExecutionCancelRequested` event in
3776
+ # its history. It is up to the decider to take appropriate actions
3777
+ # when it receives an execution history with this event.
3778
+ #
3779
+ # * `ABANDON` – No action is taken. The child executions continue to
3780
+ # run.
3781
+ #
3782
+ # <note markdown="1"> A child policy for this workflow execution must be specified either as
3783
+ # a default for the workflow type or through this parameter. If neither
3784
+ # this parameter is set nor a default child policy was specified at
3785
+ # registration time then a fault is returned.
3508
3786
  #
3509
- # <note>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.</note>
3787
+ # </note>
3510
3788
  #
3511
3789
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3512
3790
  #
@@ -3515,7 +3793,7 @@ module Aws::SWF
3515
3793
  # resp = client.terminate_workflow_execution({
3516
3794
  # domain: "DomainName", # required
3517
3795
  # workflow_id: "WorkflowId", # required
3518
- # run_id: "RunIdOptional",
3796
+ # run_id: "WorkflowRunIdOptional",
3519
3797
  # reason: "TerminateReason",
3520
3798
  # details: "Data",
3521
3799
  # child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
@@ -3541,7 +3819,7 @@ module Aws::SWF
3541
3819
  params: params,
3542
3820
  config: config)
3543
3821
  context[:gem_name] = 'aws-sdk-swf'
3544
- context[:gem_version] = '1.0.0.rc7'
3822
+ context[:gem_version] = '1.0.0.rc8'
3545
3823
  Seahorse::Client::Request.new(handlers, context)
3546
3824
  end
3547
3825