aws-sdk-states 1.24.0 → 1.29.1

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
- SHA1:
3
- metadata.gz: 46d7008b51a839196c60ec15f8d5cee92d73d522
4
- data.tar.gz: 50d3aec12060bca51551bdc0fad91793402bb8fb
2
+ SHA256:
3
+ metadata.gz: 293c90a851bbae475965b6846e0c9c082a610d809a46f6d0cb990779f0600c28
4
+ data.tar.gz: a1aa9c107b32ca5bf0dc3916cd594e2f852514854125af6b31818f68be705d03
5
5
  SHA512:
6
- metadata.gz: 3054e9bc0314f5034f210e1864a88a30fefc5a567a6cce52c0d5bb7db95db49d86e96d228115a03f3e16bc56088920a3b78458ceba18f567e404790755b2fc43
7
- data.tar.gz: 922990a459ae54371f39b39735397725076e3590ea699d5a92928496edb3fd732abfe1ce51cf5842f601f9b1a7e6ca3aa8be50f88c3c63c744b9f7ff9943be85
6
+ metadata.gz: d6bb8351d1d2e209be0f377d4a60538edd7823c4612e4df82ed6ed04ba62b2b9d43f244eb124c11e38ff319c6e786735a31ee64e12ee220cdfd628356ebf53cd
7
+ data.tar.gz: 14b0b8df91d805c43ef2fc0d4473f77f0b26e411890f7b7d8d9bcddcd2057e46bcf8a5185d46e6bc41a673676802623dbd398ae45ce45e0e999b2fde5c31efb3
@@ -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.24.0'
48
+ GEM_VERSION = '1.29.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:states)
31
32
 
32
33
  module Aws::States
34
+ # An API client for States. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::States::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::States
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::States
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::States
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::States
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::States
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::States
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::States
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @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.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::States
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @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.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::States
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # 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}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::States
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -305,6 +361,9 @@ module Aws::States
305
361
  #
306
362
  # * control characters (`U+0000-001F`, `U+007F-009F`)
307
363
  #
364
+ # To enable logging with CloudWatch Logs, the name should only contain
365
+ # 0-9, A-Z, a-z, - and \_.
366
+ #
308
367
  #
309
368
  #
310
369
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -359,7 +418,8 @@ module Aws::States
359
418
  # states that can do work (`Task` states), determine to which states to
360
419
  # transition next (`Choice` states), stop an execution with an error
361
420
  # (`Fail` states), and so on. State machines are specified using a
362
- # JSON-based, structured language.
421
+ # JSON-based, structured language. For more information, see [Amazon
422
+ # States Language][1] in the AWS Step Functions User Guide.
363
423
  #
364
424
  # <note markdown="1"> This operation is eventually consistent. The results are best effort
365
425
  # and may not reflect very recent updates and changes.
@@ -369,14 +429,18 @@ module Aws::States
369
429
  # <note markdown="1"> `CreateStateMachine` is an idempotent API. Subsequent requests won’t
370
430
  # create a duplicate resource if it was already created.
371
431
  # `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.
432
+ # machine `name`, `definition`, `type`, and `LoggingConfiguration`. If a
433
+ # following request has a different `roleArn` or `tags`, Step Functions
434
+ # will ignore these differences and treat it as an idempotent request of
435
+ # the previous. In this case, `roleArn` and `tags` will not be updated,
436
+ # even if they are different.
377
437
  #
378
438
  # </note>
379
439
  #
440
+ #
441
+ #
442
+ # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html
443
+ #
380
444
  # @option params [required, String] :name
381
445
  # The name of the state machine.
382
446
  #
@@ -392,6 +456,9 @@ module Aws::States
392
456
  #
393
457
  # * control characters (`U+0000-001F`, `U+007F-009F`)
394
458
  #
459
+ # To enable logging with CloudWatch Logs, the name should only contain
460
+ # 0-9, A-Z, a-z, - and \_.
461
+ #
395
462
  # @option params [required, String] :definition
396
463
  # The Amazon States Language definition of the state machine. See
