Map¶
-
class
aws_cdk.aws_stepfunctions.
Map
(scope, id, *, comment=None, input_path=None, items_path=None, max_concurrency=None, output_path=None, parameters=None, result_path=None)¶ Bases:
aws_cdk.aws_stepfunctions.State
Define a Map state in the state machine.
A
Map
state can be used to run a set of steps for each element of an input array. A Map state will execute the same steps for multiple entries of an array in the state input.While the Parallel state executes multiple branches of steps using the same input, a Map state will execute the same steps for multiple entries of an array in the state input.
- See
https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html
- Parameters
scope (
Construct
) –id (
str
) –comment (
Optional
[str
]) – An optional description for this state. Default: No commentinput_path (
Optional
[str
]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: $items_path (
Optional
[str
]) – JSONPath expression to select the array to iterate over. Default: $max_concurrency (
Union
[int
,float
,None
]) – MaxConcurrency. An upper bound on the number of iterations you want running at once. Default: - full concurrencyoutput_path (
Optional
[str
]) – JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: $parameters (
Optional
[Mapping
[str
,Any
]]) – The JSON that you want to override your default iteration input. Default: $result_path (
Optional
[str
]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output. Default: $
Methods
-
add_catch
(handler, *, errors=None, result_path=None)¶ Add a recovery handler for this state.
When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.
- Parameters
handler (
IChainable
) –errors (
Optional
[List
[str
]]) – Errors to recover from by going to the given state. A list of error strings to retry, which can be either predefined errors (for example Errors.NoChoiceMatched) or a self-defined error. Default: All errorsresult_path (
Optional
[str
]) – JSONPath expression to indicate where to inject the error data. May also be the special value DISCARD, which will cause the error data to be discarded. Default: $
- Return type
-
add_prefix
(x)¶ Add a prefix to the stateId of this state.
- Parameters
x (
str
) –- Return type
None
-
add_retry
(*, backoff_rate=None, errors=None, interval=None, max_attempts=None)¶ Add retry configuration for this state.
This controls if and how the execution will be retried if a particular error occurs.
- Parameters
backoff_rate (
Union
[int
,float
,None
]) – Multiplication for how much longer the wait interval gets on every retry. Default: 2errors (
Optional
[List
[str
]]) – Errors to retry. A list of error strings to retry, which can be either predefined errors (for example Errors.NoChoiceMatched) or a self-defined error. Default: All errorsinterval (
Optional
[Duration
]) – How many seconds to wait initially before retrying. Default: Duration.seconds(1)max_attempts (
Union
[int
,float
,None
]) – How many times to retry this particular error. May be 0 to disable retry for specific errors (in case you have a catch-all retry policy). Default: 3
- Return type
-
bind_to_graph
(graph)¶ Register this state as part of the given graph.
Don’t call this. It will be called automatically when you work with states normally.
- Parameters
graph (
StateGraph
) –- Return type
None
-
iterator
(iterator)¶ Define iterator state machine in Map.
- Parameters
iterator (
IChainable
) –- Return type
-
next
(next)¶ Continue normal execution with the given state.
- Parameters
next (
IChainable
) –- Return type
-
to_state_json
()¶ Return the Amazon States Language object for this state.
- Return type
Mapping
[Any
,Any
]
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
id
¶ Descriptive identifier for this chainable.
- Return type
str
-
node
¶ The construct tree node associated with this construct.
- Return type
-
state_id
¶ Tokenized string that evaluates to the state’s ID.
- Return type
str
Static Methods
-
classmethod
filter_nextables
(states)¶ Return only the states that allow chaining from an array of states.
-
classmethod
find_reachable_end_states
(start, *, include_error_handlers=None)¶ Find the set of end states states reachable through transitions from the given start state.
-
classmethod
find_reachable_states
(start, *, include_error_handlers=None)¶ Find the set of states reachable through transitions from the given start state.
This does not retrieve states from within sub-graphs, such as states within a Parallel state’s branch.
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
prefix_states
(root, prefix)¶ Add a prefix to the stateId of all States found in a construct tree.
- Parameters
root (
IConstruct
) –prefix (
str
) –
- Return type
None