aws-sdk-states 1.24.0 → 1.25.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 46d7008b51a839196c60ec15f8d5cee92d73d522
4
- data.tar.gz: 50d3aec12060bca51551bdc0fad91793402bb8fb
3
+ metadata.gz: 54826692697e74b50e190c0e99dd2a805d840f37
4
+ data.tar.gz: a0ec640131dcfda401c83058bd6d10e7896b5f39
5
5
  SHA512:
6
- metadata.gz: 3054e9bc0314f5034f210e1864a88a30fefc5a567a6cce52c0d5bb7db95db49d86e96d228115a03f3e16bc56088920a3b78458ceba18f567e404790755b2fc43
7
- data.tar.gz: 922990a459ae54371f39b39735397725076e3590ea699d5a92928496edb3fd732abfe1ce51cf5842f601f9b1a7e6ca3aa8be50f88c3c63c744b9f7ff9943be85
6
+ metadata.gz: 911fafc972a8b3a3e83ac3f513b22b8ebfe37de5ab43a25bdf2ee082f278d4b278dbba3185776b3eff62f6efee0bcccbfbb240d76d8fca5fc212760e8188fcca
7
+ data.tar.gz: 9d45d1e1d8d8f84e963a549e37513af85de01bee54bd13019957a3f176cc7bddfbc39140eae7d3d3e4a6f8e4af2a409fb6809ba4551106dbbb7a85d662ddb463
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-states/customizations'
42
42
  # @service
43
43
  module Aws::States
44
44
 
45
- GEM_VERSION = '1.24.0'
45
+ GEM_VERSION = '1.25.0'
46
46
 
47
47
  end
@@ -305,6 +305,9 @@ module Aws::States
305
305
  #
306
306
  # * control characters (`U+0000-001F`, `U+007F-009F`)
307
307
  #
308
+ # To enable logging with CloudWatch Logs, the name should only contain
309
+ # 0-9, A-Z, a-z, - and \_.
310
+ #
308
311
  #
309
312
  #
310
313
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -359,7 +362,8 @@ module Aws::States
359
362
  # states that can do work (`Task` states), determine to which states to
360
363
  # transition next (`Choice` states), stop an execution with an error
361
364
  # (`Fail` states), and so on. State machines are specified using a
362
- # JSON-based, structured language.
365
+ # JSON-based, structured language. For more information, see [Amazon
366
+ # States Language][1] in the AWS Step Functions User Guide.
363
367
  #
364
368
  # <note markdown="1"> This operation is eventually consistent. The results are best effort
365
369
  # and may not reflect very recent updates and changes.
@@ -369,14 +373,18 @@ module Aws::States
369
373
  # <note markdown="1"> `CreateStateMachine` is an idempotent API. Subsequent requests won’t
370
374
  # create a duplicate resource if it was already created.
371
375
  # `CreateStateMachine`'s idempotency check is based on the state
372
- # machine `name` and `definition`. If a following request has a
373
- # different `roleArn` or `tags`, Step Functions will ignore these
374
- # differences and treat it as an idempotent request of the previous. In
375
- # this case, `roleArn` and `tags` will not be updated, even if they are
376
- # different.
376
+ # machine `name`, `definition`, `type`, and `LoggingConfiguration`. If a
377
+ # following request has a different `roleArn` or `tags`, Step Functions
378
+ # will ignore these differences and treat it as an idempotent request of
379
+ # the previous. In this case, `roleArn` and `tags` will not be updated,
380
+ # even if they are different.
377
381
  #
378
382
  # </note>
379
383
  #
384
+ #
385
+ #
386
+ # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html
387
+ #
380
388
  # @option params [required, String] :name
381
389
  # The name of the state machine.
382
390
  #
@@ -392,6 +400,9 @@ module Aws::States
392
400
  #
393
401
  # * control characters (`U+0000-001F`, `U+007F-009F`)
394
402
  #
403
+ # To enable logging with CloudWatch Logs, the name should only contain
404
+ # 0-9, A-Z, a-z, - and \_.
405
+ #
395
406
  # @option params [required, String] :definition
396
407
  # The Amazon States Language definition of the state machine. See
397
408
  # [Amazon States Language][1].
@@ -405,13 +416,23 @@ module Aws::States
405
416
  # machine.
406
417
  #
407
418
  # @option params [String] :type
408
- # Determines whether a Standard or Express state machine is created. If
409
- # not set, Standard is created.
419
+ # Determines whether a Standard or Express state machine is created. The
420
+ # default is `STANDARD`. You cannot update the `type` of a state machine
421
+ # once it has been created.
410
422
  #
411
423
  # @option params [Types::LoggingConfiguration] :logging_configuration
412
424
  # Defines what execution history events are logged and where they are
413
425
  # logged.
414
426
  #
427
+ # <note markdown="1"> By default, the `level` is set to `OFF`. For more information see [Log
428
+ # Levels][1] in the AWS Step Functions User Guide.
429
+ #
430
+ # </note>
431
+ #
432
+ #
433
+ #
434
+ # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html
435
+ #
415
436
  # @option params [Array<Types::Tag>] :tags
416
437
  # Tags to be added when creating a state machine.
417
438
  #
@@ -496,11 +517,11 @@ module Aws::States
496
517
 
497
518
  # Deletes a state machine. This is an asynchronous operation: It sets
498
519
  # the state machine's status to `DELETING` and begins the deletion
499
- # process. Each state machine execution is deleted the next time it
500
- # makes a state transition.
520
+ # process.
501
521
  #
502
- # <note markdown="1"> The state machine itself is deleted after all executions are completed
503
- # or deleted.
522
+ # <note markdown="1"> For `EXPRESS`state machines, the deletion will happen eventually
523
+ # (usually less than a minute). Running executions may emit logs after
524
+ # `DeleteStateMachine` API is called.
504
525
  #
505
526
  # </note>
506
527
  #
@@ -568,6 +589,8 @@ module Aws::States
568
589
  #
569
590
  # </note>
570
591
  #
592
+ # This API action is not supported by `EXPRESS` state machines.
593
+ #
571
594
  # @option params [required, String] :execution_arn
572
595
  # The Amazon Resource Name (ARN) of the execution to describe.
573
596
  #
@@ -665,6 +688,8 @@ module Aws::States
665
688
  #
666
689
  # </note>
667
690
  #
691
+ # This API action is not supported by `EXPRESS` state machines.
692
+ #
668
693
  # @option params [required, String] :execution_arn
669
694
  # The Amazon Resource Name (ARN) of the execution you want state machine
670
695
  # information for.
@@ -676,6 +701,7 @@ module Aws::States
676
701
  # * {Types::DescribeStateMachineForExecutionOutput#definition #definition} => String
677
702
  # * {Types::DescribeStateMachineForExecutionOutput#role_arn #role_arn} => String
678
703
  # * {Types::DescribeStateMachineForExecutionOutput#update_date #update_date} => Time
704
+ # * {Types::DescribeStateMachineForExecutionOutput#logging_configuration #logging_configuration} => Types::LoggingConfiguration
679
705
  #
680
706
  # @example Request syntax with placeholder values
681
707
  #
@@ -690,6 +716,10 @@ module Aws::States
690
716
  # resp.definition #=> String
691
717
  # resp.role_arn #=> String
692
718
  # resp.update_date #=> Time
719
+ # resp.logging_configuration.level #=> String, one of "ALL", "ERROR", "FATAL", "OFF"
720
+ # resp.logging_configuration.include_execution_data #=> Boolean
721
+ # resp.logging_configuration.destinations #=> Array
722
+ # resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
693
723
  #
694
724
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution AWS API Documentation
695
725
  #
@@ -768,6 +798,8 @@ module Aws::States
768
798
  # after 24 hours. Using an expired pagination token will return an *HTTP
769
799
  # 400 InvalidToken* error.
770
800
  #
801
+ # This API action is not supported by `EXPRESS` state machines.
802
+ #
771
803
  # @option params [required, String] :execution_arn
772
804
  # The Amazon Resource Name (ARN) of the execution.
773
805
  #
@@ -972,6 +1004,8 @@ module Aws::States
972
1004
  #
973
1005
  # </note>
974
1006
  #
1007
+ # This API action is not supported by `EXPRESS` state machines.
1008
+ #
975
1009
  # @option params [required, String] :state_machine_arn
976
1010
  # The Amazon Resource Name (ARN) of the state machine whose executions
977
1011
  # is listed.
@@ -1286,6 +1320,9 @@ module Aws::States
1286
1320
  #
1287
1321
  # * control characters (`U+0000-001F`, `U+007F-009F`)
1288
1322
  #
1323
+ # To enable logging with CloudWatch Logs, the name should only contain
1324
+ # 0-9, A-Z, a-z, - and \_.
1325
+ #
1289
1326
  #
1290
1327
  #
1291
1328
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -1330,6 +1367,8 @@ module Aws::States
1330
1367
 
1331
1368
  # Stops an execution.
1332
1369
  #
1370
+ # This API action is not supported by `EXPRESS` state machines.
1371
+ #
1333
1372
  # @option params [required, String] :execution_arn
1334
1373
  # The Amazon Resource Name (ARN) of the execution to stop.
1335
1374
  #
@@ -1438,10 +1477,10 @@ module Aws::States
1438
1477
  req.send_request(options)
1439
1478
  end
1440
1479
 
1441
- # Updates an existing state machine by modifying its `definition` and/or
1442
- # `roleArn`. Running executions will continue to use the previous
1443
- # `definition` and `roleArn`. You must include at least one of
1444
- # `definition` or `roleArn` or you will receive a
1480
+ # Updates an existing state machine by modifying its `definition`,
1481
+ # `roleArn`, or `loggingConfiguration`. Running executions will continue
1482
+ # to use the previous `definition` and `roleArn`. You must include at
1483
+ # least one of `definition` or `roleArn` or you will receive a
1445
1484
  # `MissingRequiredParameter` error.
1446
1485
  #
1447
1486
  # <note markdown="1"> All `StartExecution` calls within a few seconds will use the updated
@@ -1466,6 +1505,8 @@ module Aws::States
1466
1505
  # The Amazon Resource Name (ARN) of the IAM role of the state machine.
1467
1506
  #
1468
1507
  # @option params [Types::LoggingConfiguration] :logging_configuration
1508
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
1509
+ # options.
1469
1510
  #
1470
1511
  # @return [Types::UpdateStateMachineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1471
1512
  #
@@ -1516,7 +1557,7 @@ module Aws::States
1516
1557
  params: params,
1517
1558
  config: config)
1518
1559
  context[:gem_name] = 'aws-sdk-states'
1519
- context[:gem_version] = '1.24.0'
1560
+ context[:gem_version] = '1.25.0'
1520
1561
  Seahorse::Client::Request.new(handlers, context)
1521
1562
  end
1522
1563
 
@@ -252,6 +252,7 @@ module Aws::States
252
252
  DescribeStateMachineForExecutionOutput.add_member(:definition, Shapes::ShapeRef.new(shape: Definition, required: true, location_name: "definition"))
253
253
  DescribeStateMachineForExecutionOutput.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "roleArn"))
254
254
  DescribeStateMachineForExecutionOutput.add_member(:update_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "updateDate"))
255
+ DescribeStateMachineForExecutionOutput.add_member(:logging_configuration, Shapes::ShapeRef.new(shape: LoggingConfiguration, location_name: "loggingConfiguration"))
255
256
  DescribeStateMachineForExecutionOutput.struct_class = Types::DescribeStateMachineForExecutionOutput
256
257
 
257
258
  DescribeStateMachineInput.add_member(:state_machine_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "stateMachineArn"))
@@ -71,6 +71,9 @@ module Aws::States
71
71
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
72
72
  #
73
73
  # * control characters (`U+0000-001F`, `U+007F-009F`)
74
+ #
75
+ # To enable logging with CloudWatch Logs, the name should only contain
76
+ # 0-9, A-Z, a-z, - and \_.
74
77
  # @return [String]
75
78
  #
76
79
  # @!attribute [rw] creation_date
@@ -244,6 +247,9 @@ module Aws::States
244
247
  #
245
248
  # * control characters (`U+0000-001F`, `U+007F-009F`)
246
249
  #
250
+ # To enable logging with CloudWatch Logs, the name should only contain
251
+ # 0-9, A-Z, a-z, - and \_.
252
+ #
247
253
  #
248
254
  #
249
255
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -330,6 +336,9 @@ module Aws::States
330
336
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
331
337
  #
332
338
  # * control characters (`U+0000-001F`, `U+007F-009F`)