397
464
  # [Amazon States Language][1].
@@ -405,13 +472,23 @@ module Aws::States
405
472
  # machine.
406
473
  #
407
474
  # @option params [String] :type
408
- # Determines whether a Standard or Express state machine is created. If
409
- # not set, Standard is created.
475
+ # Determines whether a Standard or Express state machine is created. The
476
+ # default is `STANDARD`. You cannot update the `type` of a state machine
477
+ # once it has been created.
410
478
  #
411
479
  # @option params [Types::LoggingConfiguration] :logging_configuration
412
480
  # Defines what execution history events are logged and where they are
413
481
  # logged.
414
482
  #
483
+ # <note markdown="1"> By default, the `level` is set to `OFF`. For more information see [Log
484
+ # Levels][1] in the AWS Step Functions User Guide.
485
+ #
486
+ # </note>
487
+ #
488
+ #
489
+ #
490
+ # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html
491
+ #
415
492
  # @option params [Array<Types::Tag>] :tags
416
493
  # Tags to be added when creating a state machine.
417
494
  #
@@ -496,11 +573,11 @@ module Aws::States
496
573
 
497
574
  # Deletes a state machine. This is an asynchronous operation: It sets
498
575
  # 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.
576
+ # process.
501
577
  #
502
- # <note markdown="1"> The state machine itself is deleted after all executions are completed
503
- # or deleted.
578
+ # <note markdown="1"> For `EXPRESS`state machines, the deletion will happen eventually
579
+ # (usually less than a minute). Running executions may emit logs after
580
+ # `DeleteStateMachine` API is called.
504
581
  #
505
582
  # </note>
506
583
  #
@@ -568,6 +645,8 @@ module Aws::States
568
645
  #
569
646
  # </note>
570
647
  #
648
+ # This API action is not supported by `EXPRESS` state machines.
649
+ #
571
650
  # @option params [required, String] :execution_arn
572
651
  # The Amazon Resource Name (ARN) of the execution to describe.
573
652
  #
@@ -665,6 +744,8 @@ module Aws::States
665
744
  #
666
745
  # </note>
667
746
  #
747
+ # This API action is not supported by `EXPRESS` state machines.
748
+ #
668
749
  # @option params [required, String] :execution_arn
669
750
  # The Amazon Resource Name (ARN) of the execution you want state machine
670
751
  # information for.
@@ -676,6 +757,7 @@ module Aws::States
676
757
  # * {Types::DescribeStateMachineForExecutionOutput#definition #definition} => String
677
758
  # * {Types::DescribeStateMachineForExecutionOutput#role_arn #role_arn} => String
678
759
  # * {Types::DescribeStateMachineForExecutionOutput#update_date #update_date} => Time
760
+ # * {Types::DescribeStateMachineForExecutionOutput#logging_configuration #logging_configuration} => Types::LoggingConfiguration
679
761
  #
680
762
  # @example Request syntax with placeholder values
681
763
  #
@@ -690,6 +772,10 @@ module Aws::States
690
772
  # resp.definition #=> String
691
773
  # resp.role_arn #=> String
692
774
  # resp.update_date #=> Time
775
+ # resp.logging_configuration.level #=> String, one of "ALL", "ERROR", "FATAL", "OFF"
776
+ # resp.logging_configuration.include_execution_data #=> Boolean
777
+ # resp.logging_configuration.destinations #=> Array
778
+ # resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
693
779
  #
694
780
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution AWS API Documentation
695
781
  #
@@ -768,6 +854,8 @@ module Aws::States
768
854
  # after 24 hours. Using an expired pagination token will return an *HTTP
769
855
  # 400 InvalidToken* error.
770
856
  #
857
+ # This API action is not supported by `EXPRESS` state machines.
858
+ #
771
859
  # @option params [required, String] :execution_arn
772
860
  # The Amazon Resource Name (ARN) of the execution.
773
861
  #
@@ -795,6 +883,8 @@ module Aws::States
795
883
  # * {Types::GetExecutionHistoryOutput#events #events} => Array&lt;Types::HistoryEvent&gt;
