Skip to content

(stepfunctions): explain inputPath/outputPath/parameters/resultselector in main module README #19996

@rix0rrr

Description

@rix0rrr

Describe the issue

Right now the intricacies of those fields are explained in the stepfunctions-tasks module, whereas this content would probably be better off in the main README, underneath the 'accessing JSON data' section, including a list of which states accept these parameters.

This section also needs to clearly explain when you need to use JsonPath.stringAt('$.bla'), and when you just pass the string '$.bla'.

We then reference it from the -tasks module, because it's still important information there.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks-readme.html

Metadata

Metadata

Assignees

Labels

documentationThis is a problem with documentation.effort/smallSmall work item – less than a day of effortp1

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions