aws-sdk-states 1.23.0 → 1.28.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
- SHA1:
3
- metadata.gz: 627ed63ee341b96ee8d6daee7ee4456002d3e800
4
- data.tar.gz: bf6c8ad5c94e77cef8e8b6492c4a705b48b0c0e6
2
+ SHA256:
3
+ metadata.gz: bb3de15f49b7d745710103d776ab3b79ff8405028816436ca492aaa5349a830f
4
+ data.tar.gz: 3314e36c9acae14a36f77d47c448aca6a71f74fbe020613998a441d5298dda78
5
5
  SHA512:
6
- metadata.gz: b9ed13a7ad52d75c5d6a7de26c75c35c5c92e8ca4032b3d071a37fe3b2e9567b482b56b60ca44563df8361e447ba041510bf9d41cbb6f0e8ebf844e67d4663e4
7
- data.tar.gz: bb8f96775318d9b9fd2e21069855db00832cf5c48f8a1b70d86e18e07fa5daed77376df0d04f9676ea4bdeb4c51c47e557dc5e302523e104310db76ff5efa2e5
6
+ metadata.gz: acc766d29adacf201505e6ed86ff7fc027669f6d2a6a1ea41857ca4d7d2590cd9b0aa1f4b6df84a21df17776bb291fa8c8974e833eff26db31144ea062affe77
7
+ data.tar.gz: 0cac9ed84cd90620ee6365b7da2dd20b3565ed9e017fe675d704219d65a975e85b4b2c41659be139f3965b34a5c4be1fcd51c9df376cb07a02fb1711afbbba75
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-states/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # states = Aws::States::Client.new
28
+ # resp = states.create_activity(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Step Functions all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Step Functions are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::States::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Step Functions API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-states/customizations'
42
45
  # @service
43
46
  module Aws::States
44
47
 
45
- GEM_VERSION = '1.23.0'
48
+ GEM_VERSION = '1.28.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:states)
31
31
 
32
32
  module Aws::States
33
+ # An API client for States. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::States::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::States
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::States
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::States
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::States
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::States
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::States
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::States
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::States
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::States
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -305,6 +359,9 @@ module Aws::States
305
359
  #
306
360
  # * control characters (`U+0000-001F`, `U+007F-009F`)
307
361
  #
362
+ # To enable logging with CloudWatch Logs, the name should only contain
363
+ # 0-9, A-Z, a-z, - and \_.
364
+ #
308
365
  #
309
366
  #
310
367
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -359,7 +416,8 @@ module Aws::States
359
416
  # states that can do work (`Task` states), determine to which states to
360
417
  # transition next (`Choice` states), stop an execution with an error
361
418
  # (`Fail` states), and so on. State machines are specified using a
362
- # JSON-based, structured language.
419
+ # JSON-based, structured language. For more information, see [Amazon
420
+ # States Language][1] in the AWS Step Functions User Guide.
363
421
  #
364
422
  # <note markdown="1"> This operation is eventually consistent. The results are best effort
365
423
  # and may not reflect very recent updates and changes.
@@ -369,14 +427,18 @@ module Aws::States
369
427
  # <note markdown="1"> `CreateStateMachine` is an idempotent API. Subsequent requests won’t
370
428
  # create a duplicate resource if it was already created.
371
429
  # `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.
430
+ # machine `name`, `definition`, `type`, and `LoggingConfiguration`. If a
431
+ # following request has a different `roleArn` or `tags`, Step Functions
432
+ # will ignore these differences and treat it as an idempotent request of
433
+ # the previous. In this case, `roleArn` and `tags` will not be updated,
434
+ # even if they are different.
377
435
  #
378
436
  # </note>
379
437
  #
438
+ #
439
+ #
440
+ # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html
441
+ #
380
442
  # @option params [required, String] :name
381
443
  # The name of the state machine.
382
444
  #
@@ -392,6 +454,9 @@ module Aws::States
392
454
  #
393
455
  # * control characters (`U+0000-001F`, `U+007F-009F`)
394
456
  #
457
+ # To enable logging with CloudWatch Logs, the name should only contain
458
+ # 0-9, A-Z, a-z, - and \_.
459
+ #
395
460
  # @option params [required, String] :definition
396
461
  # The Amazon States Language definition of the state machine. See
397
462
  # [Amazon States Language][1].
@@ -404,6 +469,24 @@ module Aws::States
404
469
  # The Amazon Resource Name (ARN) of the IAM role to use for this state
405
470
  # machine.
406
471
  #
472
+ # @option params [String] :type
473
+ # Determines whether a Standard or Express state machine is created. The
474
+ # default is `STANDARD`. You cannot update the `type` of a state machine
475
+ # once it has been created.
476
+ #
477
+ # @option params [Types::LoggingConfiguration] :logging_configuration
478
+ # Defines what execution history events are logged and where they are
479
+ # logged.
480
+ #
481
+ # <note markdown="1"> By default, the `level` is set to `OFF`. For more information see [Log
482
+ # Levels][1] in the AWS Step Functions User Guide.
483
+ #
484
+ # </note>
485
+ #
486
+ #
487
+ #
488
+ # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html
489
+ #
407
490
  # @option params [Array<Types::Tag>] :tags
408
491
  # Tags to be added when creating a state machine.
409
492
  #
@@ -430,6 +513,18 @@ module Aws::States
430
513
  # name: "Name", # required
431
514
  # definition: "Definition", # required
432
515
  # role_arn: "Arn", # required
516
+ # type: "STANDARD", # accepts STANDARD, EXPRESS
517
+ # logging_configuration: {
518
+ # level: "ALL", # accepts ALL, ERROR, FATAL, OFF
519
+ # include_execution_data: false,
520
+ # destinations: [
521
+ # {
522
+ # cloud_watch_logs_log_group: {
523
+ # log_group_arn: "Arn",
524
+ # },
525
+ # },
526
+ # ],
527
+ # },
433
528
  # tags: [
434
529
  # {
435
530
  # key: "TagKey",
@@ -476,11 +571,11 @@ module Aws::States
476
571
 
477
572
  # Deletes a state machine. This is an asynchronous operation: It sets
478
573
  # the state machine's status to `DELETING` and begins the deletion