339
+ #
340
+ # To enable logging with CloudWatch Logs, the name should only contain
341
+ # 0-9, A-Z, a-z, - and \_.
333
342
  # @return [String]
334
343
  #
335
344
  # @!attribute [rw] definition
@@ -348,12 +357,22 @@ module Aws::States
348
357
  #
349
358
  # @!attribute [rw] type
350
359
  # Determines whether a Standard or Express state machine is created.
351
- # If not set, Standard is created.
360
+ # The default is `STANDARD`. You cannot update the `type` of a state
361
+ # machine once it has been created.
352
362
  # @return [String]
353
363
  #
354
364
  # @!attribute [rw] logging_configuration
355
365
  # Defines what execution history events are logged and where they are
356
366
  # logged.
367
+ #
368
+ # <note markdown="1"> By default, the `level` is set to `OFF`. For more information see
369
+ # [Log Levels][1] in the AWS Step Functions User Guide.
370
+ #
371
+ # </note>
372
+ #
373
+ #
374
+ #
375
+ # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html
357
376
  # @return [Types::LoggingConfiguration]
358
377
  #
359
378
  # @!attribute [rw] tags
@@ -481,6 +500,9 @@ module Aws::States
481
500
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
482
501
  #
483
502
  # * control characters (`U+0000-001F`, `U+007F-009F`)
503
+ #
504
+ # To enable logging with CloudWatch Logs, the name should only contain
505
+ # 0-9, A-Z, a-z, - and \_.
484
506
  # @return [String]
485
507
  #
486
508
  # @!attribute [rw] creation_date
@@ -515,7 +537,7 @@ module Aws::States
515
537
  end
516
538
 
517
539
  # @!attribute [rw] execution_arn
518
- # The Amazon Resource Name (ARN) that identifies the execution.
540
+ # The Amazon Resource Name (ARN) that id entifies the execution.
519
541
  # @return [String]
520
542
  #
521
543
  # @!attribute [rw] state_machine_arn
@@ -536,6 +558,9 @@ module Aws::States
536
558
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
537
559
  #
538
560
  # * control characters (`U+0000-001F`, `U+007F-009F`)
561
+ #
562
+ # To enable logging with CloudWatch Logs, the name should only contain
563
+ # 0-9, A-Z, a-z, - and \_.
539
564
  # @return [String]
540
565
  #
541
566
  # @!attribute [rw] status
@@ -625,6 +650,11 @@ module Aws::States
625
650
  # date.
626
651
  # @return [Time]
627
652
  #
653
+ # @!attribute [rw] logging_configuration
654
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
655
+ # options.
656
+ # @return [Types::LoggingConfiguration]
657
+ #
628
658
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecutionOutput AWS API Documentation
629
659
  #
630
660
  class DescribeStateMachineForExecutionOutput < Struct.new(
@@ -632,7 +662,8 @@ module Aws::States
632
662
  :name,
633
663
  :definition,
634
664
  :role_arn,
635
- :update_date)
665
+ :update_date,
666
+ :logging_configuration)
636
667
  include Aws::Structure
637
668
  end
638
669
 
@@ -672,6 +703,9 @@ module Aws::States
672
703
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
673
704
  #
674
705
  # * control characters (`U+0000-001F`, `U+007F-009F`)
706
+ #
707
+ # To enable logging with CloudWatch Logs, the name should only contain
708
+ # 0-9, A-Z, a-z, - and \_.
675
709
  # @return [String]
676
710
  #
677
711
  # @!attribute [rw] status
@@ -694,6 +728,7 @@ module Aws::States
694
728
  # @return [String]
695
729
  #
696
730
  # @!attribute [rw] type
731
+ # The `type` of the state machine (`STANDARD` or `EXPRESS`).
697
732
  # @return [String]
698
733
  #
699
734
  # @!attribute [rw] creation_date
@@ -701,6 +736,8 @@ module Aws::States
701
736
  # @return [Time]
702
737
  #
703
738
  # @!attribute [rw] logging_configuration
739
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
740
+ # options.
704
741
  # @return [Types::LoggingConfiguration]
705
742
  #
706
743
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineOutput AWS API Documentation
@@ -799,7 +836,7 @@ module Aws::States
799
836
  # Contains details about an execution.
