Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(stepfunctions-tasks): update the table of contents and headers in README #29545

Merged
merged 3 commits into from
Mar 22, 2024
Merged

docs(stepfunctions-tasks): update the table of contents and headers in README #29545

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
19957c3
update README for aws-stepfunctions-tasks
ymhiroki Mar 20, 2024
b8815bc
Merge branch 'main' into yhirokiy/update-documentation-for-sfn-tasks
ymhiroki Mar 20, 2024
00ddaea
Merge branch 'main' into yhirokiy/update-documentation-for-sfn-tasks
mergify[bot] Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,12 @@ This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aw
- [EventBridge](#eventbridge)
- [Put Events](#put-events)
- [Glue](#glue)
- [Start Job Run](#start-job-run)
- [Start Crawler Run](#startcrawlerrun)
- [Glue DataBrew](#glue-databrew)
- [Start Job Run](#start-job-run-1)
- [Lambda](#lambda)
- [Invoke](#invoke)
- [SageMaker](#sagemaker)
- [Create Training Job](#create-training-job)
- [Create Transform Job](#create-transform-job)
Expand All @@ -71,10 +75,12 @@ This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aw
- [Create Model](#create-model)
- [Update Endpoint](#update-endpoint)
- [SNS](#sns)
- [Publish](#publish)
- [Step Functions](#step-functions)
- [Start Execution](#start-execution)
- [Invoke Activity](#invoke-activity)
- [SQS](#sqs)
- [Send Message](#send-message)

## Paths

Expand Down Expand Up @@ -1119,6 +1125,8 @@ new tasks.GlueStartCrawlerRun(this, 'Task2', {

Step Functions supports [AWS Glue DataBrew](https://docs.aws.amazon.com/step-functions/latest/dg/connect-databrew.html) through the service integration pattern.

### Start Job Run

You can call the [`StartJobRun`](https://docs.aws.amazon.com/databrew/latest/dg/API_StartJobRun.html) API from a `Task` state.

```ts
Expand All @@ -1129,6 +1137,10 @@ new tasks.GlueDataBrewStartJobRun(this, 'Task', {

## Lambda

Step Functions supports [AWS Lambda](https://docs.aws.amazon.com/step-functions/latest/dg/connect-lambda.html) through the service integration pattern.

### Invoke

[Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html) a Lambda function.

You can specify the input to your Lambda function through the `payload` attribute.
Expand Down Expand Up @@ -1363,6 +1375,8 @@ new tasks.SageMakerUpdateEndpoint(this, 'SagemakerEndpoint', {

Step Functions supports [Amazon SNS](https://docs.aws.amazon.com/step-functions/latest/dg/connect-sns.html) through the service integration pattern.

### Publish

You can call the [`Publish`](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) API from a `Task` state to publish to an SNS topic.

```ts
Expand Down Expand Up @@ -1404,6 +1418,8 @@ const task2 = new tasks.SnsPublish(this, 'Publish2', {

## Step Functions

Step Functions supports [AWS Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/connect-stepfunctions.html) through the service integration pattern.

### Start Execution

You can manage [AWS Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/connect-stepfunctions.html) executions.
Expand Down Expand Up @@ -1499,6 +1515,8 @@ new tasks.StepFunctionsInvokeActivity(this, 'Submit Job', {

Step Functions supports [Amazon SQS](https://docs.aws.amazon.com/step-functions/latest/dg/connect-sqs.html)

### Send Message

You can call the [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API from a `Task` state
to send a message to an SQS queue.

Expand Down