479
- # process. Each state machine execution is deleted the next time it
480
- # makes a state transition.
574
+ # process.
481
575
  #
482
- # <note markdown="1"> The state machine itself is deleted after all executions are completed
483
- # or deleted.
576
+ # <note markdown="1"> For `EXPRESS`state machines, the deletion will happen eventually
577
+ # (usually less than a minute). Running executions may emit logs after
578
+ # `DeleteStateMachine` API is called.
484
579
  #
485
580
  # </note>
486
581
  #
@@ -548,6 +643,8 @@ module Aws::States
548
643
  #
549
644
  # </note>
550
645
  #
646
+ # This API action is not supported by `EXPRESS` state machines.
647
+ #
551
648
  # @option params [required, String] :execution_arn
552
649
  # The Amazon Resource Name (ARN) of the execution to describe.
553
650
  #
@@ -605,7 +702,9 @@ module Aws::States
605
702
  # * {Types::DescribeStateMachineOutput#status #status} => String
606
703
  # * {Types::DescribeStateMachineOutput#definition #definition} => String
607
704
  # * {Types::DescribeStateMachineOutput#role_arn #role_arn} => String
705
+ # * {Types::DescribeStateMachineOutput#type #type} => String
608
706
  # * {Types::DescribeStateMachineOutput#creation_date #creation_date} => Time
707
+ # * {Types::DescribeStateMachineOutput#logging_configuration #logging_configuration} => Types::LoggingConfiguration
609
708
  #
610
709
  # @example Request syntax with placeholder values
611
710
  #
@@ -620,7 +719,12 @@ module Aws::States
620
719
  # resp.status #=> String, one of "ACTIVE", "DELETING"
621
720
  # resp.definition #=> String
622
721
  # resp.role_arn #=> String
722
+ # resp.type #=> String, one of "STANDARD", "EXPRESS"
623
723
  # resp.creation_date #=> Time
724
+ # resp.logging_configuration.level #=> String, one of "ALL", "ERROR", "FATAL", "OFF"
725
+ # resp.logging_configuration.include_execution_data #=> Boolean
726
+ # resp.logging_configuration.destinations #=> Array
727
+ # resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
624
728
  #
625
729
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachine AWS API Documentation
626
730
  #
@@ -638,6 +742,8 @@ module Aws::States
638
742
  #
639
743
  # </note>
640
744
  #
745
+ # This API action is not supported by `EXPRESS` state machines.
746
+ #
641
747
  # @option params [required, String] :execution_arn
642
748
  # The Amazon Resource Name (ARN) of the execution you want state machine
643
749
  # information for.
@@ -649,6 +755,7 @@ module Aws::States
649
755
  # * {Types::DescribeStateMachineForExecutionOutput#definition #definition} => String
650
756
  # * {Types::DescribeStateMachineForExecutionOutput#role_arn #role_arn} => String
651
757
  # * {Types::DescribeStateMachineForExecutionOutput#update_date #update_date} => Time
758
+ # * {Types::DescribeStateMachineForExecutionOutput#logging_configuration #logging_configuration} => Types::LoggingConfiguration
652
759
  #
653
760
  # @example Request syntax with placeholder values
654
761
  #
@@ -663,6 +770,10 @@ module Aws::States
663
770
  # resp.definition #=> String
664
771
  # resp.role_arn #=> String
665
772
  # resp.update_date #=> Time
773
+ # resp.logging_configuration.level #=> String, one of "ALL", "ERROR", "FATAL", "OFF"
774
+ # resp.logging_configuration.include_execution_data #=> Boolean
775
+ # resp.logging_configuration.destinations #=> Array
776
+ # resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
666
777
  #
667
778
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution AWS API Documentation
668
779
  #
@@ -741,6 +852,8 @@ module Aws::States
741
852
  # after 24 hours. Using an expired pagination token will return an *HTTP
742
853
  # 400 InvalidToken* error.
743
854
  #
855
+ # This API action is not supported by `EXPRESS` state machines.
856
+ #
744
857
  # @option params [required, String] :execution_arn
745
858
  # The Amazon Resource Name (ARN) of the execution.
746
859
  #
@@ -768,6 +881,8 @@ module Aws::States
768
881
  # * {Types::GetExecutionHistoryOutput#events #events} => Array&lt;Types::HistoryEvent&gt;
769
882
  # * {Types::GetExecutionHistoryOutput#next_token #next_token} => String
770
883
  #
884
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
885
+ #
771
886
  # @example Request syntax with placeholder values
772
887
  #
773
888
  # resp = client.get_execution_history({
@@ -905,6 +1020,8 @@ module Aws::States
905
1020
  # * {Types::ListActivitiesOutput#activities #activities} => Array&lt;Types::ActivityListItem&gt;
906
1021
  # * {Types::ListActivitiesOutput#next_token #next_token} => String
907
1022
  #
1023
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1024
+ #
908
1025
  # @example Request syntax with placeholder values
909
1026
  #
910
1027
  # resp = client.list_activities({
@@ -945,6 +1062,8 @@ module Aws::States
945
1062
  #
946
1063
  # </note>
947
1064
  #
1065
+ # This API action is not supported by `EXPRESS` state machines.
1066
+ #
948
1067
  # @option params [required, String] :state_machine_arn
949
1068
  # The Amazon Resource Name (ARN) of the state machine whose executions
950
1069
  # is listed.
@@ -974,6 +1093,8 @@ module Aws::States
974
1093
  # * {Types::ListExecutionsOutput#executions #executions} => Array&lt;Types::ExecutionListItem&gt;
975
1094
  # * {Types::ListExecutionsOutput#next_token #next_token} => String
976
1095
  #
1096
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1097
+ #
977
1098
  # @example Request syntax with placeholder values
978
1099
  #
979
1100
  # resp = client.list_executions({
@@ -1038,6 +1159,8 @@ module Aws::States
1038
1159
  # * {Types::ListStateMachinesOutput#state_machines #state_machines} => Array&lt;Types::StateMachineListItem&gt;
1039
1160
  # * {Types::ListStateMachinesOutput#next_token #next_token} => String
1040
1161
  #
1162
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1163
+ #
1041
1164
  # @example Request syntax with placeholder values
1042
1165
  #
1043
1166
  # resp = client.list_state_machines({
