aws-sdk-states 1.33.0 → 1.39.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -40,6 +40,7 @@ module Aws::States
40
40
  # * {InvalidName}
41
41
  # * {InvalidOutput}
42
42
  # * {InvalidToken}
43
+ # * {InvalidTracingConfiguration}
43
44
  # * {MissingRequiredParameter}
44
45
  # * {ResourceNotFound}
45
46
  # * {StateMachineAlreadyExists}
@@ -252,6 +253,21 @@ module Aws::States
252
253
  end
253
254
  end
254
255
 
256
+ class InvalidTracingConfiguration < ServiceError
257
+
258
+ # @param [Seahorse::Client::RequestContext] context
259
+ # @param [String] message
260
+ # @param [Aws::States::Types::InvalidTracingConfiguration] data
261
+ def initialize(context, message, data = Aws::EmptyStructure.new)
262
+ super(context, message, data)
263
+ end
264
+
265
+ # @return [String]
266
+ def message
267
+ @message || @data[:message]
268
+ end
269
+ end
270
+
255
271
  class MissingRequiredParameter < ServiceError
256
272
 
257
273
  # @param [Seahorse::Client::RequestContext] context
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -221,12 +221,30 @@ module Aws::States
221
221
  include Aws::Structure
222
222
  end
223
223
 
224
- # Provides details about execution input.
224
+ # An object that describes workflow billing details.
225
+ #
226
+ # @!attribute [rw] billed_memory_used_in_mb
227
+ # Billed memory consumption of your workflow, in MB.
228
+ # @return [Integer]
229
+ #
230
+ # @!attribute [rw] billed_duration_in_milliseconds
231
+ # Billed duration of your workflow, in milliseconds.
232
+ # @return [Integer]
233
+ #
234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/BillingDetails AWS API Documentation
235
+ #
236
+ class BillingDetails < Struct.new(
237
+ :billed_memory_used_in_mb,
238
+ :billed_duration_in_milliseconds)
239
+ SENSITIVE = []
240
+ include Aws::Structure
241
+ end
242
+
243
+ # Provides details about execution input or output.
225
244
  #
226
245
  # @!attribute [rw] included
227
246
  # Indicates whether input or output was included in the response.
228
- # Always `true` for API calls, but may be `false` for CloudWatch
229
- # Events.
247
+ # Always `true` for API calls.
230
248
  # @return [Boolean]
231
249
  #
232
250
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CloudWatchEventsExecutionDataDetails AWS API Documentation
@@ -363,6 +381,9 @@ module Aws::States
363
381
  # value: "TagValue",
364
382
  # },
365
383
  # ],
384
+ # tracing_configuration: {
385
+ # enabled: false,
386
+ # },
366
387
  # }
367
388
  #
368
389
  # @!attribute [rw] name
@@ -434,6 +455,10 @@ module Aws::States
434
455
  # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html
435
456
  # @return [Array<Types::Tag>]
436
457
  #
458
+ # @!attribute [rw] tracing_configuration
459
+ # Selects whether AWS X-Ray tracing is enabled.
460
+ # @return [Types::TracingConfiguration]
461
+ #
437
462
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineInput AWS API Documentation
438
463
  #
439
464
  class CreateStateMachineInput < Struct.new(
@@ -442,7 +467,8 @@ module Aws::States
442
467
  :role_arn,
443
468
  :type,
444
469
  :logging_configuration,
445
- :tags)
470
+ :tags,
471
+ :tracing_configuration)
446
472
  SENSITIVE = [:definition]
447
473
  include Aws::Structure
448
474
  end
@@ -587,7 +613,7 @@ module Aws::States
587
613
  end
588
614
 
589
615
  # @!attribute [rw] execution_arn
590
- # The Amazon Resource Name (ARN) that id entifies the execution.
616
+ # The Amazon Resource Name (ARN) that identifies the execution.
591
617
  # @return [String]
592
618
  #
593
619
  # @!attribute [rw] state_machine_arn
@@ -632,7 +658,7 @@ module Aws::States
632
658
  # @return [String]
633
659
  #
634
660
  # @!attribute [rw] input_details
635
- # Provides details about execution input.
661
+ # Provides details about execution input or output.
636
662
  # @return [Types::CloudWatchEventsExecutionDataDetails]
637
663
  #
638
664
  # @!attribute [rw] output
@@ -646,9 +672,13 @@ module Aws::States
646
672
  # @return [String]
647
673
  #
648
674
  # @!attribute [rw] output_details
649
- # Provides details about execution input.
675
+ # Provides details about execution input or output.
650
676
  # @return [Types::CloudWatchEventsExecutionDataDetails]
651
677
  #
678
+ # @!attribute [rw] trace_header
679
+ # The AWS X-Ray trace header that was passed to the execution.
680
+ # @return [String]
681
+ #
652
682
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecutionOutput AWS API Documentation
653
683
  #
654
684
  class DescribeExecutionOutput < Struct.new(
@@ -661,7 +691,8 @@ module Aws::States
661
691
  :input,
662
692
  :input_details,
663
693
  :output,
664
- :output_details)
694
+ :output_details,
695
+ :trace_header)
665
696
  SENSITIVE = [:input, :output]
666
697
  include Aws::Structure
667
698
  end
@@ -720,6 +751,10 @@ module Aws::States
720
751
  # options.
721
752
  # @return [Types::LoggingConfiguration]
722
753
  #
754
+ # @!attribute [rw] tracing_configuration
755
+ # Selects whether AWS X-Ray tracing is enabled.
756
+ # @return [Types::TracingConfiguration]
757
+ #
723
758
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecutionOutput AWS API Documentation
724
759
  #
725
760
  class DescribeStateMachineForExecutionOutput < Struct.new(
@@ -728,7 +763,8 @@ module Aws::States
728
763
  :definition,
729
764
  :role_arn,
730
765
  :update_date,
731
- :logging_configuration)
766
+ :logging_configuration,
767
+ :tracing_configuration)
732
768
  SENSITIVE = [:definition]
733
769
  include Aws::Structure
734
770
  end
@@ -807,6 +843,10 @@ module Aws::States
807
843
  # options.
808
844
  # @return [Types::LoggingConfiguration]
809
845
  #
846
+ # @!attribute [rw] tracing_configuration
847
+ # Selects whether AWS X-Ray tracing is enabled.
848
+ # @return [Types::TracingConfiguration]
849
+ #
810
850
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineOutput AWS API Documentation
811
851
  #
812
852
  class DescribeStateMachineOutput < Struct.new(
@@ -817,7 +857,8 @@ module Aws::States
817
857
  :role_arn,
818
858
  :type,
819
859
  :creation_date,
820
- :logging_configuration)
860
+ :logging_configuration,
861
+ :tracing_configuration)
821
862
  SENSITIVE = [:definition]
822
863
  include Aws::Structure
823
864
  end
@@ -909,7 +950,7 @@ module Aws::States
909
950
  # Contains details about an execution.
910
951
  #
911
952
  # @!attribute [rw] execution_arn
912
- # The Amazon Resource Name (ARN) that id entifies the execution.
953
+ # The Amazon Resource Name (ARN) that identifies the execution.
913
954
  # @return [String]
914
955
  #
915
956
  # @!attribute [rw] state_machine_arn
@@ -1353,12 +1394,11 @@ module Aws::States
1353
1394
  include Aws::Structure
1354
1395
  end
1355
1396
 
1356
- # Contains details about the data from an execution's events. Always
1357
- # `true` for API calls, but may be `false` for CloudWatch Logs.
1397
+ # Provides details about input or output in an execution history event.
1358
1398
  #
1359
1399
  # @!attribute [rw] truncated
1360
1400
  # Indicates whether input or output was truncated in the response.
1361
- # Always `false`.
1401
+ # Always `false` for API calls.
1362
1402
  # @return [Boolean]
1363
1403
  #
1364
1404
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/HistoryEventExecutionDataDetails AWS API Documentation
@@ -1458,6 +1498,20 @@ module Aws::States
1458
1498
  include Aws::Structure
1459
1499
  end
1460
1500
 
1501
+ # Your `tracingConfiguration` key does not match, or `enabled` has not
1502
+ # been set to `true` or `false`.
1503
+ #
1504
+ # @!attribute [rw] message
1505
+ # @return [String]
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/InvalidTracingConfiguration AWS API Documentation
1508
+ #
1509
+ class InvalidTracingConfiguration < Struct.new(
1510
+ :message)
1511
+ SENSITIVE = []
1512
+ include Aws::Structure
1513
+ end
1514
+
1461
1515
  # Contains details about a lambda function that failed during an
1462
1516
  # execution.
1463
1517
  #
@@ -2060,6 +2114,7 @@ module Aws::States
2060
2114
  # state_machine_arn: "Arn", # required
2061
2115
  # name: "Name",
2062
2116
  # input: "SensitiveData",
2117
+ # trace_header: "TraceHeader",
2063
2118
  # }
2064
2119
  #
2065
2120
  # @!attribute [rw] state_machine_arn
@@ -2107,18 +2162,24 @@ module Aws::States
2107
2162
  # bytes in UTF-8 encoding.
2108
2163
  # @return [String]
2109
2164
  #
2165
+ # @!attribute [rw] trace_header
2166
+ # Passes the AWS X-Ray trace header. The trace header can also be
2167
+ # passed in the request payload.
2168
+ # @return [String]
2169
+ #
2110
2170
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionInput AWS API Documentation
2111
2171
  #
2112
2172
  class StartExecutionInput < Struct.new(
2113
2173
  :state_machine_arn,
2114
2174
  :name,
2115
- :input)
2175
+ :input,
2176
+ :trace_header)
2116
2177
  SENSITIVE = [:input]
2117
2178
  include Aws::Structure
2118
2179
  end
2119
2180
 
2120
2181
  # @!attribute [rw] execution_arn
2121
- # The Amazon Resource Name (ARN) that id entifies the execution.
2182
+ # The Amazon Resource Name (ARN) that identifies the execution.
2122
2183
  # @return [String]
2123
2184
  #
2124
2185
  # @!attribute [rw] start_date
@@ -2134,6 +2195,141 @@ module Aws::States
2134
2195
  include Aws::Structure
2135
2196
  end
2136
2197
 
2198
+ # @note When making an API call, you may pass StartSyncExecutionInput
2199
+ # data as a hash:
2200
+ #
2201
+ # {
2202
+ # state_machine_arn: "Arn", # required
2203
+ # name: "Name",
2204
+ # input: "SensitiveData",
2205
+ # trace_header: "TraceHeader",
2206
+ # }
2207
+ #
2208
+ # @!attribute [rw] state_machine_arn
2209
+ # The Amazon Resource Name (ARN) of the state machine to execute.
2210
+ # @return [String]
2211
+ #
2212
+ # @!attribute [rw] name
2213
+ # The name of the execution.
2214
+ # @return [String]
2215
+ #
2216
+ # @!attribute [rw] input
2217
+ # The string that contains the JSON input data for the execution, for
2218
+ # example:
2219
+ #
2220
+ # `"input": "\{"first_name" : "test"\}"`
2221
+ #
2222
+ # <note markdown="1"> If you don't include any JSON input data, you still must include
2223
+ # the two braces, for example: `"input": "\{\}"`
2224
+ #
2225
+ # </note>
2226
+ #
2227
+ # Length constraints apply to the payload size, and are expressed as
2228
+ # bytes in UTF-8 encoding.
2229
+ # @return [String]
2230
+ #
2231
+ # @!attribute [rw] trace_header
2232
+ # Passes the AWS X-Ray trace header. The trace header can also be
2233
+ # passed in the request payload.
2234
+ # @return [String]
2235
+ #
2236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartSyncExecutionInput AWS API Documentation
2237
+ #
2238
+ class StartSyncExecutionInput < Struct.new(
2239
+ :state_machine_arn,
2240
+ :name,
2241
+ :input,
2242
+ :trace_header)
2243
+ SENSITIVE = [:input]
2244
+ include Aws::Structure
2245
+ end
2246
+
2247
+ # @!attribute [rw] execution_arn
2248
+ # The Amazon Resource Name (ARN) that identifies the execution.
2249
+ # @return [String]
2250
+ #
2251
+ # @!attribute [rw] state_machine_arn
2252
+ # The Amazon Resource Name (ARN) that identifies the state machine.
2253
+ # @return [String]
2254
+ #
2255
+ # @!attribute [rw] name
2256
+ # The name of the execution.
2257
+ # @return [String]
2258
+ #
2259
+ # @!attribute [rw] start_date
2260
+ # The date the execution is started.
2261
+ # @return [Time]
2262
+ #
2263
+ # @!attribute [rw] stop_date
2264
+ # If the execution has already ended, the date the execution stopped.
2265
+ # @return [Time]
2266
+ #
2267
+ # @!attribute [rw] status
2268
+ # The current status of the execution.
2269
+ # @return [String]
2270
+ #
2271
+ # @!attribute [rw] error
2272
+ # The error code of the failure.
2273
+ # @return [String]
2274
+ #
2275
+ # @!attribute [rw] cause
2276
+ # A more detailed explanation of the cause of the failure.
2277
+ # @return [String]
2278
+ #
2279
+ # @!attribute [rw] input
2280
+ # The string that contains the JSON input data of the execution.
2281
+ # Length constraints apply to the payload size, and are expressed as
2282
+ # bytes in UTF-8 encoding.
2283
+ # @return [String]
2284
+ #
2285
+ # @!attribute [rw] input_details
2286
+ # Provides details about execution input or output.
2287
+ # @return [Types::CloudWatchEventsExecutionDataDetails]
2288
+ #
2289
+ # @!attribute [rw] output
2290
+ # The JSON output data of the execution. Length constraints apply to
2291
+ # the payload size, and are expressed as bytes in UTF-8 encoding.
2292
+ #
2293
+ # <note markdown="1"> This field is set only if the execution succeeds. If the execution
2294
+ # fails, this field is null.
2295
+ #
2296
+ # </note>
2297
+ # @return [String]
2298
+ #
2299
+ # @!attribute [rw] output_details
2300
+ # Provides details about execution input or output.
2301
+ # @return [Types::CloudWatchEventsExecutionDataDetails]
2302
+ #
2303
+ # @!attribute [rw] trace_header
2304
+ # The AWS X-Ray trace header that was passed to the execution.
2305
+ # @return [String]
2306
+ #
2307
+ # @!attribute [rw] billing_details
2308
+ # An object that describes workflow billing details, including billed
2309
+ # duration and memory use.
2310
+ # @return [Types::BillingDetails]
2311
+ #
2312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartSyncExecutionOutput AWS API Documentation
2313
+ #
2314
+ class StartSyncExecutionOutput < Struct.new(
2315
+ :execution_arn,
2316
+ :state_machine_arn,
2317
+ :name,
2318
+ :start_date,
2319
+ :stop_date,
2320
+ :status,
2321
+ :error,
2322
+ :cause,
2323
+ :input,
2324
+ :input_details,
2325
+ :output,
2326
+ :output_details,
2327
+ :trace_header,
2328
+ :billing_details)
2329
+ SENSITIVE = [:error, :cause, :input, :output]
2330
+ include Aws::Structure
2331
+ end
2332
+
2137
2333
  # Contains details about a state entered during an execution.