796
884
  # * {Types::GetExecutionHistoryOutput#next_token #next_token} => String
797
885
  #
886
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
887
+ #
798
888
  # @example Request syntax with placeholder values
799
889
  #
800
890
  # resp = client.get_execution_history({
@@ -932,6 +1022,8 @@ module Aws::States
932
1022
  # * {Types::ListActivitiesOutput#activities #activities} => Array&lt;Types::ActivityListItem&gt;
933
1023
  # * {Types::ListActivitiesOutput#next_token #next_token} => String
934
1024
  #
1025
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1026
+ #
935
1027
  # @example Request syntax with placeholder values
936
1028
  #
937
1029
  # resp = client.list_activities({
@@ -972,6 +1064,8 @@ module Aws::States
972
1064
  #
973
1065
  # </note>
974
1066
  #
1067
+ # This API action is not supported by `EXPRESS` state machines.
1068
+ #
975
1069
  # @option params [required, String] :state_machine_arn
976
1070
  # The Amazon Resource Name (ARN) of the state machine whose executions
977
1071
  # is listed.
@@ -1001,6 +1095,8 @@ module Aws::States
1001
1095
  # * {Types::ListExecutionsOutput#executions #executions} => Array&lt;Types::ExecutionListItem&gt;
1002
1096
  # * {Types::ListExecutionsOutput#next_token #next_token} => String
1003
1097
  #
1098
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1099
+ #
1004
1100
  # @example Request syntax with placeholder values
1005
1101
  #
1006
1102
  # resp = client.list_executions({
@@ -1065,6 +1161,8 @@ module Aws::States
1065
1161
  # * {Types::ListStateMachinesOutput#state_machines #state_machines} => Array&lt;Types::StateMachineListItem&gt;
1066
1162
  # * {Types::ListStateMachinesOutput#next_token #next_token} => String
1067
1163
  #
1164
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1165
+ #
1068
1166
  # @example Request syntax with placeholder values
1069
1167
  #
1070
1168
  # resp = client.list_state_machines({
@@ -1286,6 +1384,9 @@ module Aws::States
1286
1384
  #
1287
1385
  # * control characters (`U+0000-001F`, `U+007F-009F`)
1288
1386
  #
1387
+ # To enable logging with CloudWatch Logs, the name should only contain
1388
+ # 0-9, A-Z, a-z, - and \_.
1389
+ #
1289
1390
  #
1290
1391
  #
1291
1392
  # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions
@@ -1330,6 +1431,8 @@ module Aws::States
1330
1431
 
1331
1432
  # Stops an execution.
1332
1433
  #
1434
+ # This API action is not supported by `EXPRESS` state machines.
1435
+ #
1333
1436
  # @option params [required, String] :execution_arn
1334
1437
  # The Amazon Resource Name (ARN) of the execution to stop.
1335
1438
  #
@@ -1438,10 +1541,10 @@ module Aws::States
1438
1541
  req.send_request(options)
1439
1542
  end
1440
1543
 
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
1544
+ # Updates an existing state machine by modifying its `definition`,
1545
+ # `roleArn`, or `loggingConfiguration`. Running executions will continue
1546
+ # to use the previous `definition` and `roleArn`. You must include at
1547
+ # least one of `definition` or `roleArn` or you will receive a
1445
1548
  # `MissingRequiredParameter` error.
1446
1549
  #
1447
1550
  # <note markdown="1"> All `StartExecution` calls within a few seconds will use the updated
@@ -1466,6 +1569,8 @@ module Aws::States
1466
1569
  # The Amazon Resource Name (ARN) of the IAM role of the state machine.
1467
1570
  #
1468
1571
  # @option params [Types::LoggingConfiguration] :logging_configuration
1572
+ # The `LoggingConfiguration` data type is used to set CloudWatch Logs
1573
+ # options.
1469
1574
  #
1470
1575
  # @return [Types::UpdateStateMachineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1471
1576
  #