@@ -1050,6 +1173,7 @@ module Aws::States
1050
1173
  # resp.state_machines #=> Array
1051
1174
  # resp.state_machines[0].state_machine_arn #=> String
1052
1175
  # resp.state_machines[0].name #=> String
1176
+ # resp.state_machines[0].type #=> String, one of "STANDARD", "EXPRESS"
1053
1177
  # resp.state_machines[0].creation_date #=> Time
1054
1178
  # resp.next_token #=> String
1055
1179
  #
@@ -1258,6 +1382,9 @@ module Aws::States
1258
1382
  #
1259
1383
  # * control characters (`U+0000-001F`, `U+007F-009F`)
1260
1384
  #
1385
+ # To enable logging with CloudWatch Logs, the name should only contain
1386
+ # 0-9, A-Z, a-z, - and \_.
1387
+ #
1261
1388
  #
1262
1389
  #
1263
1390
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -1302,6 +1429,8 @@ module Aws::States
1302
1429
 
1303
1430
  # Stops an execution.
1304
1431
  #
1432
+ # This API action is not supported by `EXPRESS` state machines.
1433
+ #
1305
1434
  # @option params [required, String] :execution_arn
1306
1435
  # The Amazon Resource Name (ARN) of the execution to stop.
1307
1436
  #
@@ -1410,10 +1539,10 @@ module Aws::States
1410
1539
  req.send_request(options)
1411
1540
  end
1412
1541
 
1413
- # Updates an existing state machine by modifying its `definition` and/or
1414
- # `roleArn`. Running executions will continue to use the previous
1415
- # `definition` and `roleArn`. You must include at least one of
1416
- # `definition` or `roleArn` or you will receive a
1542
+ # Updates an existing state machine by modifying its `definition`,
1543
+ # `roleArn`, or `loggingConfiguration`. Running executions will continue
1544
+ # to use the previous `definition` and `roleArn`. You must include at
1545
+ # least one of `definition` or `roleArn` or you will receive a
1417
1546
  # `MissingRequiredParameter` error.
1418
1547
  #
1419
1548
  # <note markdown="1"> All `StartExecution` calls within a few seconds will use the updated
@@ -1437,6 +1566,10 @@ module Aws::States
1437
1566
  # @option params [String] :role_arn
1438
1567
  # The Amazon Resource Name (ARN) of the IAM role of the state machine.
1439
1568
  #
1569
+ # @option params [Types::LoggingConfiguration] :logging_configuration
1570
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
1571
+ # options.
1572
+ #
1440
1573
  # @return [Types::UpdateStateMachineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1441
1574
  #
1442
1575
  # * {Types::UpdateStateMachineOutput#update_date #update_date} => Time
@@ -1447,6 +1580,17 @@ module Aws::States
1447
1580
  # state_machine_arn: "Arn", # required
1448
1581
  # definition: "Definition",
1449
1582
  # role_arn: "Arn",
1583
+ # logging_configuration: {
1584
+ # level: "ALL", # accepts ALL, ERROR, FATAL, OFF
1585
+ # include_execution_data: false,
1586
+ # destinations: [
1587
+ # {
1588
+ # cloud_watch_logs_log_group: {
1589
+ # log_group_arn: "Arn",
1590
+ # },
1591
+ # },
1592
+ # ],
1593
+ # },
1450
1594
  # })
1451
1595
  #
1452
1596
  # @example Response structure
@@ -1475,7 +1619,7 @@ module Aws::States
1475
1619
  params: params,
1476
1620
  config: config)
1477
1621
  context[:gem_name] = 'aws-sdk-states'
1478
- context[:gem_version] = '1.23.0'
1622
+ context[:gem_version] = '1.28.0'
1479
1623
  Seahorse::Client::Request.new(handlers, context)
1480
1624
  end
1481
1625
 
@@ -23,6 +23,7 @@ module Aws::States
23
23
  ActivityTimedOutEventDetails = Shapes::StructureShape.new(name: 'ActivityTimedOutEventDetails')
24
24
  ActivityWorkerLimitExceeded = Shapes::StructureShape.new(name: 'ActivityWorkerLimitExceeded')
25
25
  Arn = Shapes::StringShape.new(name: 'Arn')
26
+ CloudWatchLogsLogGroup = Shapes::StructureShape.new(name: 'CloudWatchLogsLogGroup')
26
27
  ConnectorParameters = Shapes::StringShape.new(name: 'ConnectorParameters')
27
28
  CreateActivityInput = Shapes::StructureShape.new(name: 'CreateActivityInput')
28
29
  CreateActivityOutput = Shapes::StructureShape.new(name: 'CreateActivityOutput')
@@ -62,9 +63,11 @@ module Aws::States
62
63
  HistoryEventList = Shapes::ListShape.new(name: 'HistoryEventList')
63
64
  HistoryEventType = Shapes::StringShape.new(name: 'HistoryEventType')
64
65
  Identity = Shapes::StringShape.new(name: 'Identity')
66
+ IncludeExecutionData = Shapes::BooleanShape.new(name: 'IncludeExecutionData')
65
67
  InvalidArn = Shapes::StructureShape.new(name: 'InvalidArn')
66
68
  InvalidDefinition = Shapes::StructureShape.new(name: 'InvalidDefinition')
67
69
  InvalidExecutionInput = Shapes::StructureShape.new(name: 'InvalidExecutionInput')
70
+ InvalidLoggingConfiguration = Shapes::StructureShape.new(name: 'InvalidLoggingConfiguration')
68
71
  InvalidName = Shapes::StructureShape.new(name: 'InvalidName')
69
72
  InvalidOutput = Shapes::StructureShape.new(name: 'InvalidOutput')
70
73
  InvalidToken = Shapes::StructureShape.new(name: 'InvalidToken')
@@ -83,6 +86,10 @@ module Aws::States
83
86
  ListStateMachinesOutput = Shapes::StructureShape.new(name: 'ListStateMachinesOutput')
84
87
  ListTagsForResourceInput = Shapes::StructureShape.new(name: 'ListTagsForResourceInput')
85
88
  ListTagsForResourceOutput = Shapes::StructureShape.new(name: 'ListTagsForResourceOutput')
89
+ LogDestination = Shapes::StructureShape.new(name: 'LogDestination')
90
+ LogDestinationList = Shapes::ListShape.new(name: 'LogDestinationList')
91
+ LogLevel = Shapes::StringShape.new(name: 'LogLevel')
92
+ LoggingConfiguration = Shapes::StructureShape.new(name: 'LoggingConfiguration')
86
93
  MapIterationEventDetails = Shapes::StructureShape.new(name: 'MapIterationEventDetails')
87
94
  MapStateStartedEventDetails = Shapes::StructureShape.new(name: 'MapStateStartedEventDetails')
88
95
  MissingRequiredParameter = Shapes::StructureShape.new(name: 'MissingRequiredParameter')
@@ -112,6 +119,8 @@ module Aws::States
112
119
  StateMachineList = Shapes::ListShape.new(name: 'StateMachineList')
113
120
  StateMachineListItem = Shapes::StructureShape.new(name: 'StateMachineListItem')
114
121
  StateMachineStatus = Shapes::StringShape.new(name: 'StateMachineStatus')
122
+ StateMachineType = Shapes::StringShape.new(name: 'StateMachineType')
123
+ StateMachineTypeNotSupported = Shapes::StructureShape.new(name: 'StateMachineTypeNotSupported')
115
124
  StopExecutionInput = Shapes::StructureShape.new(name: 'StopExecutionInput')
116
125
  StopExecutionOutput = Shapes::StructureShape.new(name: 'StopExecutionOutput')
117
126
  Tag = Shapes::StructureShape.new(name: 'Tag')
@@ -181,6 +190,9 @@ module Aws::States
181
190
  ActivityWorkerLimitExceeded.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
182
191
  ActivityWorkerLimitExceeded.struct_class = Types::ActivityWorkerLimitExceeded
183
192
 
193
+ CloudWatchLogsLogGroup.add_member(:log_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "logGroupArn"))
194
+ CloudWatchLogsLogGroup.struct_class = Types::CloudWatchLogsLogGroup
195
+
184
196
  CreateActivityInput.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
185
197
  CreateActivityInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
186
198
  CreateActivityInput.struct_class = Types::CreateActivityInput
@@ -192,6 +204,8 @@ module Aws::States
192
204
  CreateStateMachineInput.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
193
205
  CreateStateMachineInput.add_member(:definition, Shapes::ShapeRef.new(shape: Definition, required: true, location_name: "definition"))
194
206
  CreateStateMachineInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "roleArn"))
207
+ CreateStateMachineInput.add_member(:type, Shapes::ShapeRef.new(shape: StateMachineType, location_name: "type"))
208
+ CreateStateMachineInput.add_member(:logging_configuration, Shapes::ShapeRef.new(shape: LoggingConfiguration, location_name: "loggingConfiguration"))
195
209
  CreateStateMachineInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
196
210
  CreateStateMachineInput.struct_class = Types::CreateStateMachineInput
197
211
 
@@ -238,6 +252,7 @@ module Aws::States
238
252
  DescribeStateMachineForExecutionOutput.add_member(:definition, Shapes::ShapeRef.new(shape: Definition, required: true, location_name: "definition"))
239
253
  DescribeStateMachineForExecutionOutput.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "roleArn"))
240
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"))
241
256
  DescribeStateMachineForExecutionOutput.struct_class = Types::DescribeStateMachineForExecutionOutput
242
257
 
243
258
  DescribeStateMachineInput.add_member(:state_machine_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "stateMachineArn"))
@@ -248,7 +263,9 @@ module Aws::States
248
263
  DescribeStateMachineOutput.add_member(:status, Shapes::ShapeRef.new(shape: StateMachineStatus, location_name: "status"))
249
264
  DescribeStateMachineOutput.add_member(:definition, Shapes::ShapeRef.new(shape: Definition, required: true, location_name: "definition"))
250
265
  DescribeStateMachineOutput.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "roleArn"))
266
+ DescribeStateMachineOutput.add_member(:type, Shapes::ShapeRef.new(shape: StateMachineType, required: true, location_name: "type"))
251
267
  DescribeStateMachineOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "creationDate"))
268
+ DescribeStateMachineOutput.add_member(:logging_configuration, Shapes::ShapeRef.new(shape: LoggingConfiguration, location_name: "loggingConfiguration"))
252
269
  DescribeStateMachineOutput.struct_class = Types::DescribeStateMachineOutput
253
270
 
254
271
  ExecutionAbortedEventDetails.add_member(:error, Shapes::ShapeRef.new(shape: SensitiveError, location_name: "error"))
@@ -356,6 +373,9 @@ module Aws::States
356
373
  InvalidExecutionInput.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
357
374
  InvalidExecutionInput.struct_class = Types::InvalidExecutionInput
358
375
 
376
+ InvalidLoggingConfiguration.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
377
+ InvalidLoggingConfiguration.struct_class = Types::InvalidLoggingConfiguration
378
+
359
379
  InvalidName.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
360
380
  InvalidName.struct_class = Types::InvalidName
361
381
 
@@ -421,6 +441,16 @@ module Aws::States
421
441
  ListTagsForResourceOutput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags"))
422
442
  ListTagsForResourceOutput.struct_class = Types::ListTagsForResourceOutput
423
443
 
444
+ LogDestination.add_member(:cloud_watch_logs_log_group, Shapes::ShapeRef.new(shape: CloudWatchLogsLogGroup, location_name: "cloudWatchLogsLogGroup"))
445
+ LogDestination.struct_class = Types::LogDestination
446
+
447
+ LogDestinationList.member = Shapes::ShapeRef.new(shape: LogDestination)
448
+
449
+ LoggingConfiguration.add_member(:level, Shapes::ShapeRef.new(shape: LogLevel, location_name: "level"))
450
+ LoggingConfiguration.add_member(:include_execution_data, Shapes::ShapeRef.new(shape: IncludeExecutionData, location_name: "includeExecutionData"))
451
+ LoggingConfiguration.add_member(:destinations, Shapes::ShapeRef.new(shape: LogDestinationList, location_name: "destinations"))
452
+ LoggingConfiguration.struct_class = Types::LoggingConfiguration
453
+
424
454
  MapIterationEventDetails.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
425
455
  MapIterationEventDetails.add_member(:index, Shapes::ShapeRef.new(shape: UnsignedInteger, location_name: "index"))
426
456
  MapIterationEventDetails.struct_class = Types::MapIterationEventDetails
@@ -486,9 +516,13 @@ module Aws::States
486
516
 
487
517
  StateMachineListItem.add_member(:state_machine_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "stateMachineArn"))
488
518
  StateMachineListItem.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
519
+ StateMachineListItem.add_member(:type, Shapes::ShapeRef.new(shape: StateMachineType, required: true, location_name: "type"))
489
520
  StateMachineListItem.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "creationDate"))
490
521
  StateMachineListItem.struct_class = Types::StateMachineListItem
491
522
 
523
+ StateMachineTypeNotSupported.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
524
+ StateMachineTypeNotSupported.struct_class = Types::StateMachineTypeNotSupported
525
+
492
526
  StopExecutionInput.add_member(:execution_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "executionArn"))
493
527
  StopExecutionInput.add_member(:error, Shapes::ShapeRef.new(shape: SensitiveError, location_name: "error"))
494
528
  StopExecutionInput.add_member(:cause, Shapes::ShapeRef.new(shape: SensitiveCause, location_name: "cause"))
@@ -575,6 +609,7 @@ module Aws::States
575
609
  UpdateStateMachineInput.add_member(:state_machine_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "stateMachineArn"))
576
610
  UpdateStateMachineInput.add_member(:definition, Shapes::ShapeRef.new(shape: Definition, location_name: "definition"))
577
611
  UpdateStateMachineInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "roleArn"))
612
+ UpdateStateMachineInput.add_member(:logging_configuration, Shapes::ShapeRef.new(shape: LoggingConfiguration, location_name: "loggingConfiguration"))
578
613
  UpdateStateMachineInput.struct_class = Types::UpdateStateMachineInput
579
614
 
580
615
  UpdateStateMachineOutput.add_member(:update_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "updateDate"))
@@ -619,9 +654,11 @@ module Aws::States
619
654
  o.errors << Shapes::ShapeRef.new(shape: InvalidArn)
620
655
  o.errors << Shapes::ShapeRef.new(shape: InvalidDefinition)
621
656
  o.errors << Shapes::ShapeRef.new(shape: InvalidName)
657
+ o.errors << Shapes::ShapeRef.new(shape: InvalidLoggingConfiguration)
622
658
  o.errors << Shapes::ShapeRef.new(shape: StateMachineAlreadyExists)
623
659
  o.errors << Shapes::ShapeRef.new(shape: StateMachineDeleting)
624
660
  o.errors << Shapes::ShapeRef.new(shape: StateMachineLimitExceeded)
661
+ o.errors << Shapes::ShapeRef.new(shape: StateMachineTypeNotSupported)
625
662
  o.errors << Shapes::ShapeRef.new(shape: TooManyTags)
626
663
  end)
627
664
 
@@ -735,6 +772,7 @@ module Aws::States
735
772
  o.errors << Shapes::ShapeRef.new(shape: InvalidArn)
736
773
  o.errors << Shapes::ShapeRef.new(shape: InvalidToken)
737
774
  o.errors << Shapes::ShapeRef.new(shape: StateMachineDoesNotExist)
