aws / aws/aws-step-functions-data-science-sdk-python
Which are the states including the common SFN states for which <state>.output () can be applied ?
- Dominant language
- Python
- Stars
- 299
- Forks
- 84
- PR merge metrics
- No merged PRs in 30d
Description
This is a separate issue created from the discussion by @nsankar addressed to @wong-a from the issue id #31
The key point is which are the common SFN and AWS specific service states where we can use the form `.output()` in this SDK. Please include it in the documentation.
More details and an example state using output() is as under.,
(1) Which are the states including the common SFN states for which state output () is applicable **or** can be used? This is not in the document unless we see an example, for instance, as an example output () is applicable to the processing step which can be then used in a choice state as cited below:
```
processing_step = ProcessingStep(
"SageMaker processing step",
processor=script_processor,
job_name=execution_input["PreprocessingJobName"], ## placeholder per schema above. Later in workflow execute() below pass the uuid of jobname
inputs=inputs,
outputs=outputs,
# container_arguments=["--train-test-split-ratio", "0.2"],
container_entrypoint=["python3", "/opt/ml/processing/input/code/myprogram.py"],
)
choice_state1.add_choice(ChoiceRule.StringEquals(processing_step**.output()**["ProcessingJobStatus"], "Completed"), lambda_state1)
```
Contributor guide
Research direction
The issue names ProcessingStep, ChoiceRule.StringEquals, and state output(), but it does not identify a documentation file or test. Start by locating the SDK documentation for workflow states and the ProcessingStep example, then determine which common and AWS-specific states support output(). Done means the documentation lists the applicable states and includes a working example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, python
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100