Skip to content

Commit

Permalink
docs(stepfunctions-tasks): update the table of contents and headers i…
Browse files Browse the repository at this point in the history
…n README (#29545)

### Reason for this change

I didn't know which APIs are implemented at a glance because some headers are omitted in the README.

### Description of changes

I added headers for all APIs and updated the table of contents to show all headers.

### Description of how you validated changes

I checked the preview of the markdown format.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https:/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https:/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
ymhiroki authored Mar 22, 2024
1 parent 56a4122 commit 3091c8f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md
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:/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:/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

0 comments on commit 3091c8f

Please sign in to comment.