775
+ o.errors << Shapes::ShapeRef.new(shape: StateMachineTypeNotSupported)
738
776
  o[:pager] = Aws::Pager.new(
739
777
  limit_key: "max_results",
740
778
  tokens: {
@@ -856,6 +894,7 @@ module Aws::States
856
894
  o.output = Shapes::ShapeRef.new(shape: UpdateStateMachineOutput)
857
895
  o.errors << Shapes::ShapeRef.new(shape: InvalidArn)
858
896
  o.errors << Shapes::ShapeRef.new(shape: InvalidDefinition)
897
+ o.errors << Shapes::ShapeRef.new(shape: InvalidLoggingConfiguration)
859
898
  o.errors << Shapes::ShapeRef.new(shape: MissingRequiredParameter)
860
899
  o.errors << Shapes::ShapeRef.new(shape: StateMachineDeleting)
861
900
  o.errors << Shapes::ShapeRef.new(shape: StateMachineDoesNotExist)
@@ -6,6 +6,51 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::States
9
+
10
+ # When States returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::States::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all States errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::States::Errors::ServiceError
18
+ # # rescues all States API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {ActivityDoesNotExist}
29
+ # * {ActivityLimitExceeded}
30
+ # * {ActivityWorkerLimitExceeded}
31
+ # * {ExecutionAlreadyExists}
32
+ # * {ExecutionDoesNotExist}
33
+ # * {ExecutionLimitExceeded}
34
+ # * {InvalidArn}
35
+ # * {InvalidDefinition}
36
+ # * {InvalidExecutionInput}
37
+ # * {InvalidLoggingConfiguration}
38
+ # * {InvalidName}
39
+ # * {InvalidOutput}
40
+ # * {InvalidToken}
41
+ # * {MissingRequiredParameter}
42
+ # * {ResourceNotFound}
43
+ # * {StateMachineAlreadyExists}
44
+ # * {StateMachineDeleting}
45
+ # * {StateMachineDoesNotExist}
46
+ # * {StateMachineLimitExceeded}
47
+ # * {StateMachineTypeNotSupported}
48
+ # * {TaskDoesNotExist}
49
+ # * {TaskTimedOut}
50
+ # * {TooManyTags}
51
+ #
52
+ # Additionally, error classes are dynamically generated for service errors based on the error code
53
+ # if they are not defined above.
9
54
  module Errors
10
55
 
11
56
  extend Aws::Errors::DynamicErrors
@@ -23,7 +68,6 @@ module Aws::States
23
68
  def message
24
69
  @message || @data[:message]
25
70
  end
26
-
27
71
  end
28
72
 
29
73
  class ActivityLimitExceeded < ServiceError
@@ -39,7 +83,6 @@ module Aws::States
39
83
  def message
40
84
  @message || @data[:message]
41
85
  end
42
-
43
86
  end
44
87
 
45
88
  class ActivityWorkerLimitExceeded < ServiceError
@@ -55,7 +98,6 @@ module Aws::States
55
98
  def message
56
99
  @message || @data[:message]
57
100
  end
58
-
59
101
  end
60
102
 
61
103
  class ExecutionAlreadyExists < ServiceError
@@ -71,7 +113,6 @@ module Aws::States
71
113
  def message
72
114
  @message || @data[:message]
73
115
  end
74
-
75
116
  end
76
117
 
77
118
  class ExecutionDoesNotExist < ServiceError
@@ -87,7 +128,6 @@ module Aws::States
87
128
  def message
88
129
  @message || @data[:message]
89
130
  end
90
-
91
131
  end
92
132
 
93
133
  class ExecutionLimitExceeded < ServiceError
@@ -103,7 +143,6 @@ module Aws::States
103
143
  def message
104
144
  @message || @data[:message]
105
145
  end
106
-
107
146
  end
108
147
 
109
148
  class InvalidArn < ServiceError
@@ -119,7 +158,6 @@ module Aws::States
119
158
  def message
120
159
  @message || @data[:message]
121
160
  end
122
-
123
161
  end
124
162
 
125
163
  class InvalidDefinition < ServiceError
@@ -135,7 +173,6 @@ module Aws::States
135
173
  def message
136
174
  @message || @data[:message]
137
175
  end
138
-
139
176
  end
140
177
 
141
178
  class InvalidExecutionInput < ServiceError
@@ -151,7 +188,21 @@ module Aws::States
151
188
  def message
152
189
  @message || @data[:message]
153
190
  end
191
+ end
192
+
193
+ class InvalidLoggingConfiguration < ServiceError
194
+
195
+ # @param [Seahorse::Client::RequestContext] context
196
+ # @param [String] message
197
+ # @param [Aws::States::Types::InvalidLoggingConfiguration] data
198
+ def initialize(context, message, data = Aws::EmptyStructure.new)
199
+ super(context, message, data)
200
+ end
154
201
 
202
+ # @return [String]
203
+ def message
204
+ @message || @data[:message]
205
+ end
155
206
  end
156
207
 
157
208
  class InvalidName < ServiceError
@@ -167,7 +218,6 @@ module Aws::States
167
218
  def message
168
219
  @message || @data[:message]
169
220
  end
170
-
171
221
  end
172
222
 
173
223
  class InvalidOutput < ServiceError
@@ -183,7 +233,6 @@ module Aws::States
183
233
  def message
184
234
  @message || @data[:message]
185
235
  end
186
-
187
236
  end
188
237
 
189
238
  class InvalidToken < ServiceError
@@ -199,7 +248,6 @@ module Aws::States
199
248
  def message
200
249
  @message || @data[:message]
201
250
  end
202
-
203
251
  end
204
252
 
205
253
  class MissingRequiredParameter < ServiceError
@@ -215,7 +263,6 @@ module Aws::States
215
263
  def message
216
264
  @message || @data[:message]
217
265
  end
218
-
219
266
  end
220
267
 
221
268
  class ResourceNotFound < ServiceError
@@ -236,7 +283,6 @@ module Aws::States
236
283
  def resource_name
237
284
  @data[:resource_name]
238
285
  end
239
-
240
286
  end
241
287
 
242
288
  class StateMachineAlreadyExists < ServiceError
@@ -252,7 +298,6 @@ module Aws::States
252
298
  def message
253
299
  @message || @data[:message]
254
300
  end
255
-
256
301
  end
257
302
 
258
303
  class StateMachineDeleting < ServiceError
@@ -268,7 +313,6 @@ module Aws::States
268
313
  def message
269
314
  @message || @data[:message]
270
315
  end
271
-
272
316
  end
273
317
 
274
318
  class StateMachineDoesNotExist < ServiceError
@@ -284,7 +328,6 @@ module Aws::States
284
328
  def message
285
329
  @message || @data[:message]
286
330
  end
287
-
288
331
  end
289
332
 
290
333
  class StateMachineLimitExceeded < ServiceError
@@ -300,7 +343,21 @@ module Aws::States
300
343
  def message
301
344
  @message || @data[:message]
302
345
  end
346
+ end
347
+
348
+ class StateMachineTypeNotSupported < ServiceError
349
+
350
+ # @param [Seahorse::Client::RequestContext] context
351
+ # @param [String] message
352
+ # @param [Aws::States::Types::StateMachineTypeNotSupported] data
353
+ def initialize(context, message, data = Aws::EmptyStructure.new)
354
+ super(context, message, data)
355
+ end
303
356
 
357
+ # @return [String]
358
+ def message
359
+ @message || @data[:message]
360
+ end
304
361
  end
305
362
 
306
363
  class TaskDoesNotExist < ServiceError
@@ -316,7 +373,6 @@ module Aws::States
316
373
  def message
317
374
  @message || @data[:message]
318
375
  end
319
-
320
376
  end
321
377
 
322
378
  class TaskTimedOut < ServiceError
@@ -332,7 +388,6 @@ module Aws::States
332
388
  def message
333
389
  @message || @data[:message]
334
390
  end
335
-
336
391
  end
337
392
 
338
393
  class TooManyTags < ServiceError
@@ -353,7 +408,6 @@ module Aws::States
353
408
  def resource_name
354
409
  @data[:resource_name]
355
410
  end
356
-
357
411
  end
358
412
 
359
413
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::States
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -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
@@ -194,6 +197,25 @@ module Aws::States
194
197
  include Aws::Structure
195
198
  end
196
199
 
200
+ # @note When making an API call, you may pass CloudWatchLogsLogGroup
201
+ # data as a hash:
202
+ #
203
+ # {
204
+ # log_group_arn: "Arn",
205
+ # }
206
+ #
207
+ # @!attribute [rw] log_group_arn
208
+ # The ARN of the the CloudWatch log group to which you want your logs
209
+ # emitted to. The ARN must end with `:*`
210
+ # @return [String]
211
+ #
212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CloudWatchLogsLogGroup AWS API Documentation
213
+ #
214
+ class CloudWatchLogsLogGroup < Struct.new(
215
+ :log_group_arn)
216
+ include Aws::Structure
217
+ end
218
+
197
219
  # @note When making an API call, you may pass CreateActivityInput
198
220
  # data as a hash:
199
221
  #
@@ -225,6 +247,9 @@ module Aws::States
225
247
  #
226
248
  # * control characters (`U+0000-001F`, `U+007F-009F`)
227
249
  #
250
+ # To enable logging with CloudWatch Logs, the name should only contain
251
+ # 0-9, A-Z, a-z, - and \_.
252
+ #
228
253
  #
229
254
  #
230
255
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -277,6 +302,18 @@ module Aws::States
277
302
  # name: "Name", # required
278
303
  # definition: "Definition", # required
279
304
  # role_arn: "Arn", # required
305
+ # type: "STANDARD", # accepts STANDARD, EXPRESS
306
+ # logging_configuration: {
307
+ # level: "ALL", # accepts ALL, ERROR, FATAL, OFF
308
+ # include_execution_data: false,
309
+ # destinations: [
310
+ # {
311
+ # cloud_watch_logs_log_group: {
312
+ # log_group_arn: "Arn",
313
+ # },
314
+ # },
315
+ # ],
316
+ # },
280
317
  # tags: [
281
318
  # {
282
319
  # key: "TagKey",
@@ -299,6 +336,9 @@ module Aws::States
299
336
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
300
337
  #
301
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 \_.
302
342
  # @return [String]
303
343
  #
304
344
  # @!attribute [rw] definition
@@ -315,6 +355,26 @@ module Aws::States
315
355
  # machine.
316
356
  # @return [String]
317
357
  #
358
+ # @!attribute [rw] type
359
+ # Determines whether a Standard or Express state machine is created.
360
+ # The default is `STANDARD`. You cannot update the `type` of a state
361
+ # machine once it has been created.
362
+ # @return [String]
363
+ #
364
+ # @!attribute [rw] logging_configuration
365
+ # Defines what execution history events are logged and where they are
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
376
+ # @return [Types::LoggingConfiguration]
377
+ #
318
378
  # @!attribute [rw] tags
319
379
  # Tags to be added when creating a state machine.
320
380
  #
@@ -337,6 +397,8 @@ module Aws::States
337
397
  :name,
338
398
  :definition,
339
399
  :role_arn,
400
+ :type,
401
+ :logging_configuration,
340
402
  :tags)
341
403
  include Aws::Structure
342
404
  end
@@ -438,6 +500,9 @@ module Aws::States
438
500
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
439
501
  #
440
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 \_.
441
506
  # @return [String]
442
507
  #
443
508
  # @!attribute [rw] creation_date
@@ -472,7 +537,7 @@ module Aws::States
472
537
  end
473
538
 
474
539
  # @!attribute [rw] execution_arn
475
- # The Amazon Resource Name (ARN) that identifies the execution.
540
+ # The Amazon Resource Name (ARN) that id entifies the execution.
476
541
  # @return [String]
477
542
  #
478
543
  # @!attribute [rw] state_machine_arn
@@ -493,6 +558,9 @@ module Aws::States
493
558
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
494
559
  #
495
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 \_.
496
564
  # @return [String]
497
565
  #
498
566
  # @!attribute [rw] status
@@ -582,6 +650,11 @@ module Aws::States
582
650
  # date.
583
651
  # @return [Time]
584
652
  #
653
+ # @!attribute [rw] logging_configuration
654
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
655
+ # options.
656
+ # @return [Types::LoggingConfiguration]
657
+ #
585
658
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecutionOutput AWS API Documentation
586
659
  #
587
660
  class DescribeStateMachineForExecutionOutput < Struct.new(
@@ -589,7 +662,8 @@ module Aws::States
589
662
  :name,
590
663
  :definition,
591
664
  :role_arn,
592
- :update_date)
665
+ :update_date,
666
+ :logging_configuration)
593
667
  include Aws::Structure