2138
2334
  #
2139
2335
  # @!attribute [rw] name
@@ -2715,6 +2911,28 @@ module Aws::States
2715
2911
  include Aws::Structure
2716
2912
  end
2717
2913
 
2914
+ # Selects whether or not the state machine's AWS X-Ray tracing is
2915
+ # enabled. Default is `false`
2916
+ #
2917
+ # @note When making an API call, you may pass TracingConfiguration
2918
+ # data as a hash:
2919
+ #
2920
+ # {
2921
+ # enabled: false,
2922
+ # }
2923
+ #
2924
+ # @!attribute [rw] enabled
2925
+ # When set to `true`, AWS X-Ray tracing is enabled.
2926
+ # @return [Boolean]
2927
+ #
2928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/TracingConfiguration AWS API Documentation
2929
+ #
2930
+ class TracingConfiguration < Struct.new(
2931
+ :enabled)
2932
+ SENSITIVE = []
2933
+ include Aws::Structure
2934
+ end
2935
+
2718
2936
  # @note When making an API call, you may pass UntagResourceInput
2719
2937
  # data as a hash:
2720
2938
  #
@@ -2763,6 +2981,9 @@ module Aws::States
2763
2981
  # },
2764
2982
  # ],
2765
2983
  # },
2984
+ # tracing_configuration: {
2985
+ # enabled: false,
2986
+ # },
2766
2987
  # }
2767
2988
  #
2768
2989
  # @!attribute [rw] state_machine_arn
@@ -2787,13 +3008,18 @@ module Aws::States
2787
3008
  # options.
2788
3009
  # @return [Types::LoggingConfiguration]
2789
3010
  #
3011
+ # @!attribute [rw] tracing_configuration
3012
+ # Selects whether AWS X-Ray tracing is enabled.
3013
+ # @return [Types::TracingConfiguration]
3014
+ #
2790
3015
  # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachineInput AWS API Documentation
2791
3016
  #
2792
3017
  class UpdateStateMachineInput < Struct.new(
2793
3018
  :state_machine_arn,
2794
3019
  :definition,
2795
3020
  :role_arn,
2796
- :logging_configuration)
3021
+ :logging_configuration,
3022
+ :tracing_configuration)
2797
3023
  SENSITIVE = [:definition]
2798
3024
  include Aws::Structure
2799
3025
  end