aws-sdk-states 1.32.0 → 1.38.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-states.rb +2 -1
- data/lib/aws-sdk-states/client.rb +133 -7
- data/lib/aws-sdk-states/client_api.rb +93 -1
- data/lib/aws-sdk-states/errors.rb +16 -0
- data/lib/aws-sdk-states/types.rb +387 -32
- metadata +4 -4
@@ -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
|
data/lib/aws-sdk-states/types.rb
CHANGED
@@ -122,9 +122,14 @@ module Aws::States
|
|
122
122
|
# @return [String]
|
123
123
|
#
|
124
124
|
# @!attribute [rw] input
|
125
|
-
# The JSON data input to the activity task.
|
125
|
+
# The JSON data input to the activity task. Length constraints apply
|
126
|
+
# to the payload size, and are expressed as bytes in UTF-8 encoding.
|
126
127
|
# @return [String]
|
127
128
|
#
|
129
|
+
# @!attribute [rw] input_details
|
130
|
+
# Contains details about the input for an execution history event.
|
131
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
132
|
+
#
|
128
133
|
# @!attribute [rw] timeout_in_seconds
|
129
134
|
# The maximum allowed duration of the activity task.
|
130
135
|
# @return [Integer]
|
@@ -139,6 +144,7 @@ module Aws::States
|
|
139
144
|
class ActivityScheduledEventDetails < Struct.new(
|
140
145
|
:resource,
|
141
146
|
:input,
|
147
|
+
:input_details,
|
142
148
|
:timeout_in_seconds,
|
143
149
|
:heartbeat_in_seconds)
|
144
150
|
SENSITIVE = [:input]
|
@@ -164,13 +170,19 @@ module Aws::States
|
|
164
170
|
# an execution.
|
165
171
|
#
|
166
172
|
# @!attribute [rw] output
|
167
|
-
# The JSON data output by the activity task.
|
173
|
+
# The JSON data output by the activity task. Length constraints apply
|
174
|
+
# to the payload size, and are expressed as bytes in UTF-8 encoding.
|
168
175
|
# @return [String]
|
169
176
|
#
|
177
|
+
# @!attribute [rw] output_details
|
178
|
+
# Contains details about the output of an execution history event.
|
179
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
180
|
+
#
|
170
181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ActivitySucceededEventDetails AWS API Documentation
|
171
182
|
#
|
172
183
|
class ActivitySucceededEventDetails < Struct.new(
|
173
|
-
:output
|
184
|
+
:output,
|
185
|
+
:output_details)
|
174
186
|
SENSITIVE = [:output]
|
175
187
|
include Aws::Structure
|
176
188
|
end
|
@@ -209,6 +221,40 @@ module Aws::States
|
|
209
221
|
include Aws::Structure
|
210
222
|
end
|
211
223
|
|
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.
|
244
|
+
#
|
245
|
+
# @!attribute [rw] included
|
246
|
+
# Indicates whether input or output was included in the response.
|
247
|
+
# Always `true` for API calls.
|
248
|
+
# @return [Boolean]
|
249
|
+
#
|
250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CloudWatchEventsExecutionDataDetails AWS API Documentation
|
251
|
+
#
|
252
|
+
class CloudWatchEventsExecutionDataDetails < Struct.new(
|
253
|
+
:included)
|
254
|
+
SENSITIVE = []
|
255
|
+
include Aws::Structure
|
256
|
+
end
|
257
|
+
|
212
258
|
# @note When making an API call, you may pass CloudWatchLogsLogGroup
|
213
259
|
# data as a hash:
|
214
260
|
#
|
@@ -335,6 +381,9 @@ module Aws::States
|
|
335
381
|
# value: "TagValue",
|
336
382
|
# },
|
337
383
|
# ],
|
384
|
+
# tracing_configuration: {
|
385
|
+
# enabled: false,
|
386
|
+
# },
|
338
387
|
# }
|
339
388
|
#
|
340
389
|
# @!attribute [rw] name
|
@@ -406,6 +455,10 @@ module Aws::States
|
|
406
455
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html
|
407
456
|
# @return [Array<Types::Tag>]
|
408
457
|
#
|
458
|
+
# @!attribute [rw] tracing_configuration
|
459
|
+
# Selects whether AWS X-Ray tracing is enabled.
|
460
|
+
# @return [Types::TracingConfiguration]
|
461
|
+
#
|
409
462
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachineInput AWS API Documentation
|
410
463
|
#
|
411
464
|
class CreateStateMachineInput < Struct.new(
|
@@ -414,7 +467,8 @@ module Aws::States
|
|
414
467
|
:role_arn,
|
415
468
|
:type,
|
416
469
|
:logging_configuration,
|
417
|
-
:tags
|
470
|
+
:tags,
|
471
|
+
:tracing_configuration)
|
418
472
|
SENSITIVE = [:definition]
|
419
473
|
include Aws::Structure
|
420
474
|
end
|
@@ -559,7 +613,7 @@ module Aws::States
|
|
559
613
|
end
|
560
614
|
|
561
615
|
# @!attribute [rw] execution_arn
|
562
|
-
# The Amazon Resource Name (ARN) that
|
616
|
+
# The Amazon Resource Name (ARN) that identifies the execution.
|
563
617
|
# @return [String]
|
564
618
|
#
|
565
619
|
# @!attribute [rw] state_machine_arn
|
@@ -599,10 +653,17 @@ module Aws::States
|
|
599
653
|
#
|
600
654
|
# @!attribute [rw] input
|
601
655
|
# The string that contains the JSON input data of the execution.
|
656
|
+
# Length constraints apply to the payload size, and are expressed as
|
657
|
+
# bytes in UTF-8 encoding.
|
602
658
|
# @return [String]
|
603
659
|
#
|
660
|
+
# @!attribute [rw] input_details
|
661
|
+
# Provides details about execution input or output.
|
662
|
+
# @return [Types::CloudWatchEventsExecutionDataDetails]
|
663
|
+
#
|
604
664
|
# @!attribute [rw] output
|
605
|
-
# The JSON output data of the execution.
|
665
|
+
# The JSON output data of the execution. Length constraints apply to
|
666
|
+
# the payload size, and are expressed as bytes in UTF-8 encoding.
|
606
667
|
#
|
607
668
|
# <note markdown="1"> This field is set only if the execution succeeds. If the execution
|
608
669
|
# fails, this field is null.
|
@@ -610,6 +671,14 @@ module Aws::States
|
|
610
671
|
# </note>
|
611
672
|
# @return [String]
|
612
673
|
#
|
674
|
+
# @!attribute [rw] output_details
|
675
|
+
# Provides details about execution input or output.
|
676
|
+
# @return [Types::CloudWatchEventsExecutionDataDetails]
|
677
|
+
#
|
678
|
+
# @!attribute [rw] trace_header
|
679
|
+
# The AWS X-Ray trace header that was passed to the execution.
|
680
|
+
# @return [String]
|
681
|
+
#
|
613
682
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecutionOutput AWS API Documentation
|
614
683
|
#
|
615
684
|
class DescribeExecutionOutput < Struct.new(
|
@@ -620,7 +689,10 @@ module Aws::States
|
|
620
689
|
:start_date,
|
621
690
|
:stop_date,
|
622
691
|
:input,
|
623
|
-
:
|
692
|
+
:input_details,
|
693
|
+
:output,
|
694
|
+
:output_details,
|
695
|
+
:trace_header)
|
624
696
|
SENSITIVE = [:input, :output]
|
625
697
|
include Aws::Structure
|
626
698
|
end
|
@@ -679,6 +751,10 @@ module Aws::States
|
|
679
751
|
# options.
|
680
752
|
# @return [Types::LoggingConfiguration]
|
681
753
|
#
|
754
|
+
# @!attribute [rw] tracing_configuration
|
755
|
+
# Selects whether AWS X-Ray tracing is enabled.
|
756
|
+
# @return [Types::TracingConfiguration]
|
757
|
+
#
|
682
758
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecutionOutput AWS API Documentation
|
683
759
|
#
|
684
760
|
class DescribeStateMachineForExecutionOutput < Struct.new(
|
@@ -687,7 +763,8 @@ module Aws::States
|
|
687
763
|
:definition,
|
688
764
|
:role_arn,
|
689
765
|
:update_date,
|
690
|
-
:logging_configuration
|
766
|
+
:logging_configuration,
|
767
|
+
:tracing_configuration)
|
691
768
|
SENSITIVE = [:definition]
|
692
769
|
include Aws::Structure
|
693
770
|
end
|
@@ -766,6 +843,10 @@ module Aws::States
|
|
766
843
|
# options.
|
767
844
|
# @return [Types::LoggingConfiguration]
|
768
845
|
#
|
846
|
+
# @!attribute [rw] tracing_configuration
|
847
|
+
# Selects whether AWS X-Ray tracing is enabled.
|
848
|
+
# @return [Types::TracingConfiguration]
|
849
|
+
#
|
769
850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineOutput AWS API Documentation
|
770
851
|
#
|
771
852
|
class DescribeStateMachineOutput < Struct.new(
|
@@ -776,7 +857,8 @@ module Aws::States
|
|
776
857
|
:role_arn,
|
777
858
|
:type,
|
778
859
|
:creation_date,
|
779
|
-
:logging_configuration
|
860
|
+
:logging_configuration,
|
861
|
+
:tracing_configuration)
|
780
862
|
SENSITIVE = [:definition]
|
781
863
|
include Aws::Structure
|
782
864
|
end
|
@@ -868,7 +950,7 @@ module Aws::States
|
|
868
950
|
# Contains details about an execution.
|
869
951
|
#
|
870
952
|
# @!attribute [rw] execution_arn
|
871
|
-
# The Amazon Resource Name (ARN) that
|
953
|
+
# The Amazon Resource Name (ARN) that identifies the execution.
|
872
954
|
# @return [String]
|
873
955
|
#
|
874
956
|
# @!attribute [rw] state_machine_arn
|
@@ -922,9 +1004,14 @@ module Aws::States
|
|
922
1004
|
# Contains details about the start of the execution.
|
923
1005
|
#
|
924
1006
|
# @!attribute [rw] input
|
925
|
-
# The JSON data input to the execution.
|
1007
|
+
# The JSON data input to the execution. Length constraints apply to
|
1008
|
+
# the payload size, and are expressed as bytes in UTF-8 encoding.
|
926
1009
|
# @return [String]
|
927
1010
|
#
|
1011
|
+
# @!attribute [rw] input_details
|
1012
|
+
# Contains details about the input for an execution history event.
|
1013
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
1014
|
+
#
|
928
1015
|
# @!attribute [rw] role_arn
|
929
1016
|
# The Amazon Resource Name (ARN) of the IAM role used for executing
|
930
1017
|
# AWS Lambda tasks.
|
@@ -934,6 +1021,7 @@ module Aws::States
|
|
934
1021
|
#
|
935
1022
|
class ExecutionStartedEventDetails < Struct.new(
|
936
1023
|
:input,
|
1024
|
+
:input_details,
|
937
1025
|
:role_arn)
|
938
1026
|
SENSITIVE = [:input]
|
939
1027
|
include Aws::Structure
|
@@ -942,13 +1030,19 @@ module Aws::States
|
|
942
1030
|
# Contains details about the successful termination of the execution.
|
943
1031
|
#
|
944
1032
|
# @!attribute [rw] output
|
945
|
-
# The JSON data output by the execution.
|
1033
|
+
# The JSON data output by the execution. Length constraints apply to
|
1034
|
+
# the payload size, and are expressed as bytes in UTF-8 encoding.
|
946
1035
|
# @return [String]
|
947
1036
|
#
|
1037
|
+
# @!attribute [rw] output_details
|
1038
|
+
# Contains details about the output of an execution history event.
|
1039
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
1040
|
+
#
|
948
1041
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ExecutionSucceededEventDetails AWS API Documentation
|
949
1042
|
#
|
950
1043
|
class ExecutionSucceededEventDetails < Struct.new(
|
951
|
-
:output
|
1044
|
+
:output,
|
1045
|
+
:output_details)
|
952
1046
|
SENSITIVE = [:output]
|
953
1047
|
include Aws::Structure
|
954
1048
|
end
|
@@ -1009,7 +1103,9 @@ module Aws::States
|
|
1009
1103
|
# @return [String]
|
1010
1104
|
#
|
1011
1105
|
# @!attribute [rw] input
|
1012
|
-
# The string that contains the JSON input data for the task.
|
1106
|
+
# The string that contains the JSON input data for the task. Length
|
1107
|
+
# constraints apply to the payload size, and are expressed as bytes in
|
1108
|
+
# UTF-8 encoding.
|
1013
1109
|
# @return [String]
|
1014
1110
|
#
|
1015
1111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTaskOutput AWS API Documentation
|
@@ -1029,6 +1125,7 @@ module Aws::States
|
|
1029
1125
|
# max_results: 1,
|
1030
1126
|
# reverse_order: false,
|
1031
1127
|
# next_token: "PageToken",
|
1128
|
+
# include_execution_data: false,
|
1032
1129
|
# }
|
1033
1130
|
#
|
1034
1131
|
# @!attribute [rw] execution_arn
|
@@ -1058,13 +1155,19 @@ module Aws::States
|
|
1058
1155
|
# return an *HTTP 400 InvalidToken* error.
|
1059
1156
|
# @return [String]
|
1060
1157
|
#
|
1158
|
+
# @!attribute [rw] include_execution_data
|
1159
|
+
# You can select whether execution data (input or output of a history
|
1160
|
+
# event) is returned. The default is `true`.
|
1161
|
+
# @return [Boolean]
|
1162
|
+
#
|
1061
1163
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistoryInput AWS API Documentation
|
1062
1164
|
#
|
1063
1165
|
class GetExecutionHistoryInput < Struct.new(
|
1064
1166
|
:execution_arn,
|
1065
1167
|
:max_results,
|
1066
1168
|
:reverse_order,
|
1067
|
-
:next_token
|
1169
|
+
:next_token,
|
1170
|
+
:include_execution_data)
|
1068
1171
|
SENSITIVE = []
|
1069
1172
|
include Aws::Structure
|
1070
1173
|
end
|
@@ -1291,6 +1394,21 @@ module Aws::States
|
|
1291
1394
|
include Aws::Structure
|
1292
1395
|
end
|
1293
1396
|
|
1397
|
+
# Provides details about input or output in an execution history event.
|
1398
|
+
#
|
1399
|
+
# @!attribute [rw] truncated
|
1400
|
+
# Indicates whether input or output was truncated in the response.
|
1401
|
+
# Always `false` for API calls.
|
1402
|
+
# @return [Boolean]
|
1403
|
+
#
|
1404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/HistoryEventExecutionDataDetails AWS API Documentation
|
1405
|
+
#
|
1406
|
+
class HistoryEventExecutionDataDetails < Struct.new(
|
1407
|
+
:truncated)
|
1408
|
+
SENSITIVE = []
|
1409
|
+
include Aws::Structure
|
1410
|
+
end
|
1411
|
+
|
1294
1412
|
# The provided Amazon Resource Name (ARN) is invalid.
|
1295
1413
|
#
|
1296
1414
|
# @!attribute [rw] message
|
@@ -1380,6 +1498,20 @@ module Aws::States
|
|
1380
1498
|
include Aws::Structure
|
1381
1499
|
end
|
1382
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
|
+
|
1383
1515
|
# Contains details about a lambda function that failed during an
|
1384
1516
|
# execution.
|
1385
1517
|
#
|
@@ -1428,9 +1560,14 @@ module Aws::States
|
|
1428
1560
|
# @return [String]
|
1429
1561
|
#
|
1430
1562
|
# @!attribute [rw] input
|
1431
|
-
# The JSON data input to the lambda function.
|
1563
|
+
# The JSON data input to the lambda function. Length constraints apply
|
1564
|
+
# to the payload size, and are expressed as bytes in UTF-8 encoding.
|
1432
1565
|
# @return [String]
|
1433
1566
|
#
|
1567
|
+
# @!attribute [rw] input_details
|
1568
|
+
# Contains details about input for an execution history event.
|
1569
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
1570
|
+
#
|
1434
1571
|
# @!attribute [rw] timeout_in_seconds
|
1435
1572
|
# The maximum allowed duration of the lambda function.
|
1436
1573
|
# @return [Integer]
|
@@ -1440,6 +1577,7 @@ module Aws::States
|
|
1440
1577
|
class LambdaFunctionScheduledEventDetails < Struct.new(
|
1441
1578
|
:resource,
|
1442
1579
|
:input,
|
1580
|
+
:input_details,
|
1443
1581
|
:timeout_in_seconds)
|
1444
1582
|
SENSITIVE = [:input]
|
1445
1583
|
include Aws::Structure
|
@@ -1469,13 +1607,20 @@ module Aws::States
|
|
1469
1607
|
# during an execution.
|
1470
1608
|
#
|
1471
1609
|
# @!attribute [rw] output
|
1472
|
-
# The JSON data output by the lambda function.
|
1610
|
+
# The JSON data output by the lambda function. Length constraints
|
1611
|
+
# apply to the payload size, and are expressed as bytes in UTF-8
|
1612
|
+
# encoding.
|
1473
1613
|
# @return [String]
|
1474
1614
|
#
|
1615
|
+
# @!attribute [rw] output_details
|
1616
|
+
# Contains details about the output of an execution history event.
|
1617
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
1618
|
+
#
|
1475
1619
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/LambdaFunctionSucceededEventDetails AWS API Documentation
|
1476
1620
|
#
|
1477
1621
|
class LambdaFunctionSucceededEventDetails < Struct.new(
|
1478
|
-
:output
|
1622
|
+
:output,
|
1623
|
+
:output_details)
|
1479
1624
|
SENSITIVE = [:output]
|
1480
1625
|
include Aws::Structure
|
1481
1626
|
end
|
@@ -1769,7 +1914,7 @@ module Aws::States
|
|
1769
1914
|
#
|
1770
1915
|
# @!attribute [rw] include_execution_data
|
1771
1916
|
# Determines whether execution data is included in your log. When set
|
1772
|
-
# to `
|
1917
|
+
# to `false`, data is excluded.
|
1773
1918
|
# @return [Boolean]
|
1774
1919
|
#
|
1775
1920
|
# @!attribute [rw] destinations
|
@@ -1945,7 +2090,8 @@ module Aws::States
|
|
1945
2090
|
# @return [String]
|
1946
2091
|
#
|
1947
2092
|
# @!attribute [rw] output
|
1948
|
-
# The JSON output of the task.
|
2093
|
+
# The JSON output of the task. Length constraints apply to the payload
|
2094
|
+
# size, and are expressed as bytes in UTF-8 encoding.
|
1949
2095
|
# @return [String]
|
1950
2096
|
#
|
1951
2097
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccessInput AWS API Documentation
|
@@ -1968,6 +2114,7 @@ module Aws::States
|
|
1968
2114
|
# state_machine_arn: "Arn", # required
|
1969
2115
|
# name: "Name",
|
1970
2116
|
# input: "SensitiveData",
|
2117
|
+
# trace_header: "TraceHeader",
|
1971
2118
|
# }
|
1972
2119
|
#
|
1973
2120
|
# @!attribute [rw] state_machine_arn
|
@@ -2010,6 +2157,14 @@ module Aws::States
|
|
2010
2157
|
# the two braces, for example: `"input": "\{\}"`
|
2011
2158
|
#
|
2012
2159
|
# </note>
|
2160
|
+
#
|
2161
|
+
# Length constraints apply to the payload size, and are expressed as
|
2162
|
+
# bytes in UTF-8 encoding.
|
2163
|
+
# @return [String]
|
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.
|
2013
2168
|
# @return [String]
|
2014
2169
|
#
|
2015
2170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecutionInput AWS API Documentation
|
@@ -2017,13 +2172,14 @@ module Aws::States
|
|
2017
2172
|
class StartExecutionInput < Struct.new(
|
2018
2173
|
:state_machine_arn,
|
2019
2174
|
:name,
|
2020
|
-
:input
|
2175
|
+
:input,
|
2176
|
+
:trace_header)
|
2021
2177
|
SENSITIVE = [:input]
|
2022
2178
|
include Aws::Structure
|
2023
2179
|
end
|
2024
2180
|
|
2025
2181
|
# @!attribute [rw] execution_arn
|
2026
|
-
# The Amazon Resource Name (ARN) that
|
2182
|
+
# The Amazon Resource Name (ARN) that identifies the execution.
|
2027
2183
|
# @return [String]
|
2028
2184
|
#
|
2029
2185
|
# @!attribute [rw] start_date
|
@@ -2039,6 +2195,141 @@ module Aws::States
|
|
2039
2195
|
include Aws::Structure
|
2040
2196
|
end
|
2041
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
|
+
|
2042
2333
|
# Contains details about a state entered during an execution.
|
2043
2334
|
#
|
2044
2335
|
# @!attribute [rw] name
|
@@ -2046,14 +2337,21 @@ module Aws::States
|
|
2046
2337
|
# @return [String]
|
2047
2338
|
#
|
2048
2339
|
# @!attribute [rw] input
|
2049
|
-
# The string that contains the JSON input data for the state.
|
2340
|
+
# The string that contains the JSON input data for the state. Length
|
2341
|
+
# constraints apply to the payload size, and are expressed as bytes in
|
2342
|
+
# UTF-8 encoding.
|
2050
2343
|
# @return [String]
|
2051
2344
|
#
|
2345
|
+
# @!attribute [rw] input_details
|
2346
|
+
# Contains details about the input for an execution history event.
|
2347
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
2348
|
+
#
|
2052
2349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateEnteredEventDetails AWS API Documentation
|
2053
2350
|
#
|
2054
2351
|
class StateEnteredEventDetails < Struct.new(
|
2055
2352
|
:name,
|
2056
|
-
:input
|
2353
|
+
:input,
|
2354
|
+
:input_details)
|
2057
2355
|
SENSITIVE = [:input]
|
2058
2356
|
include Aws::Structure
|
2059
2357
|
end
|
@@ -2080,14 +2378,20 @@ module Aws::States
|
|
2080
2378
|
# @return [String]
|
2081
2379
|
#
|
2082
2380
|
# @!attribute [rw] output
|
2083
|
-
# The JSON output data of the state.
|
2381
|
+
# The JSON output data of the state. Length constraints apply to the
|
2382
|
+
# payload size, and are expressed as bytes in UTF-8 encoding.
|
2084
2383
|
# @return [String]
|
2085
2384
|
#
|
2385
|
+
# @!attribute [rw] output_details
|
2386
|
+
# Contains details about the output of an execution history event.
|
2387
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
2388
|
+
#
|
2086
2389
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StateExitedEventDetails AWS API Documentation
|
2087
2390
|
#
|
2088
2391
|
class StateExitedEventDetails < Struct.new(
|
2089
2392
|
:name,
|
2090
|
-
:output
|
2393
|
+
:output,
|
2394
|
+
:output_details)
|
2091
2395
|
SENSITIVE = [:output]
|
2092
2396
|
include Aws::Structure
|
2093
2397
|
end
|
@@ -2377,12 +2681,18 @@ module Aws::States
|
|
2377
2681
|
#
|
2378
2682
|
# @!attribute [rw] parameters
|
2379
2683
|
# The JSON data passed to the resource referenced in a task state.
|
2684
|
+
# Length constraints apply to the payload size, and are expressed as
|
2685
|
+
# bytes in UTF-8 encoding.
|
2380
2686
|
# @return [String]
|
2381
2687
|
#
|
2382
2688
|
# @!attribute [rw] timeout_in_seconds
|
2383
2689
|
# The maximum allowed duration of the task.
|
2384
2690
|
# @return [Integer]
|
2385
2691
|
#
|
2692
|
+
# @!attribute [rw] heartbeat_in_seconds
|
2693
|
+
# The maximum allowed duration between two heartbeats for the task.
|
2694
|
+
# @return [Integer]
|
2695
|
+
#
|
2386
2696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/TaskScheduledEventDetails AWS API Documentation
|
2387
2697
|
#
|
2388
2698
|
class TaskScheduledEventDetails < Struct.new(
|
@@ -2390,7 +2700,8 @@ module Aws::States
|
|
2390
2700
|
:resource,
|
2391
2701
|
:region,
|
2392
2702
|
:parameters,
|
2393
|
-
:timeout_in_seconds
|
2703
|
+
:timeout_in_seconds,
|
2704
|
+
:heartbeat_in_seconds)
|
2394
2705
|
SENSITIVE = [:parameters]
|
2395
2706
|
include Aws::Structure
|
2396
2707
|
end
|
@@ -2485,15 +2796,22 @@ module Aws::States
|
|
2485
2796
|
# @return [String]
|
2486
2797
|
#
|
2487
2798
|
# @!attribute [rw] output
|
2488
|
-
# The response from a resource when a task has started.
|
2799
|
+
# The response from a resource when a task has started. Length
|
2800
|
+
# constraints apply to the payload size, and are expressed as bytes in
|
2801
|
+
# UTF-8 encoding.
|
2489
2802
|
# @return [String]
|
2490
2803
|
#
|
2804
|
+
# @!attribute [rw] output_details
|
2805
|
+
# Contains details about the output of an execution history event.
|
2806
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
2807
|
+
#
|
2491
2808
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/TaskSubmittedEventDetails AWS API Documentation
|
2492
2809
|
#
|
2493
2810
|
class TaskSubmittedEventDetails < Struct.new(
|
2494
2811
|
:resource_type,
|
2495
2812
|
:resource,
|
2496
|
-
:output
|
2813
|
+
:output,
|
2814
|
+
:output_details)
|
2497
2815
|
SENSITIVE = [:output]
|
2498
2816
|
include Aws::Structure
|
2499
2817
|
end
|
@@ -2510,15 +2828,22 @@ module Aws::States
|
|
2510
2828
|
#
|
2511
2829
|
# @!attribute [rw] output
|
2512
2830
|
# The full JSON response from a resource when a task has succeeded.
|
2513
|
-
# This response becomes the output of the related task.
|
2831
|
+
# This response becomes the output of the related task. Length
|
2832
|
+
# constraints apply to the payload size, and are expressed as bytes in
|
2833
|
+
# UTF-8 encoding.
|
2514
2834
|
# @return [String]
|
2515
2835
|
#
|
2836
|
+
# @!attribute [rw] output_details
|
2837
|
+
# Contains details about the output of an execution history event.
|
2838
|
+
# @return [Types::HistoryEventExecutionDataDetails]
|
2839
|
+
#
|
2516
2840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/TaskSucceededEventDetails AWS API Documentation
|
2517
2841
|
#
|
2518
2842
|
class TaskSucceededEventDetails < Struct.new(
|
2519
2843
|
:resource_type,
|
2520
2844
|
:resource,
|
2521
|
-
:output
|
2845
|
+
:output,
|
2846
|
+
:output_details)
|
2522
2847
|
SENSITIVE = [:output]
|
2523
2848
|
include Aws::Structure
|
2524
2849
|
end
|
@@ -2586,6 +2911,28 @@ module Aws::States
|
|
2586
2911
|
include Aws::Structure
|
2587
2912
|
end
|
2588
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
|
+
|
2589
2936
|
# @note When making an API call, you may pass UntagResourceInput
|
2590
2937
|
# data as a hash:
|
2591
2938
|
#
|
@@ -2634,6 +2981,9 @@ module Aws::States
|
|
2634
2981
|
# },
|
2635
2982
|
# ],
|
2636
2983
|
# },
|
2984
|
+
# tracing_configuration: {
|
2985
|
+
# enabled: false,
|
2986
|
+
# },
|
2637
2987
|
# }
|
2638
2988
|
#
|
2639
2989
|
# @!attribute [rw] state_machine_arn
|
@@ -2658,13 +3008,18 @@ module Aws::States
|
|
2658
3008
|
# options.
|
2659
3009
|
# @return [Types::LoggingConfiguration]
|
2660
3010
|
#
|
3011
|
+
# @!attribute [rw] tracing_configuration
|
3012
|
+
# Selects whether AWS X-Ray tracing is enabled.
|
3013
|
+
# @return [Types::TracingConfiguration]
|
3014
|
+
#
|
2661
3015
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateStateMachineInput AWS API Documentation
|
2662
3016
|
#
|
2663
3017
|
class UpdateStateMachineInput < Struct.new(
|
2664
3018
|
:state_machine_arn,
|
2665
3019
|
:definition,
|
2666
3020
|
:role_arn,
|
2667
|
-
:logging_configuration
|
3021
|
+
:logging_configuration,
|
3022
|
+
:tracing_configuration)
|
2668
3023
|
SENSITIVE = [:definition]
|
2669
3024
|
include Aws::Structure
|
2670
3025
|
end
|