594
668
  end
595
669
 
@@ -629,6 +703,9 @@ module Aws::States
629
703
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
630
704
  #
631
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 \_.
632
709
  # @return [String]
633
710
  #
634
711
  # @!attribute [rw] status
@@ -650,10 +727,19 @@ module Aws::States
650
727
  # Step Functions access to AWS resources.)
651
728
  # @return [String]
652
729
  #
730
+ # @!attribute [rw] type
731
+ # The `type` of the state machine (`STANDARD` or `EXPRESS`).
732
+ # @return [String]
733
+ #
653
734
  # @!attribute [rw] creation_date
654
735
  # The date the state machine is created.
655
736
  # @return [Time]
656
737
  #
738
+ # @!attribute [rw] logging_configuration
739
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
740
+ # options.
741
+ # @return [Types::LoggingConfiguration]
742
+ #
657
743
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineOutput AWS API Documentation
658
744
  #
659
745
  class DescribeStateMachineOutput < Struct.new(
@@ -662,7 +748,9 @@ module Aws::States
662
748
  :status,
663
749
  :definition,
664
750
  :role_arn,
665
- :creation_date)
751
+ :type,
752
+ :creation_date,
753
+ :logging_configuration)
666
754
  include Aws::Structure
667
755
  end
668
756
 
@@ -748,7 +836,7 @@ module Aws::States
748
836
  # Contains details about an execution.
749
837
  #
750
838
  # @!attribute [rw] execution_arn
751
- # The Amazon Resource Name (ARN) that identifies the execution.
839
+ # The Amazon Resource Name (ARN) that id entifies the execution.
752
840
  # @return [String]
753
841
  #
754
842
  # @!attribute [rw] state_machine_arn
@@ -769,6 +857,9 @@ module Aws::States
769
857
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
770
858
  #
771
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 \_.
772
863
  # @return [String]
773
864
  #
774
865
  # @!attribute [rw] status
@@ -1195,6 +1286,16 @@ module Aws::States
1195
1286
  include Aws::Structure
1196
1287
  end
1197
1288
 
1289
+ # @!attribute [rw] message
1290
+ # @return [String]
1291
+ #
1292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/InvalidLoggingConfiguration AWS API Documentation
1293
+ #
1294
+ class InvalidLoggingConfiguration < Struct.new(
1295
+ :message)
1296
+ include Aws::Structure
1297
+ end
1298
+
1198
1299
  # The provided name is invalid.
1199
1300
  #
1200
1301
  # @!attribute [rw] message
@@ -1556,6 +1657,73 @@ module Aws::States
1556
1657
  include Aws::Structure
1557
1658
  end
