aws-sdk-states 1.49.0 → 1.51.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-states/client.rb +309 -42
- data/lib/aws-sdk-states/client_api.rb +155 -1
- data/lib/aws-sdk-states/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-states/endpoint_provider.rb +80 -81
- data/lib/aws-sdk-states/endpoints.rb +42 -0
- data/lib/aws-sdk-states/errors.rb +21 -0
- data/lib/aws-sdk-states/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-states/types.rb +568 -351
- data/lib/aws-sdk-states.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 41a52c7f7ca5d10e0b7d71f42b5b96c8945ba2ed88dcca42807c38ea1d0ac08e
|
4
|
+
data.tar.gz: df6ae396713e880121cf250474c73a0bc81138cd5241ee77662ea0ab10da90b2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 85b0c6e9bc25c354b1feabdc2f48b9dcc9dcb6a24b1a6402ddb0405b117adcd2b35ecc70492b0397a52f1e03a1c757a8cd05298b72e933e1ae57c3ec350ff707
|
7
|
+
data.tar.gz: 64f5a0472f54313332d6b95cde5a8653a924a46b04815ea58c437e7451f1486b3ce7c89927aff4666a7f8b727b101fe13781f417e0ddd2d955bbd07c7239e970
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.51.0 (2022-12-01)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for the AWS Step Functions Map state in Distributed mode. The changes include a new MapRun resource and several new and modified APIs.
|
8
|
+
|
9
|
+
1.50.0 (2022-11-18)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds support for using Step Functions service integrations to invoke any cross-account AWS resource, even if that service doesn't support resource-based policies or cross-account calls. See https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
|
13
|
+
|
4
14
|
1.49.0 (2022-10-25)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.51.0
|
@@ -379,8 +379,8 @@ module Aws::States
|
|
379
379
|
# @!group API Operations
|
380
380
|
|
381
381
|
# Creates an activity. An activity is a task that you write in any
|
382
|
-
# programming language and host on any machine that has access to
|
383
|
-
#
|
382
|
+
# programming language and host on any machine that has access to Step
|
383
|
+
# Functions. Activities must poll Step Functions using the
|
384
384
|
# `GetActivityTask` API action and respond using `SendTask*` API
|
385
385
|
# actions. This function lets Step Functions know the existence of your
|
386
386
|
# activity and returns an identifier for use in a state machine and when
|
@@ -403,9 +403,9 @@ module Aws::States
|
|
403
403
|
#
|
404
404
|
# @option params [required, String] :name
|
405
405
|
# The name of the activity to create. This name must be unique for your
|
406
|
-
#
|
407
|
-
# Related to State Machine Executions][1] in
|
408
|
-
# Developer Guide*.
|
406
|
+
# Amazon Web Services account and region for 90 days. For more
|
407
|
+
# information, see [ Limits Related to State Machine Executions][1] in
|
408
|
+
# the *Step Functions Developer Guide*.
|
409
409
|
#
|
410
410
|
# A name must *not* contain:
|
411
411
|
#
|
@@ -430,8 +430,8 @@ module Aws::States
|
|
430
430
|
# The list of tags to add to a resource.
|
431
431
|
#
|
432
432
|
# An array of key-value pairs. For more information, see [Using Cost
|
433
|
-
# Allocation Tags][1] in the *
|
434
|
-
# Guide*, and [Controlling Access Using IAM Tags][2].
|
433
|
+
# Allocation Tags][1] in the *Amazon Web Services Billing and Cost
|
434
|
+
# Management User Guide*, and [Controlling Access Using IAM Tags][2].
|
435
435
|
#
|
436
436
|
# Tags may only contain Unicode letters, digits, white space, or these
|
437
437
|
# symbols: `_ . : / = + - @`.
|
@@ -477,7 +477,7 @@ module Aws::States
|
|
477
477
|
# transition next (`Choice` states), stop an execution with an error
|
478
478
|
# (`Fail` states), and so on. State machines are specified using a
|
479
479
|
# JSON-based, structured language. For more information, see [Amazon
|
480
|
-
# States Language][1] in the
|
480
|
+
# States Language][1] in the Step Functions User Guide.
|
481
481
|
#
|
482
482
|
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
483
483
|
# and may not reflect very recent updates and changes.
|
@@ -539,7 +539,7 @@ module Aws::States
|
|
539
539
|
# logged.
|
540
540
|
#
|
541
541
|
# <note markdown="1"> By default, the `level` is set to `OFF`. For more information see [Log
|
542
|
-
# Levels][1] in the
|
542
|
+
# Levels][1] in the Step Functions User Guide.
|
543
543
|
#
|
544
544
|
# </note>
|
545
545
|
#
|
@@ -551,8 +551,8 @@ module Aws::States
|
|
551
551
|
# Tags to be added when creating a state machine.
|
552
552
|
#
|
553
553
|
# An array of key-value pairs. For more information, see [Using Cost
|
554
|
-
# Allocation Tags][1] in the *
|
555
|
-
# Guide*, and [Controlling Access Using IAM Tags][2].
|
554
|
+
# Allocation Tags][1] in the *Amazon Web Services Billing and Cost
|
555
|
+
# Management User Guide*, and [Controlling Access Using IAM Tags][2].
|
556
556
|
#
|
557
557
|
# Tags may only contain Unicode letters, digits, white space, or these
|
558
558
|
# symbols: `_ . : / = + - @`.
|
@@ -563,7 +563,7 @@ module Aws::States
|
|
563
563
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html
|
564
564
|
#
|
565
565
|
# @option params [Types::TracingConfiguration] :tracing_configuration
|
566
|
-
# Selects whether
|
566
|
+
# Selects whether X-Ray tracing is enabled.
|
567
567
|
#
|
568
568
|
# @return [Types::CreateStateMachineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
569
569
|
#
|
@@ -639,7 +639,17 @@ module Aws::States
|
|
639
639
|
# the state machine's status to `DELETING` and begins the deletion
|
640
640
|
# process.
|
641
641
|
#
|
642
|
-
#
|
642
|
+
# If the given state machine Amazon Resource Name (ARN) is a qualified
|
643
|
+
# state machine ARN, it will fail with ValidationException.
|
644
|
+
#
|
645
|
+
# A qualified state machine ARN refers to a *Distributed Map state*
|
646
|
+
# defined within a state machine. For example, the qualified state
|
647
|
+
# machine ARN
|
648
|
+
# `arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel`
|
649
|
+
# refers to a *Distributed Map state* with a label `mapStateLabel` in
|
650
|
+
# the state machine named `stateMachineName`.
|
651
|
+
#
|
652
|
+
# <note markdown="1"> For `EXPRESS` state machines, the deletion will happen eventually
|
643
653
|
# (usually less than a minute). Running executions may emit logs after
|
644
654
|
# `DeleteStateMachine` API is called.
|
645
655
|
#
|
@@ -702,14 +712,18 @@ module Aws::States
|
|
702
712
|
req.send_request(options)
|
703
713
|
end
|
704
714
|
|
705
|
-
#
|
715
|
+
# Provides all information about a state machine execution, such as the
|
716
|
+
# state machine associated with the execution, the execution input and
|
717
|
+
# output, and relevant execution metadata. Use this API action to return
|
718
|
+
# the Map Run ARN if the execution was dispatched by a Map Run.
|
706
719
|
#
|
707
720
|
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
708
721
|
# and may not reflect very recent updates and changes.
|
709
722
|
#
|
710
723
|
# </note>
|
711
724
|
#
|
712
|
-
# This API action is not supported by `EXPRESS` state
|
725
|
+
# This API action is not supported by `EXPRESS` state machine executions
|
726
|
+
# unless they were dispatched by a Map Run.
|
713
727
|
#
|
714
728
|
# @option params [required, String] :execution_arn
|
715
729
|
# The Amazon Resource Name (ARN) of the execution to describe.
|
@@ -727,6 +741,9 @@ module Aws::States
|
|
727
741
|
# * {Types::DescribeExecutionOutput#output #output} => String
|
728
742
|
# * {Types::DescribeExecutionOutput#output_details #output_details} => Types::CloudWatchEventsExecutionDataDetails
|
729
743
|
# * {Types::DescribeExecutionOutput#trace_header #trace_header} => String
|
744
|
+
# * {Types::DescribeExecutionOutput#map_run_arn #map_run_arn} => String
|
745
|
+
# * {Types::DescribeExecutionOutput#error #error} => String
|
746
|
+
# * {Types::DescribeExecutionOutput#cause #cause} => String
|
730
747
|
#
|
731
748
|
# @example Request syntax with placeholder values
|
732
749
|
#
|
@@ -747,6 +764,9 @@ module Aws::States
|
|
747
764
|
# resp.output #=> String
|
748
765
|
# resp.output_details.included #=> Boolean
|
749
766
|
# resp.trace_header #=> String
|
767
|
+
# resp.map_run_arn #=> String
|
768
|
+
# resp.error #=> String
|
769
|
+
# resp.cause #=> String
|
750
770
|
#
|
751
771
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecution AWS API Documentation
|
752
772
|
#
|
@@ -757,7 +777,83 @@ module Aws::States
|
|
757
777
|
req.send_request(options)
|
758
778
|
end
|
759
779
|
|
760
|
-
#
|
780
|
+
# Provides information about a Map Run's configuration, progress, and
|
781
|
+
# results. For more information, see [Examining Map Run][1] in the *Step
|
782
|
+
# Functions Developer Guide*.
|
783
|
+
#
|
784
|
+
#
|
785
|
+
#
|
786
|
+
# [1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html
|
787
|
+
#
|
788
|
+
# @option params [required, String] :map_run_arn
|
789
|
+
# The Amazon Resource Name (ARN) that identifies a Map Run.
|
790
|
+
#
|
791
|
+
# @return [Types::DescribeMapRunOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
792
|
+
#
|
793
|
+
# * {Types::DescribeMapRunOutput#map_run_arn #map_run_arn} => String
|
794
|
+
# * {Types::DescribeMapRunOutput#execution_arn #execution_arn} => String
|
795
|
+
# * {Types::DescribeMapRunOutput#status #status} => String
|
796
|
+
# * {Types::DescribeMapRunOutput#start_date #start_date} => Time
|
797
|
+
# * {Types::DescribeMapRunOutput#stop_date #stop_date} => Time
|
798
|
+
# * {Types::DescribeMapRunOutput#max_concurrency #max_concurrency} => Integer
|
799
|
+
# * {Types::DescribeMapRunOutput#tolerated_failure_percentage #tolerated_failure_percentage} => Float
|
800
|
+
# * {Types::DescribeMapRunOutput#tolerated_failure_count #tolerated_failure_count} => Integer
|
801
|
+
# * {Types::DescribeMapRunOutput#item_counts #item_counts} => Types::MapRunItemCounts
|
802
|
+
# * {Types::DescribeMapRunOutput#execution_counts #execution_counts} => Types::MapRunExecutionCounts
|
803
|
+
#
|
804
|
+
# @example Request syntax with placeholder values
|
805
|
+
#
|
806
|
+
# resp = client.describe_map_run({
|
807
|
+
# map_run_arn: "LongArn", # required
|
808
|
+
# })
|
809
|
+
#
|
810
|
+
# @example Response structure
|
811
|
+
#
|
812
|
+
# resp.map_run_arn #=> String
|
813
|
+
# resp.execution_arn #=> String
|
814
|
+
# resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "ABORTED"
|
815
|
+
# resp.start_date #=> Time
|
816
|
+
# resp.stop_date #=> Time
|
817
|
+
# resp.max_concurrency #=> Integer
|
818
|
+
# resp.tolerated_failure_percentage #=> Float
|
819
|
+
# resp.tolerated_failure_count #=> Integer
|
820
|
+
# resp.item_counts.pending #=> Integer
|
821
|
+
# resp.item_counts.running #=> Integer
|
822
|
+
# resp.item_counts.succeeded #=> Integer
|
823
|
+
# resp.item_counts.failed #=> Integer
|
824
|
+
# resp.item_counts.timed_out #=> Integer
|
825
|
+
# resp.item_counts.aborted #=> Integer
|
826
|
+
# resp.item_counts.total #=> Integer
|
827
|
+
# resp.item_counts.results_written #=> Integer
|
828
|
+
# resp.execution_counts.pending #=> Integer
|
829
|
+
# resp.execution_counts.running #=> Integer
|
830
|
+
# resp.execution_counts.succeeded #=> Integer
|
831
|
+
# resp.execution_counts.failed #=> Integer
|
832
|
+
# resp.execution_counts.timed_out #=> Integer
|
833
|
+
# resp.execution_counts.aborted #=> Integer
|
834
|
+
# resp.execution_counts.total #=> Integer
|
835
|
+
# resp.execution_counts.results_written #=> Integer
|
836
|
+
#
|
837
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeMapRun AWS API Documentation
|
838
|
+
#
|
839
|
+
# @overload describe_map_run(params = {})
|
840
|
+
# @param [Hash] params ({})
|
841
|
+
def describe_map_run(params = {}, options = {})
|
842
|
+
req = build_request(:describe_map_run, params)
|
843
|
+
req.send_request(options)
|
844
|
+
end
|
845
|
+
|
846
|
+
# Provides information about a state machine's definition, its IAM role
|
847
|
+
# Amazon Resource Name (ARN), and configuration. If the state machine
|
848
|
+
# ARN is a qualified state machine ARN, the response returned includes
|
849
|
+
# the `Map` state's label.
|
850
|
+
#
|
851
|
+
# A qualified state machine ARN refers to a *Distributed Map state*
|
852
|
+
# defined within a state machine. For example, the qualified state
|
853
|
+
# machine ARN
|
854
|
+
# `arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel`
|
855
|
+
# refers to a *Distributed Map state* with a label `mapStateLabel` in
|
856
|
+
# the state machine named `stateMachineName`.
|
761
857
|
#
|
762
858
|
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
763
859
|
# and may not reflect very recent updates and changes.
|
@@ -778,6 +874,7 @@ module Aws::States
|
|
778
874
|
# * {Types::DescribeStateMachineOutput#creation_date #creation_date} => Time
|
779
875
|
# * {Types::DescribeStateMachineOutput#logging_configuration #logging_configuration} => Types::LoggingConfiguration
|
780
876
|
# * {Types::DescribeStateMachineOutput#tracing_configuration #tracing_configuration} => Types::TracingConfiguration
|
877
|
+
# * {Types::DescribeStateMachineOutput#label #label} => String
|
781
878
|
#
|
782
879
|
# @example Request syntax with placeholder values
|
783
880
|
#
|
@@ -799,6 +896,7 @@ module Aws::States
|
|
799
896
|
# resp.logging_configuration.destinations #=> Array
|
800
897
|
# resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
|
801
898
|
# resp.tracing_configuration.enabled #=> Boolean
|
899
|
+
# resp.label #=> String
|
802
900
|
#
|
803
901
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachine AWS API Documentation
|
804
902
|
#
|
@@ -809,7 +907,11 @@ module Aws::States
|
|
809
907
|
req.send_request(options)
|
810
908
|
end
|
811
909
|
|
812
|
-
#
|
910
|
+
# Provides information about a state machine's definition, its
|
911
|
+
# execution role ARN, and configuration. If an execution was dispatched
|
912
|
+
# by a Map Run, the Map Run is returned in the response. Additionally,
|
913
|
+
# the state machine returned will be the state machine associated with
|
914
|
+
# the Map Run.
|
813
915
|
#
|
814
916
|
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
815
917
|
# and may not reflect very recent updates and changes.
|
@@ -831,6 +933,8 @@ module Aws::States
|
|
831
933
|
# * {Types::DescribeStateMachineForExecutionOutput#update_date #update_date} => Time
|
832
934
|
# * {Types::DescribeStateMachineForExecutionOutput#logging_configuration #logging_configuration} => Types::LoggingConfiguration
|
833
935
|
# * {Types::DescribeStateMachineForExecutionOutput#tracing_configuration #tracing_configuration} => Types::TracingConfiguration
|
936
|
+
# * {Types::DescribeStateMachineForExecutionOutput#map_run_arn #map_run_arn} => String
|
937
|
+
# * {Types::DescribeStateMachineForExecutionOutput#label #label} => String
|
834
938
|
#
|
835
939
|
# @example Request syntax with placeholder values
|
836
940
|
#
|
@@ -850,6 +954,8 @@ module Aws::States
|
|
850
954
|
# resp.logging_configuration.destinations #=> Array
|
851
955
|
# resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
|
852
956
|
# resp.tracing_configuration.enabled #=> Boolean
|
957
|
+
# resp.map_run_arn #=> String
|
958
|
+
# resp.label #=> String
|
853
959
|
#
|
854
960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachineForExecution AWS API Documentation
|
855
961
|
#
|
@@ -869,6 +975,10 @@ module Aws::States
|
|
869
975
|
# task is available within 60 seconds, the poll returns a `taskToken`
|
870
976
|
# with a null string.
|
871
977
|
#
|
978
|
+
# <note markdown="1"> This API action isn't logged in CloudTrail.
|
979
|
+
#
|
980
|
+
# </note>
|
981
|
+
#
|
872
982
|
# Workers should set their client side socket timeout to at least 65
|
873
983
|
# seconds (5 seconds higher than the maximum time the service may hold
|
874
984
|
# the poll request).
|
@@ -977,7 +1087,7 @@ module Aws::States
|
|
977
1087
|
#
|
978
1088
|
# resp.events #=> Array
|
979
1089
|
# resp.events[0].timestamp #=> Time
|
980
|
-
# resp.events[0].type #=> String, one of "ActivityFailed", "ActivityScheduled", "ActivityScheduleFailed", "ActivityStarted", "ActivitySucceeded", "ActivityTimedOut", "ChoiceStateEntered", "ChoiceStateExited", "ExecutionAborted", "ExecutionFailed", "ExecutionStarted", "ExecutionSucceeded", "ExecutionTimedOut", "FailStateEntered", "LambdaFunctionFailed", "LambdaFunctionScheduled", "LambdaFunctionScheduleFailed", "LambdaFunctionStarted", "LambdaFunctionStartFailed", "LambdaFunctionSucceeded", "LambdaFunctionTimedOut", "MapIterationAborted", "MapIterationFailed", "MapIterationStarted", "MapIterationSucceeded", "MapStateAborted", "MapStateEntered", "MapStateExited", "MapStateFailed", "MapStateStarted", "MapStateSucceeded", "ParallelStateAborted", "ParallelStateEntered", "ParallelStateExited", "ParallelStateFailed", "ParallelStateStarted", "ParallelStateSucceeded", "PassStateEntered", "PassStateExited", "SucceedStateEntered", "SucceedStateExited", "TaskFailed", "TaskScheduled", "TaskStarted", "TaskStartFailed", "TaskStateAborted", "TaskStateEntered", "TaskStateExited", "TaskSubmitFailed", "TaskSubmitted", "TaskSucceeded", "TaskTimedOut", "WaitStateAborted", "WaitStateEntered", "WaitStateExited"
|
1090
|
+
# resp.events[0].type #=> String, one of "ActivityFailed", "ActivityScheduled", "ActivityScheduleFailed", "ActivityStarted", "ActivitySucceeded", "ActivityTimedOut", "ChoiceStateEntered", "ChoiceStateExited", "ExecutionAborted", "ExecutionFailed", "ExecutionStarted", "ExecutionSucceeded", "ExecutionTimedOut", "FailStateEntered", "LambdaFunctionFailed", "LambdaFunctionScheduled", "LambdaFunctionScheduleFailed", "LambdaFunctionStarted", "LambdaFunctionStartFailed", "LambdaFunctionSucceeded", "LambdaFunctionTimedOut", "MapIterationAborted", "MapIterationFailed", "MapIterationStarted", "MapIterationSucceeded", "MapStateAborted", "MapStateEntered", "MapStateExited", "MapStateFailed", "MapStateStarted", "MapStateSucceeded", "ParallelStateAborted", "ParallelStateEntered", "ParallelStateExited", "ParallelStateFailed", "ParallelStateStarted", "ParallelStateSucceeded", "PassStateEntered", "PassStateExited", "SucceedStateEntered", "SucceedStateExited", "TaskFailed", "TaskScheduled", "TaskStarted", "TaskStartFailed", "TaskStateAborted", "TaskStateEntered", "TaskStateExited", "TaskSubmitFailed", "TaskSubmitted", "TaskSucceeded", "TaskTimedOut", "WaitStateAborted", "WaitStateEntered", "WaitStateExited", "MapRunAborted", "MapRunFailed", "MapRunStarted", "MapRunSucceeded"
|
981
1091
|
# resp.events[0].id #=> Integer
|
982
1092
|
# resp.events[0].previous_event_id #=> Integer
|
983
1093
|
# resp.events[0].activity_failed_event_details.error #=> String
|
@@ -1004,6 +1114,7 @@ module Aws::States
|
|
1004
1114
|
# resp.events[0].task_scheduled_event_details.parameters #=> String
|
1005
1115
|
# resp.events[0].task_scheduled_event_details.timeout_in_seconds #=> Integer
|
1006
1116
|
# resp.events[0].task_scheduled_event_details.heartbeat_in_seconds #=> Integer
|
1117
|
+
# resp.events[0].task_scheduled_event_details.task_credentials.role_arn #=> String
|
1007
1118
|
# resp.events[0].task_start_failed_event_details.resource_type #=> String
|
1008
1119
|
# resp.events[0].task_start_failed_event_details.resource #=> String
|
1009
1120
|
# resp.events[0].task_start_failed_event_details.error #=> String
|
@@ -1054,6 +1165,7 @@ module Aws::States
|
|
1054
1165
|
# resp.events[0].lambda_function_scheduled_event_details.input #=> String
|
1055
1166
|
# resp.events[0].lambda_function_scheduled_event_details.input_details.truncated #=> Boolean
|
1056
1167
|
# resp.events[0].lambda_function_scheduled_event_details.timeout_in_seconds #=> Integer
|
1168
|
+
# resp.events[0].lambda_function_scheduled_event_details.task_credentials.role_arn #=> String
|
1057
1169
|
# resp.events[0].lambda_function_start_failed_event_details.error #=> String
|
1058
1170
|
# resp.events[0].lambda_function_start_failed_event_details.cause #=> String
|
1059
1171
|
# resp.events[0].lambda_function_succeeded_event_details.output #=> String
|
@@ -1066,6 +1178,9 @@ module Aws::States
|
|
1066
1178
|
# resp.events[0].state_exited_event_details.name #=> String
|
1067
1179
|
# resp.events[0].state_exited_event_details.output #=> String
|
1068
1180
|
# resp.events[0].state_exited_event_details.output_details.truncated #=> Boolean
|
1181
|
+
# resp.events[0].map_run_started_event_details.map_run_arn #=> String
|
1182
|
+
# resp.events[0].map_run_failed_event_details.error #=> String
|
1183
|
+
# resp.events[0].map_run_failed_event_details.cause #=> String
|
1069
1184
|
# resp.next_token #=> String
|
1070
1185
|
#
|
1071
1186
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistory AWS API Documentation
|
@@ -1138,9 +1253,12 @@ module Aws::States
|
|
1138
1253
|
req.send_request(options)
|
1139
1254
|
end
|
1140
1255
|
|
1141
|
-
# Lists
|
1142
|
-
#
|
1143
|
-
#
|
1256
|
+
# Lists all executions of a state machine or a Map Run. You can list all
|
1257
|
+
# executions related to a state machine by specifying a state machine
|
1258
|
+
# Amazon Resource Name (ARN), or those related to a Map Run by
|
1259
|
+
# specifying a Map Run ARN.
|
1260
|
+
#
|
1261
|
+
# Results are sorted by time, with the most recent execution first.
|
1144
1262
|
#
|
1145
1263
|
# If `nextToken` is returned, there are more results available. The
|
1146
1264
|
# value of `nextToken` is a unique pagination token for each page. Make
|
@@ -1156,10 +1274,13 @@ module Aws::States
|
|
1156
1274
|
#
|
1157
1275
|
# This API action is not supported by `EXPRESS` state machines.
|
1158
1276
|
#
|
1159
|
-
# @option params [
|
1277
|
+
# @option params [String] :state_machine_arn
|
1160
1278
|
# The Amazon Resource Name (ARN) of the state machine whose executions
|
1161
1279
|
# is listed.
|
1162
1280
|
#
|
1281
|
+
# You can specify either a `mapRunArn` or a `stateMachineArn`, but not
|
1282
|
+
# both.
|
1283
|
+
#
|
1163
1284
|
# @option params [String] :status_filter
|
1164
1285
|
# If specified, only list the executions whose current execution status
|
1165
1286
|
# matches the given filter.
|
@@ -1180,6 +1301,20 @@ module Aws::States
|
|
1180
1301
|
# after 24 hours. Using an expired pagination token will return an *HTTP
|
1181
1302
|
# 400 InvalidToken* error.
|
1182
1303
|
#
|
1304
|
+
# @option params [String] :map_run_arn
|
1305
|
+
# The Amazon Resource Name (ARN) of the Map Run that started the child
|
1306
|
+
# workflow executions. If the `mapRunArn` field is specified, a list of
|
1307
|
+
# all of the child workflow executions started by a Map Run is returned.
|
1308
|
+
# For more information, see [Examining Map Run][1] in the *Step
|
1309
|
+
# Functions Developer Guide*.
|
1310
|
+
#
|
1311
|
+
# You can specify either a `mapRunArn` or a `stateMachineArn`, but not
|
1312
|
+
# both.
|
1313
|
+
#
|
1314
|
+
#
|
1315
|
+
#
|
1316
|
+
# [1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html
|
1317
|
+
#
|
1183
1318
|
# @return [Types::ListExecutionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1184
1319
|
#
|
1185
1320
|
# * {Types::ListExecutionsOutput#executions #executions} => Array<Types::ExecutionListItem>
|
@@ -1190,10 +1325,11 @@ module Aws::States
|
|
1190
1325
|
# @example Request syntax with placeholder values
|
1191
1326
|
#
|
1192
1327
|
# resp = client.list_executions({
|
1193
|
-
# state_machine_arn: "Arn",
|
1328
|
+
# state_machine_arn: "Arn",
|
1194
1329
|
# status_filter: "RUNNING", # accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED
|
1195
1330
|
# max_results: 1,
|
1196
1331
|
# next_token: "ListExecutionsPageToken",
|
1332
|
+
# map_run_arn: "LongArn",
|
1197
1333
|
# })
|
1198
1334
|
#
|
1199
1335
|
# @example Response structure
|
@@ -1205,6 +1341,8 @@ module Aws::States
|
|
1205
1341
|
# resp.executions[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED"
|
1206
1342
|
# resp.executions[0].start_date #=> Time
|
1207
1343
|
# resp.executions[0].stop_date #=> Time
|
1344
|
+
# resp.executions[0].map_run_arn #=> String
|
1345
|
+
# resp.executions[0].item_count #=> Integer
|
1208
1346
|
# resp.next_token #=> String
|
1209
1347
|
#
|
1210
1348
|
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutions AWS API Documentation
|
@@ -1216,6 +1354,64 @@ module Aws::States
|
|
1216
1354
|
req.send_request(options)
|
1217
1355
|
end
|
1218
1356
|
|
1357
|
+
# Lists all Map Runs that were started by a given state machine
|
1358
|
+
# execution. Use this API action to obtain Map Run ARNs, and then call
|
1359
|
+
# `DescribeMapRun` to obtain more information, if needed.
|
1360
|
+
#
|
1361
|
+
# @option params [required, String] :execution_arn
|
1362
|
+
# The Amazon Resource Name (ARN) of the execution for which the Map Runs
|
1363
|
+
# must be listed.
|
1364
|
+
#
|
1365
|
+
# @option params [Integer] :max_results
|
1366
|
+
# The maximum number of results that are returned per call. You can use
|
1367
|
+
# `nextToken` to obtain further pages of results. The default is 100 and
|
1368
|
+
# the maximum allowed page size is 1000. A value of 0 uses the default.
|
1369
|
+
#
|
1370
|
+
# This is only an upper limit. The actual number of results returned per
|
1371
|
+
# call might be fewer than the specified maximum.
|
1372
|
+
#
|
1373
|
+
# @option params [String] :next_token
|
1374
|
+
# If `nextToken` is returned, there are more results available. The
|
1375
|
+
# value of `nextToken` is a unique pagination token for each page. Make
|
1376
|
+
# the call again using the returned token to retrieve the next page.
|
1377
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1378
|
+
# after 24 hours. Using an expired pagination token will return an *HTTP
|
1379
|
+
# 400 InvalidToken* error.
|
1380
|
+
#
|
1381
|
+
# @return [Types::ListMapRunsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1382
|
+
#
|
1383
|
+
# * {Types::ListMapRunsOutput#map_runs #map_runs} => Array<Types::MapRunListItem>
|
1384
|
+
# * {Types::ListMapRunsOutput#next_token #next_token} => String
|
1385
|
+
#
|
1386
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1387
|
+
#
|
1388
|
+
# @example Request syntax with placeholder values
|
1389
|
+
#
|
1390
|
+
# resp = client.list_map_runs({
|
1391
|
+
# execution_arn: "Arn", # required
|
1392
|
+
# max_results: 1,
|
1393
|
+
# next_token: "PageToken",
|
1394
|
+
# })
|
1395
|
+
#
|
1396
|
+
# @example Response structure
|
1397
|
+
#
|
1398
|
+
# resp.map_runs #=> Array
|
1399
|
+
# resp.map_runs[0].execution_arn #=> String
|
1400
|
+
# resp.map_runs[0].map_run_arn #=> String
|
1401
|
+
# resp.map_runs[0].state_machine_arn #=> String
|
1402
|
+
# resp.map_runs[0].start_date #=> Time
|
1403
|
+
# resp.map_runs[0].stop_date #=> Time
|
1404
|
+
# resp.next_token #=> String
|
1405
|
+
#
|
1406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListMapRuns AWS API Documentation
|
1407
|
+
#
|
1408
|
+
# @overload list_map_runs(params = {})
|
1409
|
+
# @param [Hash] params ({})
|
1410
|
+
def list_map_runs(params = {}, options = {})
|
1411
|
+
req = build_request(:list_map_runs, params)
|
1412
|
+
req.send_request(options)
|
1413
|
+
end
|
1414
|
+
|
1219
1415
|
# Lists the existing state machines.
|
1220
1416
|
#
|
1221
1417
|
# If `nextToken` is returned, there are more results available. The
|
@@ -1444,13 +1640,25 @@ module Aws::States
|
|
1444
1640
|
req.send_request(options)
|
1445
1641
|
end
|
1446
1642
|
|
1447
|
-
# Starts a state machine execution.
|
1448
|
-
#
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
#
|
1452
|
-
#
|
1453
|
-
#
|
1643
|
+
# Starts a state machine execution. If the given state machine Amazon
|
1644
|
+
# Resource Name (ARN) is a qualified state machine ARN, it will fail
|
1645
|
+
# with ValidationException.
|
1646
|
+
#
|
1647
|
+
# A qualified state machine ARN refers to a *Distributed Map state*
|
1648
|
+
# defined within a state machine. For example, the qualified state
|
1649
|
+
# machine ARN
|
1650
|
+
# `arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel`
|
1651
|
+
# refers to a *Distributed Map state* with a label `mapStateLabel` in
|
1652
|
+
# the state machine named `stateMachineName`.
|
1653
|
+
#
|
1654
|
+
# <note markdown="1"> `StartExecution` is idempotent for `STANDARD` workflows. For a
|
1655
|
+
# `STANDARD` workflow, if `StartExecution` is called with the same name
|
1656
|
+
# and input as a running execution, the call will succeed and return the
|
1657
|
+
# same response as the original request. If the execution is closed or
|
1658
|
+
# if the input is different, it will return a `400
|
1659
|
+
# ExecutionAlreadyExists` error. Names can be reused after 90 days.
|
1660
|
+
#
|
1661
|
+
# `StartExecution` is not idempotent for `EXPRESS` workflows.
|
1454
1662
|
#
|
1455
1663
|
# </note>
|
1456
1664
|
#
|
@@ -1458,10 +1666,10 @@ module Aws::States
|
|
1458
1666
|
# The Amazon Resource Name (ARN) of the state machine to execute.
|
1459
1667
|
#
|
1460
1668
|
# @option params [String] :name
|
1461
|
-
# The name of the execution. This name must be unique for your
|
1462
|
-
# account, region, and state machine for 90 days. For more
|
1463
|
-
# see [ Limits Related to State Machine Executions][1] in
|
1464
|
-
# Functions Developer Guide*.
|
1669
|
+
# The name of the execution. This name must be unique for your Amazon
|
1670
|
+
# Web Services account, region, and state machine for 90 days. For more
|
1671
|
+
# information, see [ Limits Related to State Machine Executions][1] in
|
1672
|
+
# the *Step Functions Developer Guide*.
|
1465
1673
|
#
|
1466
1674
|
# A name must *not* contain:
|
1467
1675
|
#
|
@@ -1497,8 +1705,8 @@ module Aws::States
|
|
1497
1705
|
# bytes in UTF-8 encoding.
|
1498
1706
|
#
|
1499
1707
|
# @option params [String] :trace_header
|
1500
|
-
# Passes the
|
1501
|
-
#
|
1708
|
+
# Passes the X-Ray trace header. The trace header can also be passed in
|
1709
|
+
# the request payload.
|
1502
1710
|
#
|
1503
1711
|
# @return [Types::StartExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1504
1712
|
#
|
@@ -1529,6 +1737,19 @@ module Aws::States
|
|
1529
1737
|
end
|
1530
1738
|
|
1531
1739
|
# Starts a Synchronous Express state machine execution.
|
1740
|
+
# `StartSyncExecution` is not available for `STANDARD` workflows.
|
1741
|
+
#
|
1742
|
+
# <note markdown="1"> `StartSyncExecution` will return a `200 OK` response, even if your
|
1743
|
+
# execution fails, because the status code in the API response doesn't
|
1744
|
+
# reflect function errors. Error codes are reserved for errors that
|
1745
|
+
# prevent your execution from running, such as permissions errors, limit
|
1746
|
+
# errors, or issues with your state machine code and configuration.
|
1747
|
+
#
|
1748
|
+
# </note>
|
1749
|
+
#
|
1750
|
+
# <note markdown="1"> This API action isn't logged in CloudTrail.
|
1751
|
+
#
|
1752
|
+
# </note>
|
1532
1753
|
#
|
1533
1754
|
# @option params [required, String] :state_machine_arn
|
1534
1755
|
# The Amazon Resource Name (ARN) of the state machine to execute.
|
@@ -1551,8 +1772,8 @@ module Aws::States
|
|
1551
1772
|
# bytes in UTF-8 encoding.
|
1552
1773
|
#
|
1553
1774
|
# @option params [String] :trace_header
|
1554
|
-
# Passes the
|
1555
|
-
#
|
1775
|
+
# Passes the X-Ray trace header. The trace header can also be passed in
|
1776
|
+
# the request payload.
|
1556
1777
|
#
|
1557
1778
|
# @return [Types::StartSyncExecutionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1558
1779
|
#
|
@@ -1648,8 +1869,8 @@ module Aws::States
|
|
1648
1869
|
# Add a tag to a Step Functions resource.
|
1649
1870
|
#
|
1650
1871
|
# An array of key-value pairs. For more information, see [Using Cost
|
1651
|
-
# Allocation Tags][1] in the *
|
1652
|
-
# Guide*, and [Controlling Access Using IAM Tags][2].
|
1872
|
+
# Allocation Tags][1] in the *Amazon Web Services Billing and Cost
|
1873
|
+
# Management User Guide*, and [Controlling Access Using IAM Tags][2].
|
1653
1874
|
#
|
1654
1875
|
# Tags may only contain Unicode letters, digits, white space, or these
|
1655
1876
|
# symbols: `_ . : / = + - @`.
|
@@ -1719,12 +1940,58 @@ module Aws::States
|
|
1719
1940
|
req.send_request(options)
|
1720
1941
|
end
|
1721
1942
|
|
1943
|
+
# Updates an in-progress Map Run's configuration to include changes to
|
1944
|
+
# the settings that control maximum concurrency and Map Run failure.
|
1945
|
+
#
|
1946
|
+
# @option params [required, String] :map_run_arn
|
1947
|
+
# The Amazon Resource Name (ARN) of a Map Run.
|
1948
|
+
#
|
1949
|
+
# @option params [Integer] :max_concurrency
|
1950
|
+
# The maximum number of child workflow executions that can be specified
|
1951
|
+
# to run in parallel for the Map Run at the same time.
|
1952
|
+
#
|
1953
|
+
# @option params [Float] :tolerated_failure_percentage
|
1954
|
+
# The maximum percentage of failed items before the Map Run fails.
|
1955
|
+
#
|
1956
|
+
# @option params [Integer] :tolerated_failure_count
|
1957
|
+
# The maximum number of failed items before the Map Run fails.
|
1958
|
+
#
|
1959
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1960
|
+
#
|
1961
|
+
# @example Request syntax with placeholder values
|
1962
|
+
#
|
1963
|
+
# resp = client.update_map_run({
|
1964
|
+
# map_run_arn: "LongArn", # required
|
1965
|
+
# max_concurrency: 1,
|
1966
|
+
# tolerated_failure_percentage: 1.0,
|
1967
|
+
# tolerated_failure_count: 1,
|
1968
|
+
# })
|
1969
|
+
#
|
1970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/UpdateMapRun AWS API Documentation
|
1971
|
+
#
|
1972
|
+
# @overload update_map_run(params = {})
|
1973
|
+
# @param [Hash] params ({})
|
1974
|
+
def update_map_run(params = {}, options = {})
|
1975
|
+
req = build_request(:update_map_run, params)
|
1976
|
+
req.send_request(options)
|
1977
|
+
end
|
1978
|
+
|
1722
1979
|
# Updates an existing state machine by modifying its `definition`,
|
1723
1980
|
# `roleArn`, or `loggingConfiguration`. Running executions will continue
|
1724
1981
|
# to use the previous `definition` and `roleArn`. You must include at
|
1725
1982
|
# least one of `definition` or `roleArn` or you will receive a
|
1726
1983
|
# `MissingRequiredParameter` error.
|
1727
1984
|
#
|
1985
|
+
# If the given state machine Amazon Resource Name (ARN) is a qualified
|
1986
|
+
# state machine ARN, it will fail with ValidationException.
|
1987
|
+
#
|
1988
|
+
# A qualified state machine ARN refers to a *Distributed Map state*
|
1989
|
+
# defined within a state machine. For example, the qualified state
|
1990
|
+
# machine ARN
|
1991
|
+
# `arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel`
|
1992
|
+
# refers to a *Distributed Map state* with a label `mapStateLabel` in
|
1993
|
+
# the state machine named `stateMachineName`.
|
1994
|
+
#
|
1728
1995
|
# <note markdown="1"> All `StartExecution` calls within a few seconds will use the updated
|
1729
1996
|
# `definition` and `roleArn`. Executions started immediately after
|
1730
1997
|
# calling `UpdateStateMachine` may use the previous state machine
|
@@ -1751,7 +2018,7 @@ module Aws::States
|
|
1751
2018
|
# options.
|
1752
2019
|
#
|
1753
2020
|
# @option params [Types::TracingConfiguration] :tracing_configuration
|
1754
|
-
# Selects whether
|
2021
|
+
# Selects whether X-Ray tracing is enabled.
|
1755
2022
|
#
|
1756
2023
|
# @return [Types::UpdateStateMachineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1757
2024
|
#
|
@@ -1805,7 +2072,7 @@ module Aws::States
|
|
1805
2072
|
params: params,
|
1806
2073
|
config: config)
|
1807
2074
|
context[:gem_name] = 'aws-sdk-states'
|
1808
|
-
context[:gem_version] = '1.
|
2075
|
+
context[:gem_version] = '1.51.0'
|
1809
2076
|
Seahorse::Client::Request.new(handlers, context)
|
1810
2077
|
end
|
1811
2078
|
|