@@ -1516,7 +1621,7 @@ module Aws::States
1516
1621
  params: params,
1517
1622
  config: config)
1518
1623
  context[:gem_name] = 'aws-sdk-states'
1519
- context[:gem_version] = '1.24.0'
1624
+ context[:gem_version] = '1.29.1'
1520
1625
  Seahorse::Client::Request.new(handlers, context)
1521
1626
  end
1522
1627
 
@@ -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"))
@@ -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,6 @@ module Aws::States
151
188
  def message
152
189
  @message || @data[:message]
153
190
  end
154
-
155
191
  end
156
192
 
157
193
  class InvalidLoggingConfiguration < ServiceError
@@ -167,7 +203,6 @@ module Aws::States
167
203
  def message
168
204
  @message || @data[:message]
169
205
  end
170
-
171
206
  end
172
207
 
173
208
  class InvalidName < ServiceError
@@ -183,7 +218,6 @@ module Aws::States
183
218
  def message
184
219
  @message || @data[:message]
185
220
  end
186
-
187
221
  end
188
222
 
189
223
  class InvalidOutput < ServiceError
@@ -199,7 +233,6 @@ module Aws::States
199
233
  def message
200
234
  @message || @data[:message]
201
235
  end
202
-
203
236
  end
204
237
 
205
238
  class InvalidToken < ServiceError
@@ -215,7 +248,6 @@ module Aws::States
215
248
  def message
216
249
  @message || @data[:message]
217
250
  end
218
-
219
251
  end
220
252
 
221
253
  class MissingRequiredParameter < ServiceError
@@ -231,7 +263,6 @@ module Aws::States
231
263
  def message
232
264
  @message || @data[:message]
233
265
  end
234
-
235
266
  end
236
267
 
237
268
  class ResourceNotFound < ServiceError
@@ -252,7 +283,6 @@ module Aws::States
252
283
  def resource_name
253
284
  @data[:resource_name]
254
285
  end
255
-
256
286
  end
257
287
 
258
288
  class StateMachineAlreadyExists < ServiceError
@@ -268,7 +298,6 @@ module Aws::States
268
298
  def message
269
299
  @message || @data[:message]
270
300
  end
271
-
272
301
  end
273
302
 
274
303
  class StateMachineDeleting < ServiceError
@@ -284,7 +313,6 @@ module Aws::States
284
313
  def message
285
314
  @message || @data[:message]
286
315
  end
287
-
288
316
  end
289
317
 
290
318
  class StateMachineDoesNotExist < ServiceError
@@ -300,7 +328,6 @@ module Aws::States
300
328
  def message
301
329
  @message || @data[:message]
302
330
  end
303
-
304
331
  end
305
332
 
306
333
  class StateMachineLimitExceeded < ServiceError
@@ -316,7 +343,6 @@ module Aws::States
316
343
  def message
317
344
  @message || @data[:message]
318
345
  end
319
-
320
346
  end
321
347
 
322
348
  class StateMachineTypeNotSupported < ServiceError
@@ -332,7 +358,6 @@ module Aws::States
332
358
  def message
333
359
  @message || @data[:message]
334
360
  end
335
-
336
361
  end
337
362
 
338
363
  class TaskDoesNotExist < ServiceError
@@ -348,7 +373,6 @@ module Aws::States
348
373
  def message
349
374
  @message || @data[:message]
350
375
  end
351
-
352
376
  end
353
377
 
354
378
  class TaskTimedOut < ServiceError
@@ -364,7 +388,6 @@ module Aws::States
364
388
  def message
365
389
  @message || @data[:message]
366
390
  end
367
-
368
391
  end
369
392
 
370
393
  class TooManyTags < ServiceError
@@ -385,7 +408,6 @@ module Aws::States
385
408
  def resource_name
386
409
  @data[:resource_name]
387
410
  end
388
-
389
411
  end
390
412
 
391
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
@@ -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.29.1
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-06-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.71.0
22
+ version: 3.99.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.71.0
32
+ version: 3.99.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -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