1558
1659
 
1660
+ # @note When making an API call, you may pass LogDestination
1661
+ # data as a hash:
1662
+ #
1663
+ # {
1664
+ # cloud_watch_logs_log_group: {
1665
+ # log_group_arn: "Arn",
1666
+ # },
1667
+ # }
1668
+ #
1669
+ # @!attribute [rw] cloud_watch_logs_log_group
1670
+ # An object describing a CloudWatch log group. For more information,
1671
+ # see [AWS::Logs::LogGroup][1] in the AWS CloudFormation User Guide.
1672
+ #
1673
+ #
1674
+ #
1675
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html
1676
+ # @return [Types::CloudWatchLogsLogGroup]
1677
+ #
1678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LogDestination AWS API Documentation
1679
+ #
1680
+ class LogDestination < Struct.new(
1681
+ :cloud_watch_logs_log_group)
1682
+ include Aws::Structure
1683
+ end
1684
+
1685
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
1686
+ # options.
1687
+ #
1688
+ # @note When making an API call, you may pass LoggingConfiguration
1689
+ # data as a hash:
1690
+ #
1691
+ # {
1692
+ # level: "ALL", # accepts ALL, ERROR, FATAL, OFF
1693
+ # include_execution_data: false,
1694
+ # destinations: [
1695
+ # {
1696
+ # cloud_watch_logs_log_group: {
1697
+ # log_group_arn: "Arn",
1698
+ # },
1699
+ # },
1700
+ # ],
1701
+ # }
1702
+ #
1703
+ # @!attribute [rw] level
1704
+ # Defines which category of execution history events are logged.
1705
+ # @return [String]
1706
+ #
1707
+ # @!attribute [rw] include_execution_data
1708
+ # Determines whether execution data is included in your log. When set
1709
+ # to `FALSE`, data is excluded.
1710
+ # @return [Boolean]
1711
+ #
1712
+ # @!attribute [rw] destinations
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`.
1716
+ # @return [Array<Types::LogDestination>]
1717
+ #
1718
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LoggingConfiguration AWS API Documentation
1719
+ #
1720
+ class LoggingConfiguration < Struct.new(
1721
+ :level,
1722
+ :include_execution_data,
1723
+ :destinations)
1724
+ include Aws::Structure
1725
+ end
1726
+
1559
1727
  # Contains details about an iteration of a Map state.
1560
1728
  #
1561
1729
  # @!attribute [rw] name
@@ -1753,6 +1921,9 @@ module Aws::States
1753
1921
  #
1754
1922
  # * control characters (`U+0000-001F`, `U+007F-009F`)
1755
1923
  #
1924
+ # To enable logging with CloudWatch Logs, the name should only contain
1925
+ # 0-9, A-Z, a-z, - and \_.
1926
+ #
1756
1927
  #
1757
1928
  #
1758
1929
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -1780,7 +1951,7 @@ module Aws::States
1780
1951
  end
1781
1952
 
1782
1953
  # @!attribute [rw] execution_arn
1783
- # The Amazon Resource Name (ARN) that identifies the execution.
1954
+ # The Amazon Resource Name (ARN) that id entifies the execution.
1784
1955
  # @return [String]
1785
1956
  #
1786
1957
  # @!attribute [rw] start_date
@@ -1829,6 +2000,9 @@ module Aws::States
1829
2000
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
1830
2001
  #
1831
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 \_.
1832
2006
  # @return [String]
1833
2007
  #
1834
2008
  # @!attribute [rw] output
@@ -1913,6 +2087,12 @@ module Aws::States
1913
2087
  # * special characters `` " # % \ ^ | ~ ` $ & , ; : / ``
1914
2088
  #
1915
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 \_.
2093
+ # @return [String]
2094
+ #
2095
+ # @!attribute [rw] type
1916
2096
  # @return [String]
1917
2097
  #
1918
2098
  # @!attribute [rw] creation_date
@@ -1924,10 +2104,21 @@ module Aws::States
1924
2104
  class StateMachineListItem < Struct.new(
1925
2105
  :state_machine_arn,
1926
2106
  :name,
2107
+ :type,
1927
2108
  :creation_date)
1928
2109
  include Aws::Structure
1929
2110
  end
1930
2111
 
2112
+ # @!attribute [rw] message
2113
+ # @return [String]
2114
+ #
2115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateMachineTypeNotSupported AWS API Documentation
2116
+ #
2117
+ class StateMachineTypeNotSupported < Struct.new(
2118
+ :message)
2119
+ include Aws::Structure
2120
+ end
2121
+
1931
2122
  # @note When making an API call, you may pass StopExecutionInput
1932
2123
  # data as a hash:
1933
2124
  #
@@ -2335,6 +2526,17 @@ module Aws::States
2335
2526
  # state_machine_arn: "Arn", # required
2336
2527
  # definition: "Definition",
2337
2528
  # role_arn: "Arn",
2529
+ # logging_configuration: {
2530
+ # level: "ALL", # accepts ALL, ERROR, FATAL, OFF
2531
+ # include_execution_data: false,
2532
+ # destinations: [
2533
+ # {
2534
+ # cloud_watch_logs_log_group: {
2535
+ # log_group_arn: "Arn",
2536
+ # },
2537
+ # },
2538
+ # ],
2539
+ # },
2338
2540
  # }
2339
2541
  #
2340
2542
  # @!attribute [rw] state_machine_arn
@@ -2354,12 +2556,18 @@ module Aws::States
2354
2556
  # The Amazon Resource Name (ARN) of the IAM role of the state machine.
2355
2557
  # @return [String]
2356
2558
  #
2559
+ # @!attribute [rw] logging_configuration
2560
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
2561
+ # options.
2562
+ # @return [Types::LoggingConfiguration]
2563
+ #
2357
2564
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachineInput AWS API Documentation
2358
2565
  #
2359
2566
  class UpdateStateMachineInput < Struct.new(
2360
2567
  :state_machine_arn,
2361
2568
  :definition,
2362
- :role_arn)
2569
+ :role_arn,
2570
+ :logging_configuration)
2363
2571
  include Aws::Structure
2364
2572
  end
2365
2573
 
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.23.0
4
+ version: 1.28.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-10-23 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - AWS SFN