800
837
  #
801
838
  # @!attribute [rw] execution_arn
802
- # The Amazon Resource Name (ARN) that identifies the execution.
839
+ # The Amazon Resource Name (ARN) that id entifies the execution.
803
840
  # @return [String]
804
841
  #
805
842
  # @!attribute [rw] state_machine_arn
@@ -820,6 +857,9 @@ module Aws::States
820
857
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
821
858
  #
822
859
  # * control characters (`U+0000-001F`, `U+007F-009F`)
860
+ #
861
+ # To enable logging with CloudWatch Logs, the name should only contain
862
+ # 0-9, A-Z, a-z, - and \_.
823
863
  # @return [String]
824
864
  #
825
865
  # @!attribute [rw] status
@@ -1642,6 +1682,9 @@ module Aws::States
1642
1682
  include Aws::Structure
1643
1683
  end
1644
1684
 
1685
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
1686
+ # options.
1687
+ #
1645
1688
  # @note When making an API call, you may pass LoggingConfiguration
1646
1689
  # data as a hash:
1647
1690
  #
@@ -1662,14 +1705,14 @@ module Aws::States
1662
1705
  # @return [String]
1663
1706
  #
1664
1707
  # @!attribute [rw] include_execution_data
1665
- # Determines whether execution history data is included in your log.
1666
- # When set to `FALSE`, data is excluded.
1708
+ # Determines whether execution data is included in your log. When set
1709
+ # to `FALSE`, data is excluded.
1667
1710
  # @return [Boolean]
1668
1711
  #
1669
1712
  # @!attribute [rw] destinations
1670
- # An object that describes where your execution history events will be
1671
- # logged. Limited to size 1. Required, if your log level is not set to
1672
- # `OFF`.
1713
+ # An array of objects that describes where your execution history
1714
+ # events will be logged. Limited to size 1. Required, if your log
1715
+ # level is not set to `OFF`.
1673
1716
  # @return [Array<Types::LogDestination>]
1674
1717
  #
1675
1718
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LoggingConfiguration AWS API Documentation
@@ -1878,6 +1921,9 @@ module Aws::States
1878
1921
  #
1879
1922
  # * control characters (`U+0000-001F`, `U+007F-009F`)
1880
1923
  #
1924
+ # To enable logging with CloudWatch Logs, the name should only contain
1925
+ # 0-9, A-Z, a-z, - and \_.
1926
+ #
1881
1927
  #
1882
1928
  #
1883
1929
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -1905,7 +1951,7 @@ module Aws::States
1905
1951
  end
1906
1952
 
1907
1953
  # @!attribute [rw] execution_arn
1908
- # The Amazon Resource Name (ARN) that identifies the execution.
1954
+ # The Amazon Resource Name (ARN) that id entifies the execution.
1909
1955
  # @return [String]
1910
1956
  #
1911
1957
  # @!attribute [rw] start_date
@@ -1954,6 +2000,9 @@ module Aws::States
1954
2000
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
1955
2001
  #
1956
2002
  # * control characters (`U+0000-001F`, `U+007F-009F`)
2003
+ #
2004
+ # To enable logging with CloudWatch Logs, the name should only contain
2005
+ # 0-9, A-Z, a-z, - and \_.
1957
2006
  # @return [String]
1958
2007
  #
1959
2008
  # @!attribute [rw] output
@@ -2038,6 +2087,9 @@ module Aws::States
2038
2087
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
2039
2088
  #
2040
2089
  # * control characters (`U+0000-001F`, `U+007F-009F`)
2090
+ #
2091
+ # To enable logging with CloudWatch Logs, the name should only contain
2092
+ # 0-9, A-Z, a-z, - and \_.
2041
2093
  # @return [String]
2042
2094
  #
2043
2095
  # @!attribute [rw] type
@@ -2505,6 +2557,8 @@ module Aws::States
2505
2557
  # @return [String]
2506
2558
  #
2507
2559
  # @!attribute [rw] logging_configuration
2560
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
2561
+ # options.
2508
2562
  # @return [Types::LoggingConfiguration]
2509
2563
  #
2510
2564
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachineInput AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-states
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.24.0
4
+ version: 1.25.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-12-04 00:00:00.000000000 Z
11
+ date: 2